createInvite

POST

/invites

curl --request POST \
  --url http://localhost:8080/api/v1/invites \
  --header 'Content-Type: application/json' \
  --cookie hs_session=<hs_session> \
  --data '{ "role": "member", "expiresInDays": 7, "maxUses": 1 }'

• Your Homestead (default port; replace with your address)

Members can invite viewers only. Owners can invite members.

Authorizations

• cookieAuth
• bearerAuth

Request Body^required

Media typeapplication/json

object

role

required

string

Allowed values: member viewer

expiresInDays

integer

default: 7 >= 1 <= 30

maxUses

integer

default: 1 >= 1 <= 20

Responses

201

Invite created. code and url are shown once.

Media typeapplication/json

object

id

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

Exampleseed

Derived from fixtures/seed.json.

{
  "code": "H7KM29QZ",
  "createdAt": "2026-10-16T09:00:00.000Z",
  "expiresAt": "2026-10-24T09:00:00.000Z",
  "id": "inv_01j9a1b2c3d4e5f6g7h8j9k00p",
  "maxUses": 1,
  "qrPayload": "http://localhost:5173/invite/H7KM29QZ",
  "role": "viewer",
  "url": "http://localhost:5173/invite/H7KM29QZ",
  "uses": 0
}

403

Role or scope does not allow this.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

string

i18nKey

string

detail

string

fields

Array<object>

object

path

required

string

code

required

string

i18nKey

string

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "i18nKey": "example",
  "detail": "example",
  "fields": [
    {
      "path": "example",
      "code": "example",
      "i18nKey": "example"
    }
  ]
}