List all users

Retrieves a list of all users with access to an organization

get
/users

https://console.automox.com/api/users
Request
Response
Request
Headers
Authorization: Bearer
required
string
Your Automox API Key for authentication Format: Authorization: Bearer your_automox_api_key
Query Parameters
o
optional
string
The Organization whose users you wish to list. If you omit this value, the application will detect and use your default Organization.
Response
200: OK
{
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"features": {
"type": "object",
"items": {
"type": "object",
"properties": {
"mo": {
"type": "boolean"
}
}
}
},
"firstname": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"lastname": {
"type": "string"
},
"orgs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"access_key": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"trial_end_time": {
"type": "string",
"format": "date-time"
},
"trial_expired": {
"type": "boolean"
}
}
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}

Example Requests

cURL
Python http.client
Python requests
C#
PowerShell
cURL
curl -X GET \
'https://console.automox.com/api/users?o=0000' \
-H 'Authorization: Bearer your_automox_api_key'
Python http.client
import http.client
conn = http.client.HTTPConnection("console,automox,com")
headers = {
'Authorization': "Bearer your_automox_api_key"
}
conn.request("GET", "api,users", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
Python requests
import requests
url = "https://console.automox.com/api/users"
querystring = {"o":"0000"}
headers = {
'Authorization': "Bearer your_automox_api_key"
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
C#
var client = new RestClient("https://console.automox.com/api/users?o=0000");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer your_automox_api_key");
IRestResponse response = client.Execute(request);
PowerShell
$apiKey = 'your_automox_api_key'
$headers = @{ "Authorization" = "Bearer $apiKey" }
$url = "https://console.automox.com/api/users?o=0000"
Invoke-WebRequest -Method GET -Uri $url -Headers $headers