List all users

get

https://api.controlup.com/v1/organizations/{orgId}/users

Returns a list of all users in your ControlUp organization, including users with a pending invitation.

Required permission: Manage Users

Path Params

orgId

uuid

required

^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}$

ID of your ControlUp organization. You can find your organization ID on the API Key Management page in the DEX platform.

Query Params

_page

int32

≥ 1

Defaults to 1

The page of results to return.
The first page is page number 1.

_limit

int32

≥ 1

Defaults to 10

The number of results returned per page.

_sortBy

string

enum

Defaults to id

Sorts results according to the specified field.

_order

string

enum

Defaults to asc

The sort order (ascending / descending) of the field specified by the _sortBy parameter.

Allowed:

_search

string

A search filter that is applied to all fields.
Only results that contain the specified string are returned.

_include

array of objects

Include additional information about related resources in the results.

_include

Allowed:

_format

string

enum

Defaults to json

The format of returned results.

Allowed:

phone

array of objects

A search filter on the phone field.

phone

fullName

array of strings

A search filter on the fullName field.

fullName

lastName

array of strings

A search filter on the lastName field.

lastName

firstName

array of strings

A search filter on the firstName field.

firstName

array of strings

A search filter on the email field.

array of strings

A search filter on the id field.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok

400Bad Request

401Unauthorized: Access is denied

403Forbidden: Access to this resource is denied

404Not Found: The requested resource could not be found

500Internal Server Error