List Users via API
This method allows you to list all users in your DeployHQ account.
Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.
URL
/users
HTTP Method
GET
Supported Parameters
This endpoint does not accept any parameters.
Example cURL Request
curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
https://test.deployhq.com/users
Example Response
[
{
"id": 12345,
"identifier": "9e11def8-8c43-454e-8c99-3c5b9cf08396",
"first_name": "John",
"last_name": "Doe",
"email_address": "john@example.com",
"time_zone": "Etc/UTC",
"account_administrator": true,
"activated": true,
"can_manage_users": true,
"can_manage_billing": true,
"can_create_projects": true,
"can_manage_agents": true,
"all_projects_allowed": true
}
]
Notes
- Returns an array of all users in the account
- Each user includes their permissions and role information
- The
identifierfield is a UUID used to reference the user in other endpoints