Get Company Users

Allowed Scopes: user:read

Returns members (users) of the given company. Useful for organisations with multiple companies (entities): a single organisation-level token can list the users of any company it owns by passing its companyId. User data is cached for up to 20 minutes. Changes made through the API are returned by subsequent reads; changes made in Spendesk can take up to 20 minutes to appear.

A 403 means the token's organisation does not own companyId.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Company ID.

Query Params
integer
≥ 1
Defaults to 1

Page number

integer
1 to 30
Defaults to 30

Page size

ids
array of strings

User IDs to filter by.

ids
string
enum
Defaults to active

The user status to filter for.

Allowed:
include
array of strings

Extra related data to embed on each user. Each value costs one additional lookup per request, so it is opt-in. Repeat the parameter for multiple values (e.g. include=manager&include=teams).

include
Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json