Skip to content

OwnInvite

An invite that the user created as a member, which always has a limit of uses and an expiry.

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
required

How many sign-ups the invite allows.

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
expires_at
required

When the invite stops working.

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",
"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