API Reference

Get All Users (Including Attributes)

get
https://app.workramp.com/api/v1/users/attributes

This returns a list of all users, including built-in and custom attributes.

See also: Get All Users

⚠️ Legacy Mode Support

This endpoint supports the optional query parameter legacy_mode for accounts created before November 11, 2025.

If you use legacy_mode, the API will bypass standard pagination and return the full dataset in a single response.

We strongly recommend migrating to the standard, paginated response format, as legacy mode support may be deprecated in a future API version. At the moment, legacy_mode defaults to true.

Query Params
boolean
Defaults to false

Default behavior is to return custom attributes for users where isDeleted is "false". You can set this parameter to "true" to return custom attributes for users where isDeleted is either "true" or "false".

boolean
Defaults to true

For accounts provisioned prior to November 11, 2025, the optional query parameter legacy_mode can be set to bypass pagination. When legacy_mode is enabled, the API will return the entire result set in a single, non-paginated response.

int32
Defaults to 1

Page of results to return

int32
Defaults to 20

Number of results to return per page (1-200)

Responses

Updated 10 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 months ago

Did this page help you?