Retrieves a list of users.

Note: To use this call, you must be a Workspace Administrator, or have any tenant-level access role.

Method and endpoint

GET

/users?sort=%2BemailAddress

Query parameters

ParameterDetails
sort
  • Optional
  • Description: Sorts the results by the criteria
  • Value: %2BemailAddress
  • Example: https://api.anaplan.com/2/0/users?sort=%2BemailAddress

Curl example

curl -X GET \
https://api.anaplan.com/2/0/users?sort=%2BemailAddress \
-H 'authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type:application/json'

Response

Response 200 (application/json)

{
   "meta":{
      "schema":"https://api.anaplan.com/2/0/objects/user"
   },
   "user":{
      "id":"8a8196a55b193fa0015b1e57f3da172c",
      "active":true,
      "email":"a.user@company.com",
      "emailOptIn":true,
      "firstName":"A",
      "lastName":"User",
      "lastLoginDate":"2017-09-07T08:05:37.000+0000"
   },
   "status":{
      "code":200,
      "message":"Success"
   }
}