Retrieves a list of manual approvals, with their status.

Retrieves a list of manual approvals, with their status, and the ability to include/exclude optional software. See Using Global API Keys for more information on permission and scope requirements.

SecuritybearerAuth
Request
query Parameters
o
required
integer <int64>

Organization ID. If omitted, results will include the default (authenticated) organization. for the authenticated user.

Example: o=123456
page
integer
Default: 0

The page of results you wish to be returned with page numbers starting at 0. See About Automox API - Pagination

Example: page=0
limit
integer [ 1 .. 500 ]
Default: 500

A limit on the number of results to be returned, between 1 and 500 with a default of 500. Use with page parameter. See About Automox API - Pagination

Example: limit=500
policy_id[]
string

The ID or IDs of the policy/policies to retrieve. If omitted, this will retrieve all policies for the given organization.

Example: policy_id[]=policy_id[123456,789012]
include_optional
boolean
Default: false

Enable or disable inclusion of optional Windows patches for this policy NOTE: Will default to false if not included.

Example: include_optional=include_optional=true
sort_by
string

The field you want to sort by.

Value: "name"
Example: sort_by=sort_by=name
sort_dir
string

The sort direction, ascending or descending.

Enum Value Description
asc

Ascending order

desc

Descending order

Example: sort_dir=sort_dir=asc
Responses
200

successful operation

4XX

Invalid Request

default

Invalid Request

get/approvals
Request samples 
$apiKey = 'your_automox_api_key'
$headers = @{
    "Authorization" = "Bearer $apiKey"
    "Content-Type" = "application/json"
}
$url = "https://console.automox.com/api/approvals?o=0000"
$response = (Invoke-WebRequest -Method Get -Uri $url -Headers $headers).Content
Response samples
application/json
{
  • "summary": "Software approval example",
  • "description": "Example response for software requiring manual approval, including software details and policy information",
  • "value": {
    • "size": 1,
    • "results": [
      • {
        • "id": 351,
        • "manual_approval": null,
        • "manual_approval_time": null,
        • "status": "pending",
        • "software": {
          • "id": 137,
          • "software_version_id": 324,
          • "display_name": "Adobe Refresh Manager",
          • "version": "0.0.19",
          • "os_family": "Mac",
          • "cves": [ ]
          },
        • "policy": {
          • "id": 5,
          • "name": "A Manual Policy"
          }
        }
      ]
    }
}