A11y Pulse API

← Back to Documentation

The A11y Pulse API allows you to access your accessibility data programmatically. You can use it to retrieve sites, pages, and scan results, create and manage sites and pages, trigger scans, and integrate A11y Pulse into your own tools and workflows. View the interactive API reference.

Contents:

• Generating an API key
• Permissions
• Authentication
• Interactive API reference

Generating an API key

⚠️ After creating a new API key, you should copy the key immediately and store it somewhere safe. It will not be shown again. API keys begin with a11y_ followed by a random string.

To generate an API key, go to your A11y Pulse Settings page and scroll down to the API Keys section. From here you can create a new API key or revoke existing ones.

When revoking an API key, it will immediately stop working and any requests using that key will receive a 401 Unauthorized response.

Permissions

Each API key carries its own set of permissions, which you choose when you create the key. You must grant at least one. A request to an endpoint your key isn’t permitted to use will receive a 403 Forbidden response.

Permissions are fixed once a key is created. To change the permissions for an integration, create a new key with the permissions you need and revoke the old one.

Authentication

All API requests must include your API key as a Bearer token in the Authorization header:

Authorization: Bearer a11y_yourkey

Requests without a valid API key will receive a 401 Unauthorized response.

Interactive API reference

An interactive API reference is available at api.a11ypulse.com/docs. You can use it to explore all available endpoints and try them out directly in your browser.

Base URL

https://api.a11ypulse.com/v1

Pagination

List endpoints return paginated results. Use the page and perPage query parameters to control pagination. The response includes a meta object with the following fields: