List invitations

Get details for all claimed and unclaimed invitations in the current organization.

Request schema

Query parameters

page

number

Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.

default:

per_page

number

Determines the number of results on each page. It can't exceed 100.

default:

maximum:

100

order

string

Organizes the results based on their creation time, either ascending or descending.

default:

desc

enum:

"asc""desc"

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Http + 1.1

GET

https://app.getcensus.com/api/v1/invitations

GET /api/v1/invitations?page=SOME_NUMBER_VALUE&per_page=SOME_NUMBER_VALUE&order=SOME_STRING_VALUE HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Host: app.getcensus.com

Responses

200

Successfully retrieved the list of invitations.

`200`

status

stringrequired

The outcome of the request

enum:

"success"

pagination

objectrequired

An object to help you navigate the list of results.

total_records

number

Total records in the collection.

example:

per_page

number

Records on each page.

default:

example:

prev_page

number | null

The previous page number, or null for the first page.

example:

page

number

The current page number.

default:

example:

next_page

number | null

The next page number, or null if it's the last page.

example:

last_page

number

The number of the last page with records.

example:

data

arrayrequired

The list of results.

integer

Unique identifier for the invitation.

example:

90967

string

Email address of the invitee.

example:

newuser@example.com

created_at

string

Timestamp when the invitation was created.

format:

date-time

example:

2023-09-22T20:25:45.185Z

created_by_id

integer

ID of the user who created the invitation.

example:

claimed_at

string

Timestamp when the invitation was claimed.

format:

date-time

example:

2023-09-22T20:25:45.185Z

claimed_by_id

integer

ID of the user who claimed the invitation.

example:

role

string

Role assigned to the invitee.

enum:

"admin""member"

associated_workspace_invitations

array

The list of invitations to a specific workspace that have not yet been claimed. These will be accepted automatically when the user accepts their invite to the organization.

integer

Unique identifier for the invitation to a specific workspace.

example:

90967

workspace_id

integer

Unique identifier for the workspace.

example:

1234

role

string

Role assigned to the invitee. If the Organization does not have Access Controls OR no role is specified the default will be "Owner".

enum:

"Viewer""Operator""Editor""Owner"

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "id": 90967,
      "email": "newuser@example.com",
      "created_at": "2023-09-22T20:25:45.185Z",
      "created_by_id": 13,
      "claimed_at": "2023-09-22T20:25:45.185Z",
      "claimed_by_id": 11,
      "role": "admin",
      "associated_workspace_invitations": [
        {
          "id": 90967,
          "workspace_id": 1234,
          "role": "Viewer"
        }
      ]
    }
  ]
}