GET
/
invitations
curl --request GET \
  --url https://app.getcensus.com/api/v1/invitations \
  --header 'Authorization: Bearer <token>'
{
  "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"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authorization using your Personal Access Token. Generate a new PAT on your user settings page.

Query Parameters

​
page
number
default:1

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

​
per_page
number
default:25

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

Required range: x <= 100
​
order
enum<string>
default:desc

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

Available options:
asc,
desc

Response

200 - application/json
Successfully retrieved the list of invitations.

A successfully fetched list of results.

​
status
enum<string>
required

The outcome of the request

Available options:
success
Example:

"success"

​
pagination
object
required

An object to help you navigate the list of results.

​
data
object[]
required

The list of results.

Was this page helpful?

Raise issue
Update User RoleFetch invitation