Get IDs by API

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard
Not for use with personal data

Axe Monitor users can generate an API key in Axe Account and look up IDs which are required for use with other Axe Monitor API endpoints, without using the user interface.

Learn more about Getting Started.

Endpoints

Method Endpoint Purpose
GET /lookups/presets Retrieve preset IDs to apply a preset to a scan. And, when a scan is currently assigned to a preset – look up which fields can be edited.
GET /lookups/teams Get team name & IDs to provide access to scans via the API.
GET /lookups/scans Get scan names & IDs to get results, edit or run scans.
GET /scans/[scanId]/runs List all the scan runs for a scan, with scan overview information. Allows you to retrieve runId.
GET /lookups/scan-groups Get scan group names & IDs to provide to organize scans via the API.
GET /lookups/scripts Get IDs to assign shared scripts to scans via the API.

Presets

You can apply the preset settings to a scan via the API, but the preset ID & name are required first. Use this endpoint to look them up.

Preset ID is also needed to understand which scan settings are editable when a preset is already applied.

Example Request

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/presets
X-API-Key: <your_api_key>
Content-Type: application/json

Example Response

Status: 200 Success

{
  "presets": [
    { "id": 3, "name": "Gov Baseline" },
    { "id": 1, "name": "Marketing sites" }
  ]
}

Teams

You can assign team permissions when creating or editing a scan via the API. Use this endpoint to look up team names and IDs.

Example Request

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/teams
X-API-Key: <your_api_key>
Content-Type: application/json

Example Response

Status: 200 Success

{
  "teams": [
    { "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "Accessibility" },
    { "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "Web Platform" }
  ]
}

Scans

Scan IDs and names are required to get results, edit, and run scans. Use this endpoint to look them up.

Example Request

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scans
X-API-Key: <your_api_key>
Content-Type: application/json

Example Response

Status: 200 Success

{
  "teams": [
    { "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "French Marketing Site" },
    { "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "My Account Platform" }
  ]
}

Scan Runs

Scan run IDs can be retrieved with this endpoint to get detailed results data.

Example Request

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>

Example Response

{
  "scanRuns": [
    {
      "runNumber": 1,
      "status": "Completed",
      "queuedAt": "2025-08-21T06:50:27Z",
      "startedAt": "2025-08-21T06:50:37Z",
      "completedAt": "2025-08-21T06:51:52Z",
      "axeVersion": "4.10.3",
      "standard": "WCAG 2.1 AA",
      "score": 0,
      "issues": {
        "total": 392,
        "critical": 77,
        "serious": 315,
        "moderate": 0,
        "minor": 0
      },
      "pages": {
        "total": 18,
        "completed": 17,
        "critical": 17
      },
      "violationGroups": [
        {
          "name": "color",
          "pageCount": 17
        },
        {
          "name": "forms",
          "pageCount": 17
        },
        {
          "name": "name-role-value",
          "pageCount": 10
        },
        {
          "name": "parsing",
          "pageCount": 1
        },
        {
          "name": "text-alternatives",
          "pageCount": 13
        }
      ]
    }
  ]
}

Scan Groups

You can organize scans by scan groups when creating or editing scans from the API. Use this endpoint to look up scan group IDs and names.

Example Request

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scan-groups
X-API-Key: <your_api_key>
Content-Type: application/json

Example Response

Status: 200 Success

{
  "scanGroups": [
    { "id": 1234, "name": "Marketing" },
    { "id": 1200, "name": "Storefront" }
  ]
}

Shared Scripts

Shared scripts that are stored in the Admin section of Axe Monitor and used across several scans can be applied when creating or editing scans via the API. Use this endpoint to look up shared script IDs.

Example Request

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scripts
X-API-Key: <your_api_key>
Content-Type: application/json

Example Response

Status: 200 Success

{
  "scripts": [
    { "id": 12, "name": "Dismiss cookie banner", "type": "TASK" },
    { "id": 9, "name": "SSO login", "type": "SESSION" }
  ]
}

Is this page helpful?

Help us improve this page

Still need help?