Skip to content

AdminInvite

An invite that lets people sign up while the registration mode is open, approval, or invite.

object
id
required

The ID of a resource, a UUIDv7 in its canonical string form.

string format: uuid
code
required

The code people enter on the registration page, 16 characters.

string
url
required

The registration page with the code filled in, to send to people.

string format: uri
max_uses

How many sign-ups the invite allows; omitted when there is no limit.

integer
>= 1
uses
required

How many people have signed up with the invite.

integer
state
required

What the invite allows now. usable: people may sign up with it. revoked: it was revoked. expired: it passed expires_at. exhausted: it was used max_uses times. creator_ineligible: a member created it who may no longer create invites (their permission or plan ended, the instance setting invite_creators changed, or the account is suspended, limited, or deleted); it works again when the member may.

string
Allowed values: usable revoked expired exhausted creator_ineligible
creator_kind
required

How the invite was created. staff: by a holder of manage_invites or with the CLI; no cap applies and its creator is not checked. member: by a member through their own invites, under the caps of the instance settings; it works only while its creator may create invites.

string
Allowed values: staff member
created_by

The account of the user who created the invite. Absent for an invite created with the CLI and one whose creator’s account is deleted (created_by_deleted).

Schema: Account

object
created_by_deleted
required

Whether a user created the invite whose account no longer exists.

boolean
expires_at

When the invite stops working; omitted when it never does.

string format: date-time
created_at
required
string format: date-time

Example generated

{
"id": "01890a5d-ac96-774b-bcce-b302099a8057",
"code": "example",
"url": "https://example.com",
"max_uses": 1,
"uses": 1,
"state": "usable",
"creator_kind": "staff",
"created_by": {},
"created_by_deleted": true,
"expires_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z"
}

For LLMs and coding agents:llms.txt,llms-full.txt, llms-small.txt

Analytics on this site