users

List users

Retrieve a list of users in Deel's HRIS.

Token scopes: Users:read

get/Users

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/Users
  • Auth: HTTP bearer

Query parameters

string
OR
string[]

Filter results using SCIM's filtering syntax. Currently supports only eq operator and filtering by a user's email. Expected format 'email eq "email@domain.com"'.

startIndexstring

The 1-based index of the first result to return. Used for pagination. Minimum value is 1. Defaults to 1 if not provided.

countstring

The maximum number of results to return per page. Used for pagination. A value of 0 is treated as a special case and returns 1 result. Typically should be a positive integer.

Response

Successful response

schemasUsersGetResponsesContentApplicationJsonSchemaSchemasItems[]
startIndexinteger
itemsPerPageinteger
totalResultsinteger

Changes

No recorded changes to this operation across all 1 revision of this API.