Runway REST API (1.0.0)

Returns the details of an organization.

Returns a paginated list of apps in the organization.

Returns aggregated metrics for the organization over the given date range. Optionally restrict the response to specific metric types or include the underlying time-series data points.

Returns the details of an app.

Returns the app's release schedule cadence — how often releases happen (weekly / biweekly / monthly / etc.), the target kickoff/submit/release day-and-time pattern, timezone, and skip-next-submit/release flags.

Returns the app's configured lifecycle freeze periods. Lifecycle freezes pause selected release lifecycle events (kickoff, submit, release) during the configured date ranges without changing the recurring schedule cadence.

Replaces only the app's lifecycle freeze periods. This does not change the app's release schedule cadence, but it may move release target dates that fall inside a freeze. Requires the API key to have the UpdateScheduleCadence user action.

Returns each release's target dates (kickoff, submit, release, rollout completion), status, and release pilot. Includes cadence-predicted future releases (status predicted) whose dates and pilot are estimates derived from the app's schedule and pilot rotation and are subject to change. Omit version for the full schedule (past, current, and predicted future releases); pass it to get a single release. Only available for apps using Runway workflows.

Returns the customer reviews Runway currently holds for an app, newest first, across every store the app ships to (Apple App Store via App Store Connect, Google Play, Amazon Appstore, Huawei AppGallery, Samsung Galaxy Store). Each review carries the destination it came from, so reviews from different stores can be told apart.

These are reviews left by end users in the app stores — not Apple's or Google's review of a submitted build.

Runway holds the most recent window of reviews returned by each store rather than a full historical archive, so a caller building its own archive should poll often enough that the window always covers the gap since its last poll. submittedAfter and submittedBefore are both inclusive: a review submitted exactly at the boundary is returned. Reviews are uniquely identified by id — dedupe on it when polling incrementally.

Turns a scheduled release automation on or off without changing its settings. Requires the API key to have the EditAutomations user action.

Upload and set the app icon. For teams using config-as-code who don't have their app icons hosted publicly, this endpoint allows uploading an icon file directly. The icon will be stored and the URL can be used in the icon field of your app config YAML. Accepts multipart/form-data with a PNG or JPEG image (max 10MB).

Returns the list of integrations installed on the given app. Use the returned installationId for other endpoints that act on a specific integration (e.g. uploading a Custom CI build).

Returns a paginated list of apps in the organization.

Accepts the same YAML schema as createAppFromConfig, but instead of creating a new app, adds a new destination to the given app's existing workflow. The YAML's name/icon become the destination's name and icon; integrations are installed as new app integrations from existing org providers; appSettings.branchSettings are stored as a per-destination branch config; stepGroups are cloned into the workflow as new step configs. Other fields (appGroup, appUsers, appStoreReleaseSettings, buildDistro, tagSettings, featureAffiliations) are ignored.

Upload attachment files (e.g., screenshots, notes) for App Store Connect review submission. Accepts multipart/form-data with the file to upload.

Pause or resume automations for an app using a single endpoint. Set enabled to false to pause and true to resume. Omit automationIds to pause or resume all automations; provide one or more automationIds to affect only those types.

Rotates auth credentials for an App Store Connect (Apple) or Google integration provider. Request body must be sent as multipart/form-data.

Apple (App Store Connect) — provide keyId, issuerId, and the .p8 key file. All installations in the org that share the existing provider will automatically pick up the new credentials.

curl -X POST \
    -F "keyId=ABCD1234" \
    -F "issuerId=12345678-1234-1234-1234-123456789012" \
    -F "key=@AuthKey_ABCD1234.p8" \
    -H "X-API-KEY:API-KEY" \
    https://api.runway.team/v1/app/{appId}/integration/{integrationInstallationId}/updateAuth

Google — provide only the .json service account key file. keyId and issuerId must not be sent. The provider row is updated in place to reference the new key file; all installations sharing that provider automatically pick up the new credentials.

curl -X POST \
    -F "key=@service-account.json" \
    -H "X-API-KEY:API-KEY" \
    https://api.runway.team/v1/app/{appId}/integration/{integrationInstallationId}/updateAuth

Please note the unique upload server URL for this endpoint.

The binary file must be included in a 'file' field as form data. Please see below for an example curl request:

curl -X POST \
    -F "file=@example.ipa" \
    -F 'data={\"version\":\"1.2.3\",\"ciBuildInfo\":{\"buildIdentifier\":\"123\",\"status\":\"inProgress\",\"startedAt\":\"2022-03-02T01:15:00Z\",\"branch\":\"release-1.2.3\",\"commitHash\":\"abcdef\",\"integrationId\":\"custom-ci\",\"workflowData\":{\"workflowId\":\"123\"}}}}'  \
    -H "X-API-KEY:API-KEY" \
    https://upload-api.runway.team/v1/app/{appId}/integration/{integrationInstallationId}/build

Lists builds uploaded to a Custom CI (Mobile Release Management / MRM) integration for a specific release. Use this to discover the buildHash for a build (e.g. to download its artifact). Only supported for integrations of type customCI — for other CI providers (Bitrise, CircleCI, etc.) builds are fetched directly from the provider and are not listed here. Results are sorted newest first.

Please note the unique upload server URL for this endpoint.

The additional file must be included in a 'file' field as form data, and the build version must be passed in the data field. Please see below for an example curl request:

curl -X POST \
    -F "file=@test_results.html" \
    -F 'data={"version":"1.2.3"}'  \
    -H "X-API-KEY:API-KEY" \
    https://upload-api.runway.team/v1/app/{appId}/integration/{integrationInstallationId}/build/{buildId}/additionalFiles

Redirects to a short-lived signed URL for the primary artifact stored for this Custom CI build. Use GET .../additionalFiles/{filename} for a supplemental file. Requires version to identify the release.

Redirects to a short-lived signed URL for a supplemental artifact on this Custom CI build. Same version query as the primary download.

Returns the app's configured fix request form field settings, including each field's id, name, whether it is required, and any minimum character count. Use the returned fieldIds to build the formFieldsValues when creating a fix request.

Returns each release's target dates (kickoff, submit, release, rollout completion), status, and release pilot. Includes cadence-predicted future releases (status predicted) whose dates and pilot are estimates derived from the app's schedule and pilot rotation and are subject to change. Omit version for the full schedule (past, current, and predicted future releases); pass it to get a single release. Only available for apps using Runway workflows.