Skip to main content
GET
/
app-invites
/
codes
/
{code}
Get app invite by code
curl --request GET \
  --url https://api-dev.narrative.io/app-invites/codes/{code}
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "app": {
    "id": 100,
    "name": "Test App",
    "slug": "test-app"
  },
  "company": {
    "id": 42,
    "logo": "https://example.com/logo.png",
    "name": "Acme Corp"
  },
  "data": {
    "key": "value"
  },
  "display_name": "Partner onboarding invite",
  "invitee_name": "Jane Smith",
  "status": "pending",
  "url": "https://example.com/invite?code=abc123def456ghi789jkl012"
}

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:
{
  "id": 100,
  "name": "Test App",
  "slug": "test-app"
}
​
company
object
required

Summary information about a company.

Example:
{
  "id": 42,
  "logo": "https://example.com/logo.png",
  "name": "Acme Corp"
}
​
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

Custom JSON data associated with the invite.

Example:
{ "key": "value" }
​
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"