API Reference (v3)

Use the REST API to integrate app distribution into your CI/CD pipeline.

Authentication

All API requests require authentication via one of the following methods:

Method	Example
X-API-Key header	curl -H "X-API-Key: YOUR_KEY" ...
Bearer token	curl -H "Authorization: Bearer TOKEN" ...
api_key form parameter	curl -F api_key=YOUR_KEY ...
HTTP Basic (email:apiKey)	curl -u you@example.com:YOUR_KEY ...
OIDC	curl -H "Authorization: Bearer JWT" -H "X-OIDC-Config-Key: CONFIG_KEY" ...

Find your API key by clicking the key icon in the top navigation bar. You can exchange it for a short-lived Bearer token via POST /api/v3/auth/token.

Pagination

All list endpoints support pagination via query parameters:

Parameter	Default	Description
page	1	Page number
per_page	25	Results per page (max: 100)

Larger per_page values are capped at 100, except on /api/v3/audits, which returns a validation error instead.

Paginated responses include a pagination object. The list key matches the resource - projects, builds, teams, testers, groups, webhooks, or audits:

{
  "projects": [...],
  "pagination": {
    "page": 1,
    "per_page": 25,
    "total": 142,
    "total_pages": 6
  }
}

Postman Collection

Import the collection into Postman to start testing immediately. Set the base_url and api_key variables after importing.

Download Postman Collection

Interactive Documentation

For the full interactive API documentation with request/response examples, visit the Swagger UI.

Endpoints

Authentication

Method	Endpoint	Description
POST	/api/v3/auth/token	Exchange API key for a 1-hour Bearer token

Apps

Method	Endpoint	Description
GET	/api/v3/projects	List all apps (paginated)
GET	/api/v3/projects/{id}	Get an app
POST	/api/v3/projects	Create an app
PUT	/api/v3/projects/{id}	Update an app
DELETE	/api/v3/projects/{id}	Delete an app (admin)
GET	/api/v3/projects/{id}/testers	List testers assigned to an app (direct + via groups, deduped)
POST	/api/v3/projects/{id}/copy	Copy an app

Builds

Method	Endpoint	Description
GET	/api/v3/projects/{projectId}/builds	List builds for an app (paginated)
GET	/api/v3/builds/{id}	Get a build
POST	/api/v3/builds/upload	Upload a new build (multipart/form-data)
PUT	/api/v3/builds/{id}	Update release notes and tags
GET	/api/v3/builds/{id}/download	Get pre-signed download URL. If storage isn't configured, returns the install-page URL instead.
DELETE	/api/v3/builds/{id}	Delete a build (admin)
POST	/api/v3/builds/{id}/copy	Duplicate a build within the same app (references the same file)
POST	/api/v3/builds/{id}/notify-testers	Queue the new-build email to testers. Returns 202 {"status":"queued"}, or 409 if the build isn't distributable. Requires admin rights on the app.
GET	/api/v3/builds/{id}/symbols/download	Get a download URL for the build's symbols file

Upload Parameters

POST /api/v3/builds/upload takes multipart/form-data:

Parameter	Required	Description
file	Yes	The build file (.apk, .aab, .ipa, or .zip)
project_id	See note	The app to upload to
team_id	See note	Required unless project_id is given
version	No	Override the detected version string
release_notes	No	Release notes for the build
folder	No	Folder to place the app in
groups	No	Tester groups to notify
notify	No	Set to 1 to email testers about the new build
symbols_file	No	Symbols file to attach to the build
sync_to_saucelabs	No	Set to 1 to also copy the build to Sauce Labs App Storage
landing_page_slug	No	URL alias for the app's landing page
landing_page_mode	No	Landing page visibility

Provide either project_id or team_id. PUT /api/v3/builds/{id} accepts release_notes, tags, landing_page_slug, and landing_page_mode.

Teams

Method	Endpoint	Description
GET	/api/v3/teams	List all teams (paginated)
GET	/api/v3/teams/{id}	Get a team
POST	/api/v3/teams	Create a team (admin)
PUT	/api/v3/teams/{id}	Update a team (admin)
DELETE	/api/v3/teams/{id}	Delete a team (admin)

Testers

Method	Endpoint	Description
GET	/api/v3/testers	List testers (paginated, searchable)
GET	/api/v3/testers/{id}	Get a tester
POST	/api/v3/testers	Invite a tester by email (admin). Only the Tester role can be created via the API.
DELETE	/api/v3/testers/{id}	Remove a tester (admin)
POST	/api/v3/testers/{id}/block	Block a tester (admin)
DELETE	/api/v3/testers/{id}/block	Unblock a tester (admin)

Groups

Method	Endpoint	Description
GET	/api/v3/groups	List all groups (paginated)
GET	/api/v3/groups/{id}	Get a group with testers and apps
POST	/api/v3/groups	Create a group (admin)
PUT	/api/v3/groups/{id}	Update a group (admin)
DELETE	/api/v3/groups/{id}	Delete a group (admin)
POST	/api/v3/groups/{id}/testers	Add tester to group (admin)
DELETE	/api/v3/groups/{id}/testers/{userId}	Remove tester from group (admin)
GET	/api/v3/groups/{id}/testers	List testers in a group (paginated)
GET	/api/v3/groups/{id}/projects	List apps the group has access to (paginated)

Webhooks

Method	Endpoint	Description
GET	/api/v3/webhooks	List all webhooks (paginated)
GET	/api/v3/webhooks/{id}	Get a webhook
POST	/api/v3/webhooks	Create a webhook (admin)
PUT	/api/v3/webhooks/{id}	Update a webhook (admin)
DELETE	/api/v3/webhooks/{id}	Delete a webhook (admin)

Settings

Method	Endpoint	Description
GET	/api/v3/settings/oidc	Get the organization's OIDC configuration (admin)
POST	/api/v3/settings/oidc	Create or update the OIDC configuration (admin)
DELETE	/api/v3/settings/oidc	Delete the OIDC configuration (admin)
POST	/api/v3/settings/oidc/test	Test OIDC discovery against the issuer (admin)

Audit Logs

Method	Endpoint	Description
GET	/api/v3/audits	List audit logs (paginated, filterable by action/search/date, admin)
GET	/api/v3/audits/actions	List distinct audit action types (admin)