Applications API
Use the Applications API to discover the apps in your workspace, find an application by its slug, or retrieve one application by numeric ID. The returned application contains the identifiers needed by most other API endpoints, including builds, crashes, tests and symbol uploads.
Every request is scoped to the workspace that owns the API key. See Authentication before calling the endpoint.
List applications
GET https://api.appelium.com/v1/applications
curl --request GET \
--url https://api.appelium.com/v1/applications \
--header 'X-Appelium-Token: YOUR_API_KEY'
The data array is sorted by application name and platform.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | |
platform uses these values:
| Value | Platform |
|---|---|
1 |
Android |
2 |
iOS |
3 |
tvOS |
4 |
iPadOS |
Metrics and store-related properties are nullable until Appelium has collected the corresponding data. The token is the application token used by the mobile SDK, not the workspace API key passed in X-Appelium-Token.
Find an application by slug
Pass the application slug as a query parameter:
curl --request GET \
--url 'https://api.appelium.com/v1/applications?slug=demo-app-ios' \
--header 'X-Appelium-Token: YOUR_API_KEY'
When slug is present, the response is an element object ({"data": {...}}) rather than an array. The slug is available in the Dashboard URL and in the slug field returned by the list endpoint.
If the slug does not belong to the authenticated workspace, the server returns 404 Not Found.
Get an application by ID
GET https://api.appelium.com/v1/applications/:applicationId
curl --request GET \
--url https://api.appelium.com/v1/applications/12345 \
--header 'X-Appelium-Token: YOUR_API_KEY'
The successful response uses the same data object shown in the list response.
Request parameters
| Name | Placement | Type | Description |
|---|---|---|---|
X-Appelium-Token |
Header | string |
Required workspace API key created in the Dashboard |
applicationId |
Path | int |
Required numeric application ID |
Common errors
| Status | Meaning | What to do |
|---|---|---|
401 Unauthorized |
The API key header is missing or invalid. | Verify the X-Appelium-Token header and use a Dashboard API key, not the application's mobile SDK token. |
403 Forbidden |
A personal API key's user role is not allowed to perform the operation. | Use a permitted role or a system API key. |
404 Not Found |
The ID or slug does not exist in the key's workspace. | Check the workspace and identifier. IDs and slugs from another workspace are never disclosed. |
The API uses a standard problem response:
{
"id": "388677B7-B016-4A6C-A8AE-887B3814114C",
"httpStatus": 401,
"title": "Unauthorized",
"detail": "Invalid or missing X-Appelium-Token header"
}
After you have the application ID, use the application-specific endpoints for Builds, Crashes, Distribution Groups and Symbols Files.