List Account Users
Returns a paginated list of all users in your account. By default, only active users are returned. Use the filters parameter to include disabled users.
Endpoint
GET
v5/accountuser
Requires authentication.
Path Parameters
None
Query Parameters
All query parameters are optional.
filters
array
Filter conditions used to match user fields. By default, the endpoint returns only active users. Pass
filter[field][]=status&filter[value][]=all to include disabled users in the results.
child attributes
field
string
The user field to filter by. Accepted value:
status.operator
string
The comparison operator to use.
EQ |
Is equal to |
NEQ |
Is not equal to |
value
string
The value to match against. Accepted values:
Active, Disabled, all. Pass all to return both active and disabled users.Response
Returns a paginated array of account user objects.
result_ok
boolean
Whether the request succeeded.
total_count
integer
Total number of users matching the request.
page
integer
Current page index.
total_pages
integer
Number of available pages.
results_per_page
integer
Number of users returned per page.
data
array
Array of account user objects.
child attributes
id
string
The unique ID of the user.
username
string
The user's display name.
email
string
The user's email address.
admin
integer
Whether the user has account administrator privileges.
1 = admin, 0 = standard user.phone_support
integer
Whether phone support access is enabled for the user.
1 = enabled, 0 = disabled.userdata
array | object
Custom user data fields set on the user. Returns an empty array
[] if none are set.license
string
The license type assigned to the user (e.g.
Full Access, Professional, Collaborator, Stakeholder). Returns an empty string if no license is assigned.defaultteam
string | boolean
The ID of the user's default team, or
false if no default team is set.status
string | null
The user's account status. Possible values:
Active, Disabled, or null.last_login
string | null
Timestamp of the user's most recent login (EST/EDT), or
null if the user has not yet logged in.api_key
string | null
The user's API token, if one has been generated. Only present on users who have an API token. Returns
null if no token exists.api_secret
string | null
The user's API token secret, if one has been generated. Only present on users who have an API token. Returns
null if no token exists.Examples
Note GET requests are cached for 60 seconds. Repeated identical requests within that window will return cached results.
Request (cURL) — Basic List
curl -X GET "https://api.alchemer.com/v5/accountuser?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response — Basic List
{
"result_ok": true,
"total_count": 5,
"page": 1,
"total_pages": 1,
"results_per_page": 5,
"data": [
{
"id": "123457",
"username": "user@example.com",
"email": "user@example.com",
"admin": 0,
"phone_support": 0,
"userdata": [],
"license": "",
"defaultteam": false,
"status": "Active",
"last_login": null
},
{
"id": "123456",
"username": "Jane Smith",
"email": "jane.smith@example.com",
"admin": 1,
"phone_support": 0,
"userdata": [],
"license": "Full Access",
"defaultteam": "1000125",
"status": "Active",
"last_login": "2026-04-06 10:39:20",
"api_key": "YOUR_API_TOKEN",
"api_secret": "YOUR_API_TOKEN_SECRET"
}
]
}
Request (cURL) — Include Disabled Users
curl -X GET "https://api.alchemer.com/v5/accountuser?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&filter[field][]=status&filter[value][]=all"
Response — Include Disabled Users
{
"result_ok": true,
"total_count": 7,
"page": 1,
"total_pages": 1,
"results_per_page": 7,
"data": [
{
"id": "123457",
"username": "user@example.com",
"email": "user@example.com",
"admin": 0,
"phone_support": 0,
"userdata": [],
"license": "",
"defaultteam": false,
"status": "Active",
"last_login": null
},
{
"id": "123456",
"username": "Jane Smith",
"email": "jane.smith@example.com",
"admin": 1,
"phone_support": 0,
"userdata": [],
"license": "Full Access",
"defaultteam": "1000125",
"status": "Active",
"last_login": "2026-04-06 10:39:20",
"api_key": "YOUR_API_TOKEN",
"api_secret": "YOUR_API_TOKEN_SECRET"
},
{
"id": "123450",
"username": "Former Employee",
"email": "former@example.com",
"admin": 0,
"phone_support": 0,
"userdata": [],
"license": "",
"defaultteam": false,
"status": "Disabled",
"last_login": "2025-01-15 09:22:04"
}
]
}