Skip to content
Changelog

Report a bug

Appcircle integration: operations for AI agents

Appcircle connects to Type.com as an integration. This page lists the 298 operations documented for Claude and Codex in Type.com: 130 read, 112 write, 56 destructive.

About Appcircle

Appcircle is an enterprise-grade mobile CI/CD platform that enables developers to build, test, and publish mobile applications efficiently, offering both cloud-based and self-hosted deployment options.

Categories: Developer Tools & IT

How to connect Appcircle to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

298 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

298 operations listed.

Auth

  • Read

    Get Access Token

    Retrieve an access token using your personal access token (PAT). This token can be used for authentication in subsequent API requests.

  • Read

    Get Access Token with Scope and Sub-Organization ID

    Retrieve an access token with specific scopes and for a sub-organization using your personal access token (PAT). This token can be used for authentication in subsequent API requests.

  • Read

    Get Access Token with Scope and Sub-Organization ID

    Retrieve an access token with specific scopes and for a sub-organization using your personal access key. This token can be used for authentication in subsequent API requests.

  • Read

    Retrieve Access Token for In-App Update

    Retrieve an access token using the provided organization ID, profile ID, and secret. This token is required to authenticate subsequent store download requests for in-app updates.

  • Read

    Retrieve Access Token for API Key

    Retrieve an access token using the provided API key name and secret. This token is required to authenticate Appcircle API requests.

Commits (v2)

  • Read

    Gets all commits by branchId

    GET /v2/commits

  • Read

    Get commit details by commit hash

    GET /v2/commits/{commitHash}

  • Read

    Gets last commit by branchId

    GET /v2/commits/last-commit

  • Read

    Gets detail of commit by CommitId

    GET /v2/commits/{commitId}

  • Read

    Download build artifacts of build

    GET /v2/commits/{commitId}/builds/{buildId}

  • Read

    Download build log

    GET /v2/commits/{commitId}/builds/{buildId}/logs

  • Read

    Gets build status

    GET /v2/commits/{commitId}/builds/{buildId}/status

  • Write

    Start new build for given profile, workflow, config setting and commit hash

    POST /v2/commits/{commitHash}

  • Write

    (Deprecated - V3 is Recommanded) Start new build manually

    POST /v2/commits/{commitId}#1

  • Write

    (Deprecated - V3 is Recommanded) Start new build manually with specified workflow

    POST /v2/commits/{commitId}#2

  • Destructive

    (Deprecated - V3 is Recommanded) Start new build manually with specified workflow and environments

    PUT /v2/commits/{commitId}

Commits (v3)

  • Write

    Start new build manually (uses last used or default workflow)

    v3 replacement for POST /api/v2/commits/{commitId}?purpose=1 — action moved to path segment.

  • Write

    Start new build manually with specified workflow

    v3 replacement for POST /api/v2/commits/{commitId}?workflowId={workflowId} — action moved to path segment.

  • Destructive

    Start new build manually with specified workflow and environments

    PUT /v3/commits/{commitId}/build/by-workflow/with-environment

Connections (v1)

  • Read

    GET /v1/connection

    GET /v1/connection

  • Read

    GET /v1/connection/{connectionId}

    GET /v1/connection/{connectionId}

  • Read

    GET /v1/connection/{connectionId}/related-profiles

    GET /v1/connection/{connectionId}/related-profiles

  • Read

    GET /v1/connection/{connectionId}/connections-has-same-instance

    GET /v1/connection/{connectionId}/connections-has-same-instance

  • Write

    POST /v1/connection/pat/test

    POST /v1/connection/pat/test

  • Write

    (Deprecated - V3 is Recommanded)

    POST /v1/connection/{connectionId}/oauth#1

  • Write

    (Deprecated - V3 is Recommanded)

    POST /v1/connection/{connectionId}/oauth#2

  • Write

    PATCH /v1/connection/{connectionId}/pat

    PATCH /v1/connection/{connectionId}/pat

  • Destructive

    DELETE /v1/connection/{connectionId}/oauth

    DELETE /v1/connection/{connectionId}/oauth

  • Destructive

    DELETE /v1/connection/{connectionId}/pat

    DELETE /v1/connection/{connectionId}/pat

Connections (v3)

  • Write

    Reconnect an OAuth connection

    v3 replacement for POST /api/v1/connection/{connectionId}/oauth?action=reconnect — action moved to path segment.

  • Destructive

    Revoke an OAuth connection

    v3 replacement for POST /api/v1/connection/{connectionId}/oauth?action=revoke — action moved to path segment.

Profiles

  • Read

    Gets all store profile filter and sorting values

    GET /v2/profiles/filters

  • Read

    Gets all enterprise store profile list of current organization

    GET /v2/profiles

  • Read

    Gets enterprise store profile detail for given profileId; app versions are embedded only when addAppVersions=true

    GET /v2/profiles/{profileId}

  • Read

    get details of an app version

    GET /v2/profiles/{profileId}/app-versions/{appVersionId}

  • Read

    Gets enterprise store app version list for given profileId of current organization

    GET /v2/profiles/{profileId}/app-versions

  • Read

    Gets enterprise store app version list for given profileId and publish type of current organization

    GET /v2/profiles/{profileId}/app-versions/publish-types/{publishtype}

  • Write

    Uploads new app version to an enterprise store profile

    POST /v2/profiles/{profileId}/app-versions

  • Write

    Uploads new app version to an enterprise store profile by unique name or if profile doesn't exits creates new enterpris…

    Uploads new app version to an enterprise store profile by unique name or if profile doesn't exits creates new enterprise store profile

  • Write

    publishs an app version to given channel on enterprise store

    PATCH /v2/profiles/{profileId}/app-versions/{appVersionId}/publish

  • Write

    unpublishs an app version from enterprise store

    PATCH /v2/profiles/{profileId}/app-versions/{appVersionId}/unpublish

  • Write

    Publishes an app version to the Public (Live) channel of the enterprise store.

    PATCH /v2/profiles/{profileId}/app-versions/{appVersionId}/publish-to-public

  • Write

    Publishes an app version to the Beta channel of the enterprise store.

    PATCH /v2/profiles/{profileId}/app-versions/{appVersionId}/publish-to-beta

  • Write

    Unpublishes an app version from the Public (Live) channel of the enterprise store.

    PATCH /v2/profiles/{profileId}/app-versions/{appVersionId}/unpublish-from-public

  • Write

    Unpublishes an app version from the Beta channel of the enterprise store.

    PATCH /v2/profiles/{profileId}/app-versions/{appVersionId}/unpublish-from-beta

  • Destructive

    removes an appversion from enterprise store

    DELETE /v2/profiles/{profileId}/app-versions/{appVersionId}

Profiles (v2)

  • Read

    Get configurations of a profile

    GET /v2/profiles/{profileId}/configurations

  • Read

    Get details of a specific configuration of a profile

    GET /v2/profiles/{profileId}/configurations/{configurationId}

  • Read

    Download a specific configuration of a profile

    GET /v2/profiles/{profileId}/configurations/{configurationId}/content

  • Read

    Get workflows of build profile

    GET /v2/profiles/{profileId}/workflows

  • Read

    Get a single workflow definition

    Returns the workflow definition (steps and metadata) for the given workflowId on the build profile.

  • Read

    Get the default workflow set for a build profile

    Returns Appcircle's default workflow templates (push, pull request, tag, etc.) suggested for the given build profile.

  • Read

    Gets app-versions of a profile for given params

    GET /v2/profiles/{profileId}/app-versions

  • Read

    Get download link for an app version, which is uploaded or distributed by the build module.

    Doesn't directly download, instead returns a temporary link to download, link must be followed in order to download the app

  • Read

    Gets QRCode of public profile link

    GET /v2/profiles/{profileId}/qr-code

  • Write

    Updates distribute profile detail by profileId

    PATCH /v2/profiles/{profileId}

  • Write

    (Deprecated - V3 is Recommanded) Bind a repository for a profile

    POST /v2/profiles/{profileId}#1

  • Write

    (Deprecated - V3 is Recommanded) Bind a public repository for a profile

    POST /v2/profiles/{profileId}#2

  • Write

    (Deprecated - V3 is Recommanded) Bind a ssh repository for a profile

    POST /v2/profiles/{profileId}#3

  • Write

    (Deprecated - V3 is Recommanded) Update a public repository for a profile

    POST /v2/profiles/{profileId}#4

  • Write

    (Deprecated - V3 is Recommanded) Update a ssh repository of a profile

    POST /v2/profiles/{profileId}#5

  • Write

    Update a profile's trigger settings

    Update a profile's trigger settings

  • Write

    Create new build configuration for a profile

    POST /v2/profiles/{profileId}/configurations

  • Write

    Rename a configuration of a profile

    PATCH /v2/profiles/{profileId}/configurations/{configurationId}

  • Write

    Upload a configuration for a profile in yaml format

    POST /v2/profiles/{profileId}/configurations/content

  • Write

    Create a new workflow for a build profile

    Creates a new workflow definition on the given build profile. The payload is the full workflow definition (steps and metadata).

  • Write

    Update an existing workflow of a build profile

    Updates an existing workflow definition on the given build profile. The payload is the full workflow definition (steps and metadata).

  • Write

    Creates distribute profile

    POST /v2/profiles

  • Write

    (Deprecated, use V3) Sends App Version to tester/testers by using their Ids

    POST /v2/profiles/{profileId}/app-versions/{appVersionId}

  • Write

    (Deprecated, use V3) Updates detail of the App version, which is uploaded or distributed by the build module.

    PATCH /v2/profiles/{profileId}/app-versions/{appVersionId}#1

  • Write

    (Deprecated, use V3) Updates the message for the App version to be sent to the tester.

    PATCH /v2/profiles/{profileId}/app-versions/{appVersionId}#2

  • Destructive

    Removes distribute profile detail by profileId

    DELETE /v2/profiles/{profileId}

  • Destructive

    Update a build configuration

    PUT /v2/profiles/{profileId}/configurations

  • Destructive

    Delete a configuration of a profile

    DELETE /v2/profiles/{profileId}/configurations/{configurationId}

  • Destructive

    Start new build for given profileId and branchId with specified workflow and environment variables in payload

    Payload example represents environment variables array (key-value) which will be used during the build process.

  • Destructive

    Start new build for given profileId and branch name with specified workflow and environment variables in payload

    Payload example represents environment variables array (key-value) which will be used during the build process.

  • Destructive

    Removes the App versions by Ids, which is uploaded or distributed by the build module.

    DELETE /v2/profiles/{profileId}/app-versions

  • Destructive

    (Deprecated, use V3) Removes the App version by Id, which is uploaded or distributed by the build module.

    DELETE /v2/profiles/{profileId}/app-versions/{appVersionId}#1

  • Destructive

    (Deprecated, use V3) Removes testers from App Version

    DELETE /v2/profiles/{profileId}/app-versions/{appVersionId}#2

Profiles (v3)

  • Read

    Gets profile detail by Id

    v3 replacement for GET /api/v2/profiles/{profileId} (default).

  • Read

    Get available authorization URL for a profile

    v3 replacement for GET /api/v2/profiles/{profileId}?action=getAuthorizeUrl.

  • Read

    Get repositories for a profile

    v3 replacement for GET /api/v2/profiles/{profileId}?action=getRepositories.

  • Read

    Download a workflow as a YAML file

    Returns the workflow definition as a downloadable .yaml file so it can be edited locally and re-uploaded.

  • Write

    Bind a repository for a profile

    v3 replacement for POST /api/v2/profiles/{profileId}?action=bindRepository.

  • Write

    Bind a public repository for a profile

    v3 replacement for POST /api/v2/profiles/{profileId}?action=bindPublicRepository.

  • Write

    Bind an SSH repository for a profile

    v3 replacement for POST /api/v2/profiles/{profileId}?action=bindSshRepository.

  • Write

    Update a public repository for a profile

    v3 replacement for POST /api/v2/profiles/{profileId}?action=updatePublicRepository.

  • Write

    Update an SSH repository of a profile

    v3 replacement for POST /api/v2/profiles/{profileId}?action=updateSshRepository.

  • Write

    Update a workflow by uploading a YAML file

    Replaces the workflow definition with the uploaded YAML. The file is validated (component existence, step names, YAML format) before saving.

  • Write

    Updates detail of the App version

    v3 replacement for PATCH /api/v2/profiles/{profileId}/app-versions/{appVersionId} (default).

  • Write

    Updates the message for the App version

    v3 replacement for PATCH /api/v2/profiles/{profileId}/app-versions/{appVersionId}?action=updateMessage.

  • Write

    Marks/Unmarks an app version as Release Candidate

    v3 replacement for PATCH .../app-versions/{appversionId}?action=releaseCandidate.

  • Write

    Cancels a review submission for statuses WAITINGFORREVIEW, IN-REVIEW on App Store Connect

    v3 replacement for PATCH .../app-versions/{appversionId}?action=cancelReview.

  • Write

    Rejects an app version, mark as rejected

    v3 replacement for PATCH .../app-versions/{appversionId}?action=reject.

  • Write

    Updates app version's release notes

    v3 replacement for PATCH .../app-versions/{appversionId}?action=releaseNotes.

  • Destructive

    Removes the App version by Id

    v3 replacement for DELETE /api/v2/profiles/{profileId}/app-versions/{appVersionId} (default).

  • Destructive

    Removes testers from App Version

    v3 replacement for DELETE /api/v2/profiles/{profileId}/app-versions/{appVersionId}?action=removeTestings.

Queue (v1)

  • Read

    Gets queue item by commitId

    GET /v1/queue/{commitId}/builds/{buildId}

  • Read

    (Deprecated use V3) Gets queue item by taskId

    GET /v1/queue/{taskId}#1

  • Read

    Gets dashboard log by taskId

    GET /v1/queue/logs/{taskId}

  • Read

    (Deprecated use V3) Cancels queue by taskId

    GET /v1/queue/{taskId}#2

  • Write

    Dequeue by given payload

    POST /v1/queue/dequeue

Queue (v3)

  • Read

    Gets queue item by taskId

    v3 replacement for GET /api/v1/queue/{taskId} (default). Same payload, unique path.

  • Write

    Cancels queue by taskId

    v3 replacement for GET /api/v1/queue/{taskId}?action=cancel — action moved to a path segment and the verb changed to POST, since a cancel is a state-changing operation.

Variable Groups

  • Read

    Gets all variable groups

    GET /v2/variable-groups

  • Read

    Get environment variables by group Id

    GET /v2/variable-groups/{variableGroupId}/variables

  • Read

    Get environment variable group details by group Id

    GET /v2/variable-groups/{variableGroupId}

  • Write

    Creates new environment group

    POST /v2/variable-groups

  • Write

    Renames environment group

    PATCH /v2/variable-groups/{variableGroupId}

  • Write

    Add new environment variables by group Id

    POST /v2/variable-groups/{variableGroupId}/variables

  • Write

    Update non-secret environment variable values by group Id

    PATCH /v2/variable-groups/{variableGroupId}/variables

  • Write

    Add new file based environment variables by group Id

    POST /v2/variable-groups/{variableGroupId}/variables/files

  • Write

    Update file type environment variable values by group Id

    PATCH /v2/variable-groups/{variableGroupId}/variables/files

  • Destructive

    Deletes environment group

    DELETE /v2/variable-groups/{variableGroupId}

  • Destructive

    Remove exist environment variable/variables from exist group.

    DELETE /v2/variable-groups/{variableGroupId}/variables

Testing Groups (v2)

  • Read

    Gets all testing group list of current organization

    GET /v2/testing-groups

  • Read

    Gets testing group detail by Id

    GET /v2/testing-groups/{groupId}

  • Read

    Gets all testers of current organization

    GET /v2/testing-groups/testers

  • Read

    Exports testers of the specified test group to a CSV file.

    GET /v2/testing-groups/{groupId}/testers

  • Write

    Creates new testing group

    POST /v2/testing-groups

  • Write

    (Deprecated, use V3) Adds new tester/testers to test group which is created before.

    POST /v2/testing-groups/{groupId}/testers#1

  • Write

    (Deprecated, use V3) Adds new tester/testers to test group from a CSV file containing email addresses.

    POST /v2/testing-groups/{groupId}/testers#2

  • Destructive

    Removes testing group by Id

    DELETE /v2/testing-groups/{groupId}

  • Destructive

    Removes testers from all groups

    DELETE /v2/testing-groups/testers

  • Destructive

    Removes tester/testers from test group.

    DELETE /v2/testing-groups/{groupId}/testers

Testing Groups (v3)

  • Write

    Adds new tester/testers to test group which is created before.

    v3 replacement for POST /api/v2/testing-groups/{groupId}/testers (default).

  • Write

    Adds new tester/testers to test group from a CSV file containing email addresses.

    v3 replacement for POST /api/v2/testing-groups/{groupId}/testers?action=importFromCsv.

App Store Connect

  • Read

    Get all Appstore Connect api key definitions

    GET /v2/apple-store-connect-api/saved-settings

  • Read

    Get all Appstore Connect certificates for provided credential

    GET /v2/apple-store-connect-api/{storeCredentialId}/certificates

  • Read

    Get all Appstore Connect devices for provided credential

    GET /v2/apple-store-connect-api/{storeCredentialId}/devices

  • Read

    Get details of a certificate from Appstore Connect for provided credential and certificate Id

    GET /v2/apple-store-connect-api/{storeCredentialId}/certificates/{id}

  • Read

    Get bundles from Appstore Connect for provided credential

    GET /v2/apple-store-connect-api/{storeCredentialId}/bundles

  • Read

    Get details of a bundle from Appstore Connect for provided credential and bundle Id

    GET /v2/apple-store-connect-api/{storeCredentialId}/bundles/{id}

  • Read

    Get list of provisioning profiles from Appstore Connect for provided credential

    GET /v2/apple-store-connect-api/{storeCredentialId}/profiles

  • Read

    Get details of a provisioning profile from Appstore Connect for provided credential and provisinging profile Id

    GET /v2/apple-store-connect-api/{storeCredentialId}/profiles/{id}

  • Read

    Check eligibility status of devices against Apple for provided credential

    POST /v2/apple-store-connect-api/credentials/{storeCredentialId}/check-devices

  • Destructive

    Delete a certificate from Appstore Connect for provided credential by certificate Id

    DELETE /v2/apple-store-connect-api/{storeCredentialId}/certificates/{id}

Bundle Identifiers

  • Read

    Lists bundle identifiers in Appcircle

    GET /v2/bundle-identifier

  • Read

    Lists editable capability types

    GET /v2/bundle-identifier/capability-types

  • Read

    Get bundle identifiers in Appcircle

    GET /v2/bundle-identifier/{id}

  • Write

    Fetches bundle identifier from appstore and create in appcircle

    POST /v2/bundle-identifier/{appStoreBundleIdentifierId}/create-from-app-store/{storeCredentialId}

  • Write

    Creates bundle identifier in appcircle and appstore

    POST /v2/bundle-identifier

  • Destructive

    Updates bundle identifier and its capabilities in appcircle and applies changes in appstore

    PUT /v2/bundle-identifier

  • Destructive

    Deletes bundle identifier with given id

    DELETE /v2/bundle-identifier/{id}

Bundle Identifier

  • Write

    POST /v1/bundle-identifier/{appStoreBundleIdentifierId}/create-from-app-store/{storeCredentialId}

    POST /v1/bundle-identifier/{appStoreBundleIdentifierId}/create-from-app-store/{storeCredentialId}

  • Write

    POST /v1/bundle-identifier/create-from-app-store/{storeCredentialId}

    POST /v1/bundle-identifier/create-from-app-store/{storeCredentialId}

Certificates

  • Read

    Get list of uploaded/installed certificates

    GET /v2/certificates

  • Read

    Get details of a certificate

    GET /v2/certificates/{id}

  • Write

    Create a P12 certificate

    POST /v2/certificates

  • Destructive

    Delete a certificate

    DELETE /v2/certificates/{certificateId}

Keystores

  • Read

    Get list of all installed/uploaded keystores

    GET /v2/keystores

  • Read

    Get details of a keystore

    GET /v2/keystores/{id}

  • Write

    Create/Generate a keystore

    POST /v2/keystores

  • Write

    Create a keystore by uploading binary

    POST /v2/keystores/binary

  • Destructive

    Update a keystore friendly name

    PUT /v2/keystores/{keystoreId}

  • Destructive

    Delete a keystore

    DELETE /v2/keystores/{keystoreId}

Provisioning Profiles

  • Read

    Get list of all installed/uploaded provisioning profiles

    GET /v2/provisioning-profiles

  • Read

    Get details of a provisioning profile

    GET /v2/provisioning-profiles/{id}

  • Write

    Create a provisioning profile

    POST /v2/provisioning-profiles

  • Write

    Create a provisioning profile in Appstore and save into Appcircle with given bundle, certificate and devices

    POST /v2/provisioning-profiles/create-apple-provisioning-profile-and-save

  • Write

    Create a provisioning profile in Appstore and save into Appcircle with given bundle, certificate and devices

    POST /v2/provisioning-profiles/renew-apple-provisioning-profile

  • Destructive

    Get details of a provisioning profile

    DELETE /v2/provisioning-profiles

Artifact Retention

  • Read

    Gets the artifact retention settings

    Returns the current retention configuration for the caller's organization — how long build, distribution and publish artifacts are kept, plus the build-module artifact include/exclude lists.

  • Destructive

    Updates the artifact retention settings

    Persists a new retention configuration for the caller's organization. Validates that build-module artifact include/exclude lists are not blank, do not overlap and do not exclude all artifact types.

License

  • Read

    Gets the current license, its limits and current usage

    Returns the active license tier for the caller's organization along with the per-module limit and current consumption (e.g. concurrent builds, distribution app versions, store submissions).

Organizations

  • Read

    Retrieve the user's organizations

    Retrieves a paginated list of the user's organizations

Credentials

  • Read

    Get list of all credentials for Google Play, Appstore Connect, Intune or Huawei App Gallery

    Credentials are defined in Integrations module by uploading api keys

  • Read

    Get list of Google Play connections

    Credentials are defined in Integrations module by uploading api keys

  • Read

    Get list of Huawei App Gallery credentials

    Credentials are defined in Integrations module by uploading api keys

  • Read

    Get list of Intune credentials

    Credentials are defined in Integrations module by entering client keys

  • Read

    Get list of Appstore Connect connections

    GET /v2/credential/apple-store-connect-api/saved-settings

  • Read

    Get list of app specific Appstore Connect connections

    GET /v2/credential/apple-app-specific-password/saved-settings

  • Write

    Create a Google Play connection by uploading api key file

    POST /v2/credential/playstore/save-settings

  • Write

    Create a Huawei connection by uploading api key file

    POST /v2/credential/appgallery/save-settings

  • Write

    Create a Intune connection by providing clientId and secret

    POST /v2/credential/intune/save-settings

  • Write

    Create Appstore Connect connection by uploading api key

    POST /v2/credential/apple-store-connect-api/save-settings

  • Write

    Create an app specific Appstore Connect connection

    POST /v2/credential/apple-app-specific-password/save-settings

  • Destructive

    Delete a Google Play credential

    DELETE /v2/credential/playstore/{storeCredentialId}

  • Destructive

    Rename a Google Play credential

    Changes the credential's display name only

  • Destructive

    Share a Google Play credential

    Changes the credential's sub-organization sharing only

  • Destructive

    Delete a Huawei App Gallery credential

    DELETE /v2/credential/appgallery/{storeCredentialId}

  • Destructive

    Rename a Huawei App Gallery credential

    Changes the credential's display name only

  • Destructive

    Share a Huawei App Gallery credential

    Changes the credential's sub-organization sharing only

  • Destructive

    Delete a Intune credential

    DELETE /v2/credential/intune/{storeCredentialId}

  • Destructive

    Rename a Intune credential

    Changes the credential's display name only

  • Destructive

    Share a Intune credential

    Changes the credential's sub-organization sharing only

  • Destructive

    Delete an Appstore Connect connection

    DELETE /v2/credential/apple-store-connect-api/{storeCredentialId}

  • Destructive

    Rename an Appstore Connect connection

    Changes the credential's display name only

  • Destructive

    Share an Appstore Connect connection

    Changes the credential's sub-organization sharing only

  • Destructive

    Delete an app specific Appstore Connect connections

    DELETE /v2/credential/apple-app-specific-password/{storeCredentialId}

Build History

  • Read

    Retrieves build reports with detailed usage metrics

    Fetches a paginated or exported report on build usage, filtered by date range, build profile name, and organization ID. This endpoint supports advanced filtering, sorting, and pagination for efficient report generation.

Build Signing

  • Read

    Retrieves the daily usage report for signing operations.

    Fetches a paginated report of daily signing usage data filtered by date range, build profile name, platform type, and organization ID. Supports sorting and provides metadata for pagination and summary information.

  • Read

    Retrieve Signing Identity Activity Report

    Fetches a detailed report of signing identity activities within a specified date range. Allows filtering by organization name, email, keystore/provision name, platform, action type, and organization ID. Supports pagination with customizable page number and size constraints.

Publish Reports

  • Read

    Retrieve the publish activity report

    Fetches a detailed report on publishing activities within a specified date range. The report can be filtered by organization name, user email, profile name, platform, action type, and organization ID. Pagination is supported with configurable page size and sorting options.

  • Read

    List profile names for the publish activity filter

    Returns the distinct profile names that have publish activity entries in the given date range. Optional purpose=publishing|resigning narrows the list to the relevant action types. Intended to populate the profile-name filter on the Publish Activity report.

  • Read

    Retrieve the publish status report

    Fetches publish executions within a given date range with rich filters: organization name, profile name, app unique id / app name, status, trigger, marketplace, platform, version, version code, duration. Pagination is supported with configurable page size and sort options.

  • Read

    List profile names for the publish status filter

    Returns the distinct profile names that have publish status entries in the given date range, optionally scoped to a specific sub-organization. Intended to populate the profile-name filter on the Publish Status report.

  • Read

    List app names for the publish status filter

    Returns the distinct app names that have publish status entries in the given date range, optionally scoped to a specific sub-organization. Intended to populate the app-name filter on the Publish Status report.

  • Read

    Retrieve the publish re-sign report

    Fetches publish-side re-sign executions within a given date range with filters: organization name, profile name, source app unique id, status, trigger, platform, target app name, duration. Pagination is supported with configurable page size and sort options.

  • Read

    List profile names for the publish re-sign filter

    Returns the distinct profile names that have publish re-sign entries in the given date range, optionally scoped to a specific sub-organization. Intended to populate the profile-name filter on the Publish Re-sign report.

  • Read

    List source binaries for the publish re-sign filter

    Returns the distinct source binary identifiers (app unique id / version pairs) that appear as the source of publish re-sign entries in the given date range. Intended to populate the source-binary filter on the Publish Re-sign report.

Testing Distribution App Versions

  • Read

    Generates a daily usage report for distributed app versions.

    Retrieves a detailed report of app versions distributed within a specified date range, filtering by profile name and platform. The report supports pagination and optional export to CSV format.

Testing Distribution Sharing Reports

  • Read

    Retrieve the daily usage report for distributed app sharing.

    Fetches a report detailing app distribution activities over a specified date range, filtered by profile name, platform type, organization ID, sent by, version, and trigger type. Supports pagination and optional CSV export for comprehensive data analysis.

  • Read

    Get distinct profile names for App Sharing Report filter.

    Retrieves a list of unique profile names available for filtering in App Sharing reports within a specified date range. Root organization users can see all profiles, while sub-organization users can only see their own organization's profiles.

Task

  • Read

    Gets status of TaskId.

    GET /v1/tasks/{id}

Enterprise Store Reports

  • Read

    Gets app usage report

    Retrieves the application usage report based on the specified pagination, date range, profile ID, group limit, export option, and organization ID. This endpoint allows users to filter the report by providing a starting and ending date.

  • Read

    Gets download report by user

    Retrieves user download metadata based on various filtering options, including username, profile ID, organization ID, and date range. The request allows pagination through the use of the PaginationRequest parameter, enabling clients to retrieve results in manageable chunks.

Webhook

  • Read

    Gets all webhook scopes/modules

    GET /v2/webhooks/modules

  • Read

    Gets webhooks

    GET /v2/webhooks

  • Read

    Get details of a webhook

    GET /v2/webhooks/{Id}

  • Read

    Get webhooks's delivery history

    GET /v2/webhooks/history

  • Read

    Get a webhook's delivery history

    GET /v2/webhooks/history/{webhookId}

  • Write

    Create a webhook

    POST /v2/webhooks

  • Write

    Update a webhook

    PATCH /v2/webhooks/{Id}

  • Destructive

    Delete a webhook

    DELETE /v2/webhooks/{Id}

App Information

  • Read

    Gets App Info categories from App Store Connect

    App Store Connect credentials must be selected on Profile Settings to perform

  • Read

    Gets App Info from App Store Connect, saves it locally if there are any changes

    App Store Connect credentials must be selected on Profile Settings to perform

  • Write

    Updates App Info on App Store Connect and Appcircle

    App Store Connect credentials must be selected on Profile Settings to perform

App Store Beta App Info

  • Read

    Gets beta (TestFlight) app information for a profile

    Fetches the latest beta app review details and localizations, syncing them with App Store Connect when changed.

  • Read

    Gets beta submission details for an app version

    Returns the current beta submission state for the given app version on App Store Connect.

  • Read

    Gets supported locales for beta app information

    Returns the localised country list available for the profile's beta app information, marking the primary and already-localised entries.

  • Write

    Updates beta (TestFlight) app information

    Persists beta app review details and localizations on Appcircle and pushes them to App Store Connect.

  • Write

    Submits an app version for beta testing

    Sends an app version into the App Store Connect beta review queue with the provided submission details.

App Store Release Information

  • Read

    Gets App Store release information for an app version

    Returns the saved iOS release information (release notes, what's new, localised release metadata) for the given app version. Only iOS is supported.

  • Write

    Saves App Store release information for an app version

    Persists iOS release information (release notes, what's new, localised release metadata) for the given app version. Only iOS is supported.

Appstore Connect Metadata

  • Read

    Get saved/imported metadata on Appcircle

    It will not retrieve from App Store Connect, use importFromStore feature to do

  • Read

    Gets metadata language list for app version profile

    Appstore Connect Credentials nust be selected on profile settings

  • Read

    Gets metadata language list for app version of profile

    Appstore Connect Credentials nust be selected on profile settings

  • Read

    Get saved/imported metadata screenshots on Appcircle

    It will not retrieve from App Store Connect, use importFromStore feature to do

  • Write

    Updates app version's metadata on Appcircle

    Doesn't update on App Store Connect directly, use component to do

  • Write

    Adds metadata screenshots to Appcircle

    It will not send to App Store Connect directly, use component to update on App Store Connect

  • Write

    Changes orders of screenshots

    It will only change passed metadafile's order in payload

  • Destructive

    (Deprecated use V3) Retrieves and imports metadata and screenshoots from App Store Connect

    Remove from end of the path in order to perform, Appstore Connect Credentials nust be selected on profile settings

  • Destructive

    (Deprecated use V3) Clones sourceAppVersionId's metadata and screenshots to appversion

    Remove from end of the path in order to perform. Clones internal saved/imported metada from sourceAppVersionId

  • Destructive

    Deletes multiple metadata screenshots from Appcircle

    It will not delete from App Store Connect directly, use component to apply on App Store Connect

  • Destructive

    Deletes metadata screenshot from Appcircle

    It will not delete from App Store Connect directly, use component to apply on App Store Connect

Google Play Console Metadata

  • Read

    Gets Play Store metadata for an app version

    Returns the locally-persisted Play Store metadata for the given app version, syncing app-level info from store when missing.

  • Read

    Gets Play Store metadata locales for an app version

    Returns the localised country list available for the given Play Store app version, marking primary and already-localised entries.

  • Read

    Lists Play Store metadata files for an app version

    Returns the screenshot and other metadata file assets attached to an app version, with optional pagination.

  • Write

    Updates Play Store metadata for an app version

    Persists Play Store metadata (localized texts) for an app version that has been marked as a Release Candidate.

  • Write

    Uploads Play Store metadata files (screenshots) for an app version

    Uploads new screenshot/metadata files for a Release Candidate app version. Maximum 8 files per screenshot display type per locale.

  • Write

    Reorders Play Store metadata files (screenshots)

    Updates the display order of the Play Store screenshot/metadata files for an app version that has been marked as a Release Candidate.

  • Destructive

    Imports Play Store metadata from store

    Pulls the current Play Store metadata for the given app version from Google Play. The app version must be a Release Candidate and the profile must have store credentials configured.

  • Destructive

    Clones Play Store metadata from another app version

    Clones the localised Play Store metadata from a source app version into the target app version.

  • Destructive

    Removes multiple Play Store metadata files

    Removes the supplied set of metadata files (or all of them when all=true) from the given app version.

  • Destructive

    Deletes a single Play Store metadata file

    Removes a screenshot or metadata file by id from the given app version.

Intune Metadata

  • Read

    Gets saved/imported Microsoft Intune Metadata from Appcircle

    Import feature can be used to retrieve Metadata from Microsoft Intune

  • Read

    Gets Microsoft Intune app categories

    Intune credentials must be selected on profile settings to perform

  • Read

    Gets app list from Microsoft Intune

    Intune credentials must be selected on profile settings to perform

  • Read

    Gets min supported OS versions for Micorosoft Intune

    Can be used on metadata updates in payload, filtered by profile's platform ios/android

  • Write

    Updates Microsoft Intune Metadata on Appcircle

    Doesn't update on Microsoft Intune, Intune credentials must be selected on profile settings to perform

  • Destructive

    Retrieves & Imports Microsoft Intune Metadata to Appcircle

    Intune credentials must be selected on profile settings to perform

Metadata (v3)

  • Destructive

    Retrieves and imports metadata and screenshoots from App Store Connect

    v3 replacement for PUT .../metadata?action=importFromStore.

  • Destructive

    Clones sourceAppVersionId's metadata and screenshots to appversion

    v3 replacement for PUT .../metadata?action=clone.

Play Store App Info

  • Read

    Gets Play Store app information for a profile

    Fetches the latest Play Store app metadata and localizations, syncing them with Google Play when changed.

  • Write

    Updates Play Store app information

    Persists Play Store app-level metadata (name, primary locale, contact details, auto-send review selection) on Appcircle and pushes the update to Google Play.

Play Store Rollout

  • Read

    Gets rollout tracks for an Android app version

    Returns the list of Play Store rollout tracks (e.g. internal, alpha, beta, production) available for the given Android app version.

  • Read

    Gets rollout info for a specific track

    Returns the current rollout state (status, user fraction, last updated) for the given track of an Android app version.

  • Write

    Updates rollout info for an Android app version

    Updates the rollout configuration (track, user fraction, release notes) for the given Android app version.

  • Write

    Updates rollout status (halt, resume, promote)

    Changes the rollout lifecycle status — typically halting or resuming a staged rollout, or promoting it to the next track.

Profile

  • Read

    Gets all publish profile filter and sorting values

    GET /v2/profiles/{platformType}/filters

  • Read

    Gets all publish profile list of current organization

    GET /v2/profiles/{platformType}

  • Read

    Gets publish profile detail for given profileId; app versions are embedded only when addAppVersions=true

    GET /v2/profiles/{platformType}/{profileId}

  • Read

    Gets Metadata locked status, Metadata updates are locked for ongoing/completed approval processes

    GET /v2/profiles/{platformType}/{profileId}/metadata/lock

  • Read

    Gets publish app version list for given profileId of current organization

    GET /v2/profiles/{platformType}/{profileId}/app-versions

  • Read

    get download link for an app version

    GET /v2/profiles/{platformType}/{profileId}/app-versions/{appVersionId}

  • Write

    Creates a publish profile

    POST /v2/profiles/{platformType}

  • Write

    Updates publish profile's settings

    PATCH /v2/profiles/{platformType}/{profileId}

  • Write

    Uploads new app version to an publish profile

    POST /v2/profiles/{platformType}/{profileId}/app-versions

  • Write

    (Deprecated use V3) Marks/Unmarks an app version as Release Candidate

    a RC version is required to start publish flow, please remove 1,2 like params end of the path

  • Write

    (Deprecated use V3) Cancels a review submission for statuses WAITINGFORREVIEW, IN-REVIEW on App Store Connect

    App Store Credentials must be selected on Profile Settings, please remove 1,2 like params end of the path

  • Write

    (Deprecated use V3) Rejects an app version, mark as rejected

    Can't perform any actions against rejected binaries apart from delete, please remove 1,2 like params end of the path

  • Write

    (Deprecated use V3) Updates app version's release notes

    shown in approval emails, binary details and test flight, please remove 1,2 like params end of the path

  • Write

    Start resign operation of an app version

    a profileId, appVersionId and resignRequest is required

  • Destructive

    Deletes a publish profile and its app versions & publishes

    DELETE /v2/profiles/{platformType}/{profileId}

  • Destructive

    removes an appversion from publish

    DELETE /v2/profiles/{platformType}/{profileId}/app-versions/{appVersionId}

Publish

  • Read

    Gets publish details for an app version

    GET /v2/profiles/{platformType}/{profileId}/app-versions/{appVersionId}/publish

  • Read

    Gets details of a publish by Id

    GET /v2/profiles/{platformType}/{profileId}/publish/{publishId}

  • Read

    Get execution logs for a publish step

    retrieve latest logs of steps as text

  • Read

    Get YAML definition of a publish

    returns a publish item as YAML

  • Write

    (Deprecated use V3) Stops a publish and all it's steps

    stops all steps and publish, periodic checks etc. Please remove 1,2 like params from the end of the path

  • Write

    (Deprecated use V3) Cancels a publish and all it's steps

    Cancels all steps and publish, periodic checks etc. Please remove 1,2 like params from the end of the path

  • Write

    (Deprecated use V3) Starts a publish, if stepId is specified starts from related step

    Start a step or publish. Please remove 1,2 like params from the end of the path

  • Write

    (Deprecated use V3) Restarts a publish with the latest flow changes

    Current publish and steps, logs will be archieved/replaced. Please remove 1,2 like params from the end of the path

Publish Flows

  • Read

    Downloads a publish flow as a YAML file

    Returns the flow definition as a downloadable .yaml file so it can be edited locally and re-uploaded.

  • Write

    Limited update of a publish flow's step details (starter accounts)

    v3 replacement for PATCH .../publishflows/{publishflowId}?action=details.

  • Write

    Updates default flow definition of a profile and all step details via YAML payload

    v3 replacement for PATCH .../publishflows/{publishflowId} (default).

  • Write

    Updates a publish flow by uploading a YAML file

    Replaces the flow definition with the uploaded YAML. The file is validated before saving. Existing publishes must be restarted to pick up the changes.

Publishes (v3)

  • Write

    Stops a publish and all its steps

    v3 replacement for POST .../publish/{publishId}?action=stop.

  • Write

    Cancels a publish and all its steps

    v3 replacement for POST .../publish/{publishId}?action=cancel.

  • Write

    Starts a publish, if stepId is specified starts from related step

    v3 replacement for POST .../publish/{publishId}?action=start.

  • Write

    Restarts a publish with the latest flow changes

    v3 replacement for POST .../publish/{publishId}?action=restart.

Publish Flow

  • Read

    Gets all publish flow definitions for a profile

    Currently only one item must return per profile, even if this is an array, multiple flows are not supported

  • Read

    Gets details of a flow definitions

    GET /v2/profiles/{platformType}/{profileId}/publishflows/{publishflowId}

  • Write

    (Deprecated use V3) Limited updates only for the starter accounts, Updates a step details in a flow, like enabling, dis…

    Doesn't support multiple step updates or chancing order, please remove 1,2 like params end of the path

  • Write

    (Deprecated use V3) Updates default flow definition of a profile and all step details via YAML payload

    Existing publishes must be restarted in order to get the latest flow changes, please remove 1,2 like params end of the path

  • Write

    Replaces default flow definition of a profile and all step details by uploading YAML file, form data must contain a fil…

    Existing publishes must be restarted in order to get the latest flow changes

See How connections work for access and permissions, or browse all integrations.