Accessibility

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

Get Accessibility Tests

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'.

SecuritybasicAuth
Request
query Parameters
limit
integer

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

skip
integer

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

Responses
200

A 200 response

Response Schema: application/json
object
object
Array of objects
401

A 401 response

get/v1/inspect/accessibility
Request samples
Response samples
application/json
{}

Create Accessibility Test

This endpoint allows users to submit an accessibility test for processing. It accepts a set of HTML content, processes it for accessibility issues, and returns a unique job ID for tracking the status of the test. The status of the job will display in the meta object, with a status of 'Processing'.

SecuritybasicAuth
Request
Request Body schema: application/json
required
html
required
string

The HTML content to be tested. Can be a raw HTML string or base64 encoded.

encoded
boolean

Indicates whether the html content is base64 encoded (true) or raw (false).

Responses
201

A 201 response

Response Schema: application/json
object
object
400

A 400 response

401

A 401 response

post/v1/inspect/accessibility
Request samples
application/json
{
  • "html": "string"
}
Response samples
application/json
{}

Get Accessibility Test

Retrieve the details of a specific accessibility test using the provided test ID. This endpoint returns comprehensive details about the test, including metadata and test results.

SecuritybasicAuth
Request
path Parameters
id
required
string

The unique identifier of the test.

Responses
200

A 200 response

Response Schema: application/json
object
Array of objects
401

A 401 response

404

A 404 response

get/v1/inspect/accessibility/{id}
Request samples
Response samples
application/json
{
  • "meta": {
    • "status": "Complete"
    },
  • "items": [
    • {
      }
    ]
}

Delete Accessibility Test

Delete a specific accessibility test by its unique test ID. This endpoint allows you to remove an accessibility test from the system. If the test ID does not exist, the appropriate error message is returned.

SecuritybasicAuth
Request
path Parameters
id
required
string

The unique identifier of the test.

Responses
200

A 200 response

Response Schema: application/json
message
required
string
401

A 401 response

404

A 404 response

delete/v1/inspect/accessibility/{id}
Request samples
Response samples
application/json
{
  • "message": "Accessibility test with test id <id> has been successfully deleted."
}