GET
/
users
curl --request GET \
  --url https://app.getcensus.com/api/v1/users \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "next": "https://app.getcensus.com/api/v1/syncs?page=2&per_page=25",
  "pagination": {
    "total_records": 100,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 4
  },
  "data": [
    {
      "id": 123,
      "email": "john.doe@example.com",
      "created_at": "2023-08-20T10:00:00Z",
      "role": "admin"
    }
  ]
}

Authorizations

Authorization
string
headerrequired

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.

order
enum<string>
default: desc

Determines the order of the results. It can be 'asc' or 'desc'.

Available options:
asc,
desc

Response

200 - application/json
status
enum<string>
required

The outcome of the request

Available options:
success
next
string | null
required

[Legacy] URL for the next page of resources

pagination
object
required
data
object[]
required