Skip to content
Mailgun Inspect/
/Accessibility

Accessibility

The Accessibility API evaluates HTML emails against WCAG standards, providing a clear pass/fail assessment to ensure compliance with accessibility guidelines.

Operations

Get Accessibility Tests

Request

Retrieve a paginated list of all accessibility tests that have been submitted. Each test includes details such as its status, the number of checks performed, and, of those checks, how many passes and failures there were. The response is paginated, with a limit of up to 1000 items per page. The total count of records will display in the meta object under the key, 'count'.

Security
basicAuth
Query
limitinteger

Max count of items. Max: 1000. Default: 100

skipinteger

Get the list of items starting at the nth element (paging). Default: 0

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v1/inspect/accessibility?limit=0&skip=0'

Responses

A 200 response

Bodyapplication/json
metaobject or null
paginggithub.com-mailgun-scaffold-httpapi-paging-PagingResponse (object) or null
Any of:
itemsArray of objects(github.com-mailgun-inspect-internal-accessibility-GetAccessibilityTestsResource)
Response
{
  "meta": {
    "count": 9
  },
  "paging": {
    "first": "https://api.mailgun.net/v1/inspect/accessibility/tests?limit=100&skip=0",
    "last": "https://api.mailgun.net/v1/inspect/accessibility/tests?limit=100&skip=0"
  },
  "items": [
    { … }
  ]
}