Returns a CSV file with username, first name, last name, and licenses columns.
You can set a limit to the number of users returned in the CSV, or if you omit a limit query parameter, this will default to the first 10 users.
Method and endpoint
GET
/admin/1/0/users/export
Parameters
| Header | Required | Description |
Authorization: AnaplanAuthToken {anaplan_auth_token} | Yes | The Anaplan authentication token. |
Accept: text/csv | No | The response type. This value defaults to text/csv |
| Query parameter | Required | Description |
Limit | Optional | Sets the maximum number of users to return. The default is to return all users, by omission. |
Offset | Optional | Sets the offset number for the starting point of the data fetch. |
Curl example
CURL -X GET 'https://api.anaplan.com/admin/1/0/users/export'
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Accept: text/csv'
Response
Success
A successful request returns an HTTP 200 response, and a CSV-formatted file containing the user data.
Failure
If the request is unsuccessful, the API returns an error code.
| ErrorCode | ErrorMessage | Description |
400 | INVALID | Invalid request parameters. |
401 | UNAUTHORIZED | Authorization token is missing or invalid. |
403 | FORBIDDEN | User is not allowed to perform this operation. |
Related content
Read about the import endpoint.
