Skip to content

Distribution Groups API

Distribution groups define the audiences that can install an application's uploaded builds. Use this endpoint to find groups that already contain builds for one application and to read their current member and build counts.

For workspace-wide group management, use the Dashboard's Builds → Distribution Groups view. The public endpoint documented here is read-only.

List groups for an application

GET https://api.appelium.com/v1/applications/:applicationId/distributionGroups

curl --request GET \
  --url https://api.appelium.com/v1/applications/12345/distributionGroups \
  --header 'X-Appelium-Token: YOUR_API_KEY'

Request parameters

Name Placement Type Description
applicationId Path int Required numeric application ID from the Applications API
X-Appelium-Token Header string Required workspace API key
{
  "data": [
    {
      "id": 9876,
      "serialNumber": 36,
      "name": "Internal testers",
      "isPublic": false,
      "membersCount": 12,
      "buildsCount": 8
    }
  ]
}

The application-level endpoint returns counts for the group's relationship with that application. A private group with zero members or zero builds is a valid result and can be configured before distribution begins.

Find the application ID

If the integration only has an application slug, first call:

curl --request GET \
  --url 'https://api.appelium.com/v1/applications?slug=demo-app-ios' \
  --header 'X-Appelium-Token: YOUR_API_KEY'

Read data.id from the element response, then use it in the distribution-groups path. Do not treat serialNumber as an application ID or pass a group name in the URL.

Response fields

Field Meaning
id Internal numeric distribution-group ID
serialNumber Stable human-facing group number within Appelium
name Group display name
isPublic Whether builds in the group have a public distribution link
membersCount Number of users associated with the group for this application
buildsCount Number of builds currently associated with the group for this application

Common errors

Status Meaning
401 Unauthorized The X-Appelium-Token header is missing or invalid.
404 Not Found The application ID cannot be resolved in the API key's workspace.

Authentication failures use the standard problem shape:

{
  "id": "388677B7-B016-4A6C-A8AE-887B3814114C",
  "httpStatus": 401,
  "title": "Unauthorized",
  "detail": "Invalid or missing X-Appelium-Token header"
}

See Builds to enumerate build versions and Authentication to create and manage the workspace API key.