Get Started with Project Management Automation

If your organization manages a large number of Axe Developer Hub projects, or onboards and offboards contributors frequently, you can automate that work with the Projects API instead of clicking through the Axe Developer Hub UI.

What You Can Automate

Using your API key, your automation can:

• Create, update, and delete projects.
• List every project in your organization (as an org admin) or every project you belong to.
• List a project's members, add a member with a role, change a member's role, and remove a member.

See the Projects API Reference for full request and response details for every operation.

Before You Start

• Creating a project requires an active subscription (license) for that project's type. Whoever creates a project automatically becomes its project admin.
• Project roles are admin and member. A project admin can update or delete the project and manage its membership. A project member can access the project but not manage it or its membership.
• Org Admins can see and manage every project of their organization's licensed types, regardless of their own project membership. They do not need a personal license to view, update, delete, or manage the members of an existing project. Creating a project is the one exception: it always requires an active license, whether the caller is an org admin or not.
• Adding a member to a project does not require that member to hold a license. The API records them as a project member immediately, but they cannot access the project until they hold a license. The target user must already belong to the organization. You cannot add someone who is not already an organization member.
• Deleting a project is final. There is no self-serve restore for a deleted project.

Each project type accepts only specific test_language and test_platform values, listed in Project Type Configuration Values. Choose the type carefully: a project's type can't change after it's created.

Get Your API Key

1. Sign in to the Axe Account Portal.
2. Copy an Axe Developer Hub API key for web or CI/CD projects, or an Axe DevTools Mobile API key for mobile projects. Use this key's X-API-Key header value on every request to the Projects API.

Create Your First Project Automatically

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "name": "webapp-ci",
    "selected_project_type": "axe-devtools-watcher",
    "test_language": "typescript",
    "test_platform": "Playwright"
  }' \
  "https://axe.deque.com/api-pub/v1/results/projects"

The response includes the new project_id. Save it: you will need it for every subsequent call against this project, including sending test results.

Add Teammates to the Project

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "user_email_role_pairs": [
      { "user_email": "sam@example.com", "role": "member" }
    ]
  }' \
  "https://axe.deque.com/api-pub/v1/results/projects/$PROJECT_ID/memberships"

Identify each user by their Axe Account email address. The target user must already belong to your organization. Adding them does not require them to hold a license, but they cannot access the project until they do.

Next Steps

• Projects API Reference for the full endpoint reference, including retrieving, updating, and deleting projects, and managing membership at scale with the batch operations.
• Sessions and Results API Reference for retrieving accessibility results once your automated projects are producing them.