Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

Authenticate with an API access token in the Authorization header: Authorization: Bearer <token>. Create a token from the API Access Tokens page in Contractors Cloud, under Integrations.

Query Parameters

page[number]
integer
default:1

The 1-indexed page number to retrieve.

Required range: x >= 1
page[size]
integer
default:30

The number of results per page (max 100).

Required range: 1 <= x <= 100
filter[id]
integer

Exact match on the user's id.

filter[email]
string

Exact match on the user's email address.

filter[status]
boolean

Exact match on the user's active status (1 or 0).

Fuzzy search across first name, last name, email, and username.

filter[employed]
boolean

Limit to currently employed (1) or terminated (0) users.

filter[in_company]
integer

Limit to users assigned to the given company id.

filter[extended_property]
object

Filters by an extended property's key and value, using the syntax filter[extended_property][<key>]=<value>. Matches users with an extended property whose key equals <key> and whose value exactly equals <value> (comma-separate multiple values to match any of them).

include
string

Comma-separated related resources to embed. Allowed: user_level, default_company, project_list_setting, extended_properties.

append
string

Comma-separated computed attributes to include. Allowed: home_page, project_page, is_password_set, needs_onboarding, two_factor_setup_status.

sort
string

Field to sort by. Prefix with - for descending. Allowed: first_name, last_name, email, status.

Response

A paginated list of users.

data
object[]
current_page
integer

The 1-indexed page number of the current response.

Example:

1

first_page_url
string

The URL of the first page of results.

from
integer | null

The 1-indexed position of the first record in data for this page. Null when the page is empty.

Example:

1

last_page
integer

The number of the final page in the result set.

Example:

4

last_page_url
string

The URL of the last page of results.

Rendered pagination links (previous, numbered pages, next).

next_page_url
string | null

The URL of the next page, or null if this is the last page.

path
string

The endpoint URL without query parameters.

per_page
integer

The number of records requested per page.

Example:

30

prev_page_url
string | null

The URL of the previous page, or null if this is the first page.

to
integer | null

The 1-indexed position of the last record in data for this page. Null when the page is empty.

Example:

30

total
integer

The total number of records across all pages.

Example:

97