List users that are assigned to a zone (organization).

List users that are assigned to the zone (organization). See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
path Parameters
accountId
required
string <uuid>

Account ID to retrieve users for.

Example: 123e4567-e89b-12d3-a456-426614174000
zoneId
required
string <uuid>

ID for the specified zone

Example: 123e4567-e89b-12d3-a456-426614174000
query Parameters
page
integer <int64>
Default: 0

The page of results you wish to be returned with page numbers starting at 0.

Example: page=0
limit
integer <int64>
Default: 25

A limit on the number of results to be returned, between 1 and 500, with a default of 25. Use with page parameter.

Example: limit=25
Responses
200

Successful Operation

4XX

Invalid Request

get/accounts/{accountId}/zones/{zoneId}/users
Request samples 
$apiKey = 'your_automox_api_key'
$headers = @{
    "Authorization" = "Bearer $apiKey"
    "Content-Type" = "application/json"
}
$url = "https://console.automox.com/api/accounts/{accountId}/zones/{zoneId}/users"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content
Response samples
application/json
{
  • "data": [
    • {
      • "id": 50687,
      • "uuid": "56e207a9-3b3e-48f1-b738-4172f11f70fd",
      • "email": "gzmtest@automox.com",
      • "first_name": "GZM",
      • "last_name": "TestAccount",
      • "status": "active",
      • "account_rbac_role": "global-admin",
      • "is_verified": false,
      • "two_factor_authentication": "email",
      • "created_at": "2021-10-20T16:03:25+0000",
      • "zone_rbac_role": "zone-admin"
      }
    ],
  • "metadata": {
    • "total_pages": 1,
    • "current_page": 0,
    • "total_count": 1,
    • "limit": 500,
    • "links": [ ]
    }
}