listInvites

GET

/invites

const url = 'http://localhost:8080/api/v1/invites';
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/invites \
  --cookie hs_session=<hs_session>

Authorizations

cookieAuth
bearerAuth

Responses

200

Active invites.

application/json

object

items

required

Array<object>

object

required

string

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

role

required

string

Allowed values: member viewer

code

Only on create.

string

url

Only on create.

string format: uri

qrPayload

Only on create.

string

expiresAt

required

string format: date-time

maxUses

required

integer

uses

required

integer

createdAt

required

string format: date-time

Examples

seed

Derived from fixtures/seed.json.

{
  "items": [
    {
      "createdAt": "2026-10-16T09:00:00.000Z",
      "expiresAt": "2026-10-24T09:00:00.000Z",
      "id": "inv_01j9a1b2c3d4e5f6g7h8j9k00q",
      "maxUses": 1,
      "role": "viewer",
      "uses": 0
    }
  ]
}