Skip to main content
GET
Get App Invite By Code

Path Parameters

code
string
required
Example:

"abc123def456ghi789jkl012"

Response

GetAppInviteByCode 200 response

Stripped-down invite for the unauthenticated code lookup. Omits the code, timestamps, and other fields only authenticated callers should see.

id
string
required

App invite id in UUID format.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

app
object
required
Example:
company
object
required
Example:
status
enum<string>
required
Available options:
pending,
active,
archived
Example:

"pending"

url
string
required
Example:

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

data
any
display_name
string

Display name shown to the invitee. Non-empty, at most 1023 characters once trimmed.

Required string length: 1 - 1023
Example:

"Partner onboarding invite"

invitee_name
string

Name of the invitee. Non-empty, at most 1023 characters once trimmed.

Required string length: 1 - 1023
Example:

"Jane Smith"