Adding and connecting an app

Before you can manage releases through the API, you need to add the app to Release Management and connect it to a store.

The Apps sub-API base URL: https://api.bitrise.io/release-management/v2/apps/v1. See the Apps API reference for the full list of endpoints, parameters, and schemas.

Adding a new app

Endpoint	Function	Required role
POST /	Add a new app.	Release manager
GET /	List all apps in a workspace.	Any
GET /{id}	Get details of a specific app.	Any
DELETE /{id}	Remove an app from Release Management.	Release manager

To add an app, call POST / with the required fields:

• platform: The app platform: ios or android.
• store_app_id: The app's store identifier. For iOS: the App Store Connect numeric app ID. For Android: the package name (e.g. com.example.myapp).
• workspace_slug: The slug of the Bitrise workspace that will own the app.
• store_credential_id: The numeric integer ID of the Apple or Google service credential configured in your workspace. Required to connect the app to the store immediately. To skip this and connect later, set manual_connection: true instead.

iOS

curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "ios",
    "store_app_id": "1234567890",
    "workspace_slug": "YOUR_WORKSPACE_SLUG",
    "store_app_name": "My iOS App",
    "store_credential_id": YOUR_APPLE_CREDENTIAL_ID,
    "framework": "native_ios"
  }'

Android

curl -X POST "https://api.bitrise.io/release-management/v2/apps/v1/" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "android",
    "store_app_id": "com.example.myapp",
    "workspace_slug": "YOUR_WORKSPACE_SLUG",
    "store_app_name": "My Android App",
    "store_credential_id": YOUR_GOOGLE_CREDENTIAL_ID,
    "framework": "native_android"
  }'

The response includes the new app's id.

{
  "id": "YOUR_APP_ID",
  "created_at": "2026-01-01T00:00:00.000Z",
  "platform": "android",
  "project_id": "YOUR_PROJECT_ID",
  "workspace_slug": "YOUR_WORKSPACE_SLUG",
  "icon_id": null,
  "icon_url": null,
  "app_name": "My Android App",
  "current_user_release_management_admin": false,
  "framework": "native_android",
  "latest_version": null,
  "latest_version_date": null,
  "latest_build_version": "",
  "latest_build_version_code": "",
  "license": "basic",
  "store_app_id": "com.example.myapp",
  "store_connected": true,
  "store_credential_id": 12345
}

Save this value — you'll need it in all subsequent API calls for this app.

Store credentials

The store_credential_id refers to an Apple or Google service credential configured in your workspace. You can manage credentials in Bitrise from Workspace settings > Integrations.

You can connect the app to the store later using PATCH /{id}.

Connecting an app to the store

Endpoint	Function	Required role
PATCH /{id}	Update app settings, including store connection.	Release manager

If you added an app with manual_connection: true or need to update the store credentials, use PATCH /{id}:

curl -X PATCH "https://api.bitrise.io/release-management/v2/apps/v1/APP_ID" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "connect_to_store": true,
    "store_credential_id": YOUR_CREDENTIAL_ID
  }'

You can also update the store_app_id via PATCH /{id} if the app was initially registered with an incorrect identifier.

Listing apps

To list all apps in a workspace:

curl -X GET "https://api.bitrise.io/release-management/v2/apps/v1/?workspace_slug=YOUR_WORKSPACE_SLUG" \
  -H "Authorization: YOUR_ACCESS_TOKEN" \
  -H "Accept: application/json"

Optional query parameters:

• platform: Filter by ios or android.
• project_id: Filter by an associated Bitrise CI project ID.
• search: Search by app name.
• items_per_page: Results per page (default: 10, max: 50).
• page: Page number (default: 1).

Removing an app

Deletion is permanent

Removing an app from Release Management deletes all associated releases, artifacts, and configuration. This cannot be undone.

curl -X DELETE "https://api.bitrise.io/release-management/v2/apps/v1/APP_ID" \
  -H "Authorization: YOUR_ACCESS_TOKEN"