List invitations

GET

/v1/invitations

curl "https://api.summerbase.com/v1/invitations" \
  -H "Authorization: Bearer sb_..."

Every invitation this organization has outstanding, oldest first. One that is past expires_at stays listed until it is cancelled or reissued.

Parameters

Query Parameters

limit

integer

default: 20 >= 1 <= 100

How many records to return, 1 to 100. Defaults to 20.

cursor

string

The next_cursor of the previous page, to read the page after it.

include_total_count

boolean

Whether to add total_count, how many records match altogether. On the first page only: it is the same number on every page of one list, so keep the first page’s, and it is refused beside a cursor.

Response

Returns a list of invitation objects, a page at a time. See Pagination.

Media typeapplication/json

Example

{
  "data": [
    {
      "email": "sam@example.com",
      "expires_at": "2026-10-26T15:30:00Z",
      "id": "0199c3e4-2a7b-7f10-9c8d-4e6f1a3b5d27",
      "object": "invitation",
      "role": "writer"
    }
  ],
  "has_more": false,
  "next_cursor": null,
  "object": "list",
  "total_count": 1
}