listMembers

GET

/members

const url = 'http://localhost:8080/api/v1/members';
const options = {method: 'GET', headers: {cookie: 'hs_session=<hs_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/members \
  --cookie hs_session=<hs_session>

Authorizations

cookieAuth
bearerAuth

Responses

200

All members.

application/json

object

items

required

Array<object>

object

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

username

required

string

displayName

required

string

role

required

string

Allowed values: owner member viewer

locale

One of:

string
null

string

Allowed values: en zh-Hans th

theme

required

string

Allowed values: system light dark

textScale

required

number

>= 1 <= 1.6

reducedMotion

required

boolean

shareVisits

boolean

showAiSummaries

boolean

avatar

One of:

object
null

object

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

url

required

Signed URL, valid 24 h.

string

thumbUrl

string

cardUrl

string

posterUrl

string

mime

required

string

width

integer

height

integer

durationMs

integer

blurhash

string

alt

string

createdAt

required

string format: date-time

lastSeenAt

One of:

string
null

string format: date-time

Examples

seed

Derived from fixtures/seed.json.

{
  "items": [
    {
      "avatar": null,
      "createdAt": "2026-09-17T09:00:00.000Z",
      "displayName": "Mali",
      "id": "mem_01j9kt0d8rwgmhnmxkmv0frnr0",
      "lastSeenAt": null,
      "locale": "en",
      "reducedMotion": false,
      "role": "owner",
      "shareVisits": true,
      "showAiSummaries": true,
      "textScale": 1,
      "theme": "system",
      "username": "mali"
    },
    {
      "avatar": null,
      "createdAt": "2026-09-27T09:00:00.000Z",
      "displayName": "สมชาย",
      "id": "mem_01j9gnwgka8c0bbep1kenhhwr9",
      "lastSeenAt": null,
      "locale": "th",
      "reducedMotion": false,
      "role": "viewer",
      "shareVisits": true,
      "showAiSummaries": true,
      "textScale": 1.3,
      "theme": "system",
      "username": "somchai"
    },
    {
      "avatar": null,
      "createdAt": "2026-10-07T09:00:00.000Z",
      "displayName": "Ben",
      "id": "mem_01j9706wfq8em7agb270vat3vp",
      "lastSeenAt": null,
      "locale": "zh-Hans",
      "reducedMotion": false,
      "role": "member",
      "shareVisits": false,
      "showAiSummaries": true,
      "textScale": 1,
      "theme": "system",
      "username": "ben"
    }
  ]
}