Skip to content
Changelog

Report a bug

Codemagic integration: operations for AI agents

Codemagic connects to Type.com as an integration. This page lists the 113 operations documented for Claude and Codex in Type.com: 68 read, 20 write, 25 destructive.

About Codemagic

Codemagic is a CI/CD platform focused on mobile app development.

Categories: Developer Tools & IT

How to connect Codemagic to Type.com

Access
Organization connection: one shared account for the workspace.

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

Documented operations

113 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.

113 operations listed.

Codemagic API v3 / Teams

  • Read

    List teams for the authenticated user

    List teams for the authenticated user. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/user/teams

  • Read

    Get team info

    Get team info. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}

  • Read

    Download team audit log as CSV

    Returns a CSV file that contains the audit log events. ### Event List - `app_created` - `app_deleted` - `app_repository_changed` - `app_role_granted` - `app_role_revoked` - `audit_log_connector_deleted` - `audit_log_connector_updated` - `audit_log_downloaded` - `file_downloaded` - `team_deleted` - `team_invitation_accepted` - `team_invitation_revoked` - `team_member_invited` - `team_member_removed` - `team_member_role_changed` - `team_ownership_transferred` - `user_authenticated`

    GET /api/v3/teams/{team_id}/audit-log

  • Read

    Get Audit Log Connector settings for the team

    Get Audit Log Connector settings for the team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/audit-log-connector

  • Destructive

    Update subscription features for the team

    Update subscription features for the team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    PATCH /api/v3/subscriptions/{team_id}/features

  • Destructive

    Update Audit Log Connector settings for the team

    Update Audit Log Connector settings for the team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    PUT /api/v3/teams/{team_id}/audit-log-connector

  • Destructive

    Delete Audit Log Connector settings for the team

    Delete Audit Log Connector settings for the team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/teams/{team_id}/audit-log-connector

Codemagic API v3 / Builds

  • Read

    Get build info

    Get build info. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/builds/{build_id}

  • Read

    Get build remote access info

    Get build remote access info. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/builds/{build_id}/remote-access

  • Read

    Get build actions

    Get build actions. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/builds/{build_id}/actions

  • Read

    List team builds

    List team builds. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/builds

  • Write

    Start a new build

    Queue a new build for the application. The 202 response means the build request was **accepted**, not that a build has started. For this reason `GET /builds/{build_id}` can respond 404 for a short while after this endpoint has returned the build id. `workflow_id` names the workflow to build. A 24-character hexadecimal id selects a workflow defined in the Workflow Editor; any other value is the id of a workflow in the repository's `codemagic.yaml`, as in `workflows.<workflow_id>`. Exactly one of `branch` or `tag` is required - it is what the build is started from. Giving neither, or both, responds 400.

    POST /api/v3/apps/{app_id}/builds

Codemagic API v3 / Tester Groups

  • Read

    List tester groups for the app

    List tester groups for the app. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/apps/{app_id}/tester-groups

  • Read

    List contacts for the tester group

    List contacts for the tester group. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/tester-groups/{tester_group_id}/contacts

  • Read

    Get a tester group

    Get a tester group. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/tester-groups/{tester_group_id}

  • Write

    Create tester group for the app

    Create tester group for the app. Exact request/response schemas, examples and authority conditions are retained in the contract.

    POST /api/v3/apps/{app_id}/tester-groups

  • Write

    Bulk import contacts to the tester group

    <!-- theme: warning --> > The bulk import API is not designed to sync updates in real-time from an external database. ### Skipped contacts Contacts must meet all the following criteria in order to be created or updated with this API: - The imported contacts may not exceed your account limit. - The contact must have a valid email address. - The contact's email address must not be on an exclusion list. - The contact's email must not be on a list of bounced email addresses. If contacts do not meet all of these requirements, they will be skipped by the importer.

    POST /api/v3/tester-groups/{tester_group_id}/contacts

  • Write

    Update a tester group

    Update a tester group. Exact request/response schemas, examples and authority conditions are retained in the contract.

    PATCH /api/v3/tester-groups/{tester_group_id}

  • Destructive

    Delete contact from the tester group

    Delete contact from the tester group. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/tester-groups/{tester_group_id}/contacts/{contact_id}

  • Destructive

    Delete tester group

    Delete tester group. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/tester-groups/{tester_group_id}

Codemagic API v3 / Secrets and Environment Vars

  • Read

    List variable groups for the app

    List variable groups for the app. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/apps/{app_id}/variable-groups

  • Read

    List variables for the group

    List variables for the group. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/variable-groups/{variable_group_id}/variables

  • Read

    Get group information

    Get group information. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/variable-groups/{variable_group_id}

  • Read

    Get a variable from the group

    Get a variable from the group. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/variable-groups/{variable_group_id}/variables/{variable_id}

  • Read

    List variable groups for the team

    List variable groups for the team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/variable-groups

  • Write

    Create a variable group for the app

    Create a variable group for the app. Exact request/response schemas, examples and authority conditions are retained in the contract.

    POST /api/v3/apps/{app_id}/variable-groups

  • Write

    Bulk import variables to the group

    Bulk import variables to the group. Exact request/response schemas, examples and authority conditions are retained in the contract.

    POST /api/v3/variable-groups/{variable_group_id}/variables

  • Write

    Create a variable group for the team

    Create a variable group for the team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    POST /api/v3/teams/{team_id}/variable-groups

  • Destructive

    Delete the group and all variables

    Delete the group and all variables. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/variable-groups/{variable_group_id}

  • Destructive

    Change group name and settings

    Change group name and settings. Exact request/response schemas, examples and authority conditions are retained in the contract.

    PATCH /api/v3/variable-groups/{variable_group_id}

  • Destructive

    Delete the variable

    Delete the variable. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/variable-groups/{variable_group_id}/variables/{variable_id}

  • Destructive

    Update the variable

    Update the variable. Exact request/response schemas, examples and authority conditions are retained in the contract.

    PATCH /api/v3/variable-groups/{variable_group_id}/variables/{variable_id}

Codemagic API v3 / Applications

  • Read

    List app workflows

    List the distinct workflows for given app.

    GET /api/v3/apps/{app_id}/workflows

  • Read

    List apps for the authenticated user

    To list the applications belonging to a team, see [/teams/{team_id}/apps](#/operations/TeamsTeamIdAppsGetApps)

    GET /api/v3/user/apps

  • Read

    List apps for the team

    List apps for the team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/apps

Codemagic API v3 / App Previews

  • Read

    List app previews for the team

    List app previews for the team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/previews

  • Read

    Get app preview information

    Get app preview information. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/previews/{preview_id}

  • Read

    Get shared app preview information

    Get details of a publicly shared app preview. Does not require user authentication. See [`POST /previews/{preview_id}/share`](#/operations/PreviewsPreviewIdShareSharePreview) for app preview sharing.

    GET /api/v3/shared-previews/{shared_preview_id}

  • Write

    Start an app preview

    Start an app preview. Exact request/response schemas, examples and authority conditions are retained in the contract.

    POST /api/v3/builds/{build_id}/preview

  • Write

    Share an app preview

    Create a public ID that can be used to retrieve app preview without authentication, see [`GET /shared-previews/{shared_preview_id}`](#/operations/SharedPreviewsSharedPreviewIdGetSharedPreview).

    POST /api/v3/previews/{preview_id}/share

  • Destructive

    Stop an app preview

    Stop an app preview. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/previews/{preview_id}

Codemagic API v3 / Users

  • Read

    Get authenticated user info

    Get authenticated user info. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/user

  • Read

    Get preferences for the authenticated user

    Get preferences for the authenticated user. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/user/preferences

  • Read

    Get API key for the authenticated user

    Get API key for the authenticated user. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/user/api-key

  • Read

    Get notifications for the authenticated user

    Get notifications for the authenticated user. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/user/notifications

  • Read

    Get the authenticated user's permissions in a team

    Get the authenticated user's permissions in a team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/user/teams/{team_id}/permissions

  • Destructive

    Revoke API key for the authenticated user

    Revoke API key for the authenticated user. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/user/api-key

Codemagic API v3 / Team Members

  • Read

    List team members

    List team members. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/members

  • Destructive

    Remove authenticated user from the team

    Remove authenticated user from the team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/user/memberships/{team_id}

  • Destructive

    Update team membership for a user

    Update team membership for a user. Exact request/response schemas, examples and authority conditions are retained in the contract.

    PUT /api/v3/teams/{team_id}/memberships/{user_id}

  • Destructive

    Remove team membership for a user

    Remove team membership for a user. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/teams/{team_id}/memberships/{user_id}

  • Destructive

    Transfer team ownership

    Make the given team member the owner. The previous owner becomes an admin.

    POST /api/v3/teams/{team_id}/ownership

Codemagic API v3 / Meta

  • Read

    Get meta information

    Returns meta information about Codemagic, including a list of public IP addresses in use. These IP addresses are in [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation). If needed, you can use an online conversion tool to convert from CIDR notation to IP address ranges. Please note that these IP addresses may change from time to time, so if you use them for IP whitelisting or any kind of automation, we strongly encourage you to regularly monitor our API.

    GET /api/v3/meta

  • Read

    Get information about Shorebird integration

    Get information about Shorebird integration. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/meta/shorebird

Codemagic API v3 / Over-the-air Updates

  • Read

    Get account information for the authenticated user

    Get account information for the authenticated user. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/over-the-air-updates

  • Read

    Get account information for the authenticated user

    Get account information for the authenticated user. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/ota

  • Read

    Get deployment releases history

    Get deployment releases history. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/ota/deployments/{deployment_id}/releases

  • Read

    Get deployment releases history

    Get deployment releases history. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/over-the-air-updates/deployments/{deployment_id}/releases

  • Read

    Get project deployment keys

    Get project deployment keys. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/ota/projects/{project_id}/deployment-keys

  • Read

    Get project deployment keys

    Get project deployment keys. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/over-the-air-updates/projects/{project_id}/deployment-keys

  • Read

    Get usage stats for a deployment channel.

    Get usage stats for a deployment channel.. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/ota/deployments/{deployment_id}/usage/{metric}

  • Read

    Get usage stats for a deployment channel.

    Get usage stats for a deployment channel.. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/over-the-air-updates/deployments/{deployment_id}/usage/{metric}

  • Read

    List all access keys for a team

    List all access keys for a team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/ota/{team_id}/access-keys

  • Read

    List projects for the team

    List projects for the team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/ota/{team_id}/projects

  • Read

    List projects for the team

    List projects for the team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/over-the-air-updates/{team_id}/projects

  • Read

    Get usage stats for the team.

    Get usage stats for the team.. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/ota/{team_id}/usage

  • Read

    Get usage stats for the team.

    Get usage stats for the team.. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/over-the-air-updates/{team_id}/usage

  • Write

    Create an access key for a team

    Create an access key for a team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    POST /api/v3/ota/{team_id}/access-keys

  • Destructive

    Delete an access key for a team

    Delete an access key for a team. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/ota/{team_id}/access-keys/{key_id}

Codemagic API v3 / Analytics

  • Read

    Get team build analytics

    Get team build analytics. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/analytics/builds

  • Read

    Get team build duration percentiles

    Get team build duration percentiles. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/analytics/build-duration-percentiles

  • Read

    Get team build usage summary

    Get team build usage summary. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/analytics/summary

  • Read

    Get team builds by status

    Get team builds by status. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/analytics/builds-by-status

  • Read

    Get team builds by status over time

    Get team builds by status over time. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/analytics/builds-by-status-over-time

  • Read

    Get team queued time percentiles

    Get team queued time percentiles. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/analytics/queued-time-percentiles

Codemagic API v3 / Billing

  • Read

    Get subscription details

    Get subscription details. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/subscriptions/{subscription_id}

  • Read

    List team subscriptions

    List team subscriptions. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/subscriptions

  • Read

    Get subscription invoice preview

    Get subscription invoice preview. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/subscriptions/{subscription_id}/invoice-preview

  • Read

    List subscription invoices

    List subscription invoices. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/subscriptions/{subscription_id}/invoices

  • Read

    List team cards

    List team cards. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/cards

  • Read

    Get team customer

    Get team customer. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/customer

  • Read

    Generate invoice preview for chosen line items

    Generate invoice preview for chosen line items. Exact request/response schemas, examples and authority conditions are retained in the contract.

    POST /api/v3/teams/{team_id}/invoice-preview

  • Read

    List team invoices

    List team invoices. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/invoices

  • Write

    Apply promotion code to subscription

    Apply promotion code to subscription. Exact request/response schemas, examples and authority conditions are retained in the contract.

    POST /api/v3/teams/{team_id}/subscriptions/{subscription_id}/promotion-code

  • Destructive

    Cancel team subscription

    Cancel team subscription. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/teams/{team_id}/subscriptions/{subscription_id}

  • Destructive

    Create team subscription

    Create team subscription. Exact request/response schemas, examples and authority conditions are retained in the contract.

    POST /api/v3/teams/{team_id}/subscriptions

  • Destructive

    Set subscription default payment method

    Set subscription default payment method. Exact request/response schemas, examples and authority conditions are retained in the contract.

    PUT /api/v3/teams/{team_id}/subscriptions/{subscription_id}/default-payment-method

  • Destructive

    Set customer default payment method

    Set customer default payment method. Exact request/response schemas, examples and authority conditions are retained in the contract.

    PUT /api/v3/teams/{team_id}/customer/default-payment-method

Codemagic API v3 / Team External Recipients

  • Read

    List external build notification recipients

    List external build notification recipients. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/external-recipients

  • Write

    Register external build notification recipients

    Register email addresses that may receive build notifications from this team's workflows. Each new address is emailed a confirmation request and is **not** sent build notifications until the recipient confirms. Addresses belonging to current team members need no record here and are skipped. ### Skipped addresses - Invalid email addresses. - Addresses belonging to a member of this team. - Addresses already registered for this team, whether confirmed, pending or removed. Each address is asked to confirm at most once per team. Addresses that have previously hard-bounced, reported our email as spam or unsubscribed are registered as `rejected` and are not emailed a confirmation request.

    POST /api/v3/teams/{team_id}/external-recipients

  • Destructive

    Remove an external build notification recipient

    Removes the recipient from this team. An address that has not confirmed, or that bounced or unsubscribed, is retained internally so that removing and re-adding it cannot be used to send it repeated confirmation requests.

    DELETE /api/v3/teams/{team_id}/external-recipients/{recipient_id}

Codemagic API v3 / Team Invitations

  • Read

    List pending team invitations

    List pending team invitations. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/teams/{team_id}/invitations

  • Read

    Get team invitation by code

    Get team invitation by code. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/invitations/public/{code}

  • Write

    Accept a team invitation

    Accept a team invitation. Exact request/response schemas, examples and authority conditions are retained in the contract.

    POST /api/v3/invitations/{code}/accept

  • Write

    Create a team invitation

    Create a team invitation. Exact request/response schemas, examples and authority conditions are retained in the contract.

    POST /api/v3/teams/{team_id}/invitations

  • Destructive

    Revoke a team invitation

    Revoke a team invitation. Exact request/response schemas, examples and authority conditions are retained in the contract.

    DELETE /api/v3/teams/{team_id}/invitations/{invitation_id}

Codemagic API v3 / Build Dashboards

  • Write

    Rename a dashboard

    Rename a dashboard. Exact request/response schemas, examples and authority conditions are retained in the contract.

    PATCH /api/v3/dashboards/{dashboard_id}

Codemagic API v3 / Build Dashboards Sharing

  • Read

    List dashboard builds (deprecated)

    Deprecated. Use `GET /shared-dashboards/{uuid}/builds` instead.

    GET /api/v3/dashboards/{uuid}/builds

  • Read

    Get a dashboard (deprecated)

    Deprecated. Use `GET /shared-dashboards/{uuid}` instead.

    GET /api/v3/dashboards/{uuid}

  • Read

    List dashboard builds

    List dashboard builds. Exact request/response schemas, examples and authority conditions are retained in the contract.

    GET /api/v3/shared-dashboards/{uuid}/builds

  • Read

    Get a dashboard

    For more information, see "[Build dashboards](https://docs.codemagic.io/knowledge-others/build-dashboards/)."

    GET /api/v3/shared-dashboards/{uuid}

Legacy preview API (api.codemagic.io)

  • Read

    Retrieve all applications

    Retrieve all applications using the preserved legacy preview contract.

    GET /apps

  • Read

    Retrieve an application

    Retrieve an application using the preserved legacy preview contract.

    GET /apps/{id}

  • Read

    Get authenticated artifact

    Get authenticated artifact using the preserved legacy preview contract.

    GET /artifacts/{secureFilename}

  • Read

    List legacy application caches

    List legacy application caches using the preserved legacy preview contract.

    GET /apps/{id}/caches

  • Write

    Add a new application

    Add a new application using the preserved legacy preview contract.

    POST /apps

  • Write

    Add a private-repository application

    Add a private-repository application using the preserved legacy preview contract.

    POST /apps/new

  • Write

    Start a legacy build

    Start a legacy build using the preserved legacy preview contract.

    POST /builds

  • Write

    Create public artifact download URL

    Create public artifact download URL using the preserved legacy preview contract.

    POST /artifacts/{secureFilename}/public-url

  • Destructive

    Cancel legacy build

    Cancel legacy build using the preserved legacy preview contract.

    POST /builds/{id}/cancel

  • Destructive

    Delete all legacy app caches

    Delete all legacy app caches using the preserved legacy preview contract.

    DELETE /apps/{id}/caches

  • Destructive

    Delete a specific legacy app cache

    Delete a specific legacy app cache using the preserved legacy preview contract.

    DELETE /apps/{id}/caches/{cacheId}

Legacy action requiring migration

  • Write

    Create Variable

    Create a variable in the specified workflow.

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

Reference date: October 29, 2026. Codemagic API docs.