Skip to main content
GET
Get app invite by code

Path Parameters

code
string
required

The invite code used to look up an app invite.

Response

Successfully retrieved the app invite.

A stripped-down public view of an app invite, returned for unauthenticated code lookups.

id
string<uuid>
required

Unique identifier for the app invite.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

app
object
required

Summary information about an app.

Example:
company
object
required

Summary information about a company.

Example:
status
enum<string>
required

The lifecycle status of an app invite.

Available options:
pending,
active,
archived
Example:

"pending"

url
string
required

The full invite URL constructed from the base URL and invite code.

Example:

"https://example.com/invite?code=abc123def456ghi789jkl012"

data
object | null

Custom JSON data associated with the invite.

Example:
display_name
string | null

An optional display name for the invite.

Example:

"Partner onboarding invite"

invitee_name
string | null

An optional name for the invitee. Maximum 1024 characters.

Example:

"Jane Smith"