Retrieve a list of users

Description

Returns a paginated list of users.

GET /users

🚧
Required OAuth Scopes:
No OAuth scopes are required to use this endpoint.

Parameters

Parameter	In	Type	Required	Description
$filter	query	string	false	The properties to filter the results by.
$orderBy	query	string	false	One or more comma-separated expressions to indicate the order in which to sort the results.
$maxpagesize	query	integer	false	The maximum number of results to retrieve
$next	query	string	false	Pagination cursor for next set of results.

Filter Options

Name	Predicates Supported
displayName	`contains`

Sorting Options

Name	Orders Supported
displayName	`asc`
email	`asc`
firstName	`asc`
lastName	`asc`

Code Samples

curl -X GET https://api.app.wdesk.com/platform/v1/users  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'

http GET https://api.app.wdesk.com/platform/v1/users  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"

wget --method=GET "https://api.app.wdesk.com/platform/v1/users" \
 --output-document -  \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/platform/v1/users', headers = headers)

print(r.json())

Returns

200 - OK

Returns a JSON object with data and @nextLink properties. data contains a list of User objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn't appear. If the request returns no results at all, data contains an empty array.

Example Responses


{
  "data": [
    {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
      "displayName": "Jane Doe",
      "userName": "[email protected]",
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "[email protected]"
    },
    {
      "id": "V3ZVc2VyFzV3NiQ5NDA2NjIzNxk2njH",
      "displayName": "John Doe",
      "userName": "[email protected]",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]"
    }
  ],
  "@nextLink": "{opaqueUrl}"
}