Skip to main content
GET
/
app-invites
List app invites
curl --request GET \
  --url https://api-dev.narrative.io/app-invites \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 1,
  "next_page": null,
  "total_records": 1,
  "total_pages": 1,
  "records": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "activated_at": null,
      "app": {
        "id": 100,
        "name": "Test App",
        "slug": "test-app"
      },
      "code": "abc123def456ghi789jkl012",
      "company": {
        "id": 42,
        "logo": "https://example.com/logo.png",
        "name": "Acme Corp"
      },
      "created_at": "2025-01-01T00:00:00Z",
      "data": null,
      "display_name": null,
      "invitee_name": null,
      "status": "pending",
      "tags": [],
      "updated_at": "2025-01-01T00:00:00Z",
      "url": "https://example.com/invite?code=abc123def456ghi789jkl012"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer

Number of page. Stars from the first (1) page.

per_page
integer

Number of records to return.

installation_id
integer<int64>

Filter results to invites belonging to a specific installation. The installation must be owned by the authenticated caller (matching app and/or company).

Response

Successfully retrieved list of app invites.

A paginated list of app invites.

current_page
integer<int64>
required

The number of requested page.

Example:

1

total_records
integer<int64>
required

Total amount of accessible Access Rules

Example:

15000

total_pages
integer<int64>
required

Total amount of pages.

Example:

10

records
object[]
required
prev_page
integer<int64>

The number of previous page (if exists). Also can refer to the latest existing page if non-existing page was requested.

Example:

1

next_page
integer<int64>

The number of next page (if exists).

Example:

42