> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Codemagic

The Codemagic connector lets your AI agent act in each user's Codemagic account. Each user connects their own Codemagic API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.

**Authentication:** API Key
**Categories:** Developer Tools, Automation
**Tools:** 60: 31 read, 19 write, 10 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=CODEMAGIC)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Codemagic connection

   In **AgentKit > Connections**, create a Codemagic connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

4. ### Authorize a user and make your first call

   **Node.js** (`quickstart.mts`)

   ```typescript
   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   import { createInterface } from 'node:readline/promises'

   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENVIRONMENT_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions

   const connector = 'codemagic'
   const identifier = 'user_123'

   // Generate an authorization link for the user
   const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
   console.log('Authorize Codemagic:', link)
   const rl = createInterface({ input: process.stdin, output: process.stdout })
   await rl.question('Press Enter after authorizing...')
   rl.close()

   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'codemagic_apps_list',
     toolInput: {},
   })
   console.log(result)
   ```

   ```bash
   npx tsx quickstart.mts
   ```

   **Python** (`quickstart.py`)

   ```python
   import os
   from scalekit import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()

   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions

   connection_name = "codemagic"
   identifier = "user_123"

   # Generate an authorization link for the user
   link_response = actions.get_authorization_link(
       connection_name=connection_name,
       identifier=identifier,
   )
   print("Authorize Codemagic:", link_response.link)
   input("Press Enter after authorizing...")

   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="codemagic_apps_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)
   ```

   ```bash
   python quickstart.py
   ```

   Each user opens the link once and enters their Codemagic credentials there. See [Authorize a user](/agentkit/tools/authorize/) for the full flow and statuses.

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'codemagic_app_caches_list',
  toolInput: {
    app_id: '<app_id>',
  },
  connector: 'codemagic',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="codemagic_app_caches_list",
    tool_input={
        "app_id": "<app_id>",
    },
    connection_name="codemagic",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `codemagic_app_caches_list`

List App Caches · Read-only

List the build caches stored for a Codemagic application.
Returns each cache's _id, workflowId, size in bytes and lastUsed time.
Use this before Delete App Cache to find a cache ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.

Example input: `{"app_id":"<app_id>"}`

### `codemagic_app_get`

Get App · Read-only

Get one Codemagic application by ID.
Returns the app's _id, appName, branches and Workflow Editor workflows (codemagic.yaml workflows are not listed).
Use this after List Apps when you need an app's branches or workflow IDs.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.

Example input: `{"app_id":"<app_id>"}`

### `codemagic_app_tester_groups_list`

List App Tester Groups · Read-only

List the tester groups of a Codemagic application.
Returns each group's ID and name.
Tester groups receive app previews and builds. Use List Tester Group Contacts for members.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.

Example input: `{"app_id":"<app_id>"}`

### `codemagic_app_variable_groups_list`

List App Variable Groups · Read-only

List the environment variable groups defined for one Codemagic application.
Returns the app's groups with ID and name.
Use List Team Variable Groups for team-level groups.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.

Example input: `{"app_id":"<app_id>"}`

### `codemagic_app_workflows_list`

List App Workflows · Read-only

List the workflows of a Codemagic application.
Returns each workflow's ID and name.
Use this to find a workflow ID for Start Build.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.

Example input: `{"app_id":"<app_id>"}`

### `codemagic_apps_list`

List Apps · Read-only

List every application added to Codemagic that the token's user can access.
Returns each app's _id, appName and Workflow Editor workflow IDs and names.
Use this to find an app ID. Use Get App for one app's branches, or List Team Apps for one team with paging.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `codemagic_build_actions_list`

List Build Actions · Read-only

List the actions (steps) of a Codemagic build.
Returns a page of actions with name, status and timings.
Use this to see which step of a build failed.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `build_id` (`string`, required): Codemagic build ID, as returned by Start Build or List Team Builds. Example: 5fabc6414c483700143f4f92.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.

Example input: `{"build_id":"<build_id>"}`

### `codemagic_build_get`

Get Build · Read-only

Get one Codemagic build by ID.
Returns status, app, workflow, branch or tag, commit, timings, build steps and artifacts with their download URLs.
Use this to follow a build started with Start Build.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `build_id` (`string`, required): Codemagic build ID, as returned by Start Build or List Team Builds. Example: 5fabc6414c483700143f4f92.

Example input: `{"build_id":"<build_id>"}`

### `codemagic_preview_get`

Get App Preview · Read-only

Get one Codemagic app preview by ID.
Returns its status, device, build and access details.
Use this after Start App Preview.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `preview_id` (`string`, required): App preview ID, from Start App Preview or List Team Previews. Example: 64f1c2a8b5d3e40012a1b2f6.

Example input: `{"preview_id":"<preview_id>"}`

### `codemagic_team_allowed_email_domains_get`

Get Allowed Email Domains · Read-only

Get the email domains allowed for a Codemagic team's external build notification recipients.
Returns the list of allowed domains.
Use Update Allowed Email Domains to change it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"team_id":"<team_id>"}`

### `codemagic_team_apps_list`

List Team Apps · Read-only

List the applications in a Codemagic team, with paging and optional ID or name filters.
Returns a page of apps with each app's ID, name and repository.
Use this for one team. Use List My Apps across all your teams.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
- `id` (`array`, optional): Only return apps with these app IDs. Example: ["5c9c064185dd2310123b8e96"].
- `name` (`string`, optional): Only return apps whose name contains this text. Example: my-app.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.

Example input: `{"team_id":"<team_id>"}`

### `codemagic_team_build_analytics_get`

Get Team Build Analytics · Read-only

Get build analytics for a Codemagic team over a date range.
Returns build counts, durations and outcomes for the period.
Use this for trends. Use Get Team Build Summary for usage totals.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `period_from` (`string`, required): Start of the period, as an ISO 8601 date. Example: 2026-01-01.
- `period_to` (`string`, required): End of the period, as an ISO 8601 date. Example: 2026-01-31.
- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"period_from":"<period_from>","period_to":"<period_to>","team_id":"<team_id>"}`

### `codemagic_team_build_summary_get`

Get Team Build Summary · Read-only

Get a build usage summary for a Codemagic team over a date range.
Returns totals such as build count and build minutes used for the period.
Use this for usage totals. Use Get Team Build Analytics for detailed trends.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `period_from` (`string`, required): Start of the period, as an ISO 8601 date. Example: 2026-01-01.
- `period_to` (`string`, required): End of the period, as an ISO 8601 date. Example: 2026-01-31.
- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"period_from":"<period_from>","period_to":"<period_to>","team_id":"<team_id>"}`

### `codemagic_team_builds_by_status_get`

Get Team Builds By Status · Read-only

Get the number of builds per status in a Codemagic team over a date range.
Returns counts of finished, failed, canceled and other build statuses.
Use this for a success-rate breakdown.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `period_from` (`string`, required): Start of the period, as an ISO 8601 date. Example: 2026-01-01.
- `period_to` (`string`, required): End of the period, as an ISO 8601 date. Example: 2026-01-31.
- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
- `app_id` (`string`, optional): Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
- `workflow_id` (`string`, optional): Only include builds of this workflow ID, from List App Workflows. Example: release.

Example input: `{"period_from":"<period_from>","period_to":"<period_to>","team_id":"<team_id>"}`

### `codemagic_team_builds_list`

List Team Builds · Read-only

List builds in a Codemagic team, newest first, filtered by app, status, workflow, branch, tag or label.
Returns a page of builds with IDs, status, app, workflow, branch and timings, plus a cursor for the next page.
Use this to find builds. Use Get Build for one build's full details and artifacts.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
- `app_id` (`string`, optional): Only return builds of this app ID. Example: 5c9c064185dd2310123b8e96.
- `branch` (`string`, optional): Only return builds of this branch. Example: main.
- `cursor` (`string`, optional): Cursor from the previous page's response, to fetch the next page. Example: eyJpZCI6IjY0ZjFjMmE4In0.
- `label` (`array`, optional): Only return builds with these labels. Example: ["nightly"].
- `page_size` (`integer`, optional): Number of items per page. Example: 20.
- `status` (`string`, optional): Only return builds in this status. Example: queued. One of: `queued`, `waiting`, `building`, `finished`, `failed`, `canceled`, `timeout`, `skipped`.
- `tag` (`string`, optional): Only return builds of this tag. Example: v1.0.0.
- `workflow_id` (`string`, optional): Only return builds of this workflow ID. Example: release.

Example input: `{"team_id":"<team_id>"}`

### `codemagic_team_external_recipients_list`

List External Recipients · Read-only

List external email recipients registered for a Codemagic team's build notifications.
Returns a page of recipients with ID and email.
Use this to find a recipient ID for Delete External Recipient.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.

Example input: `{"team_id":"<team_id>"}`

### `codemagic_team_get`

Get Team · Read-only

Get one Codemagic team by ID.
Returns the team's ID, name and settings.
Use List Teams to find the team ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"team_id":"<team_id>"}`

### `codemagic_team_invitations_list`

List Team Invitations · Read-only

List pending invitations to a Codemagic team, optionally filtered by role, scope or app.
Returns a page of invitations with ID, email and roles.
Use this to find an invitation ID for Revoke Team Invitation.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
- `app_id` (`array`, optional): Only return invitations with a role on any of these app IDs. Example: ["5c9c064185dd2310123b8e96"].
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.
- `role` (`array`, optional): Only return invitations with these roles: admin, member, app_developer or app_viewer. Example: ["member"].
- `scope` (`string`, optional): Only return invitations with this role scope, e.g. team or app. Example: team. One of: `team`, `app`.

Example input: `{"team_id":"<team_id>"}`

### `codemagic_team_members_list`

List Team Members · Read-only

List the members of a Codemagic team, optionally filtered by user, role, scope or app.
Returns a page of members with user ID, name, email and roles.
Use this to find a user ID for Update Team Membership or Remove Team Member.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
- `app_id` (`array`, optional): Only return team role holders and members with a grant on any of these app IDs. Example: ["5c9c064185dd2310123b8e96"].
- `id` (`array`, optional): Only return members with these user IDs. Example: ["5d85eaa0e941e00019e81bc2"].
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.
- `role` (`array`, optional): Only return members with these roles: owner, admin, member, app_developer or app_viewer. Example: ["admin"].
- `scope` (`string`, optional): Only return members whose role has this scope, e.g. team or app. Example: team. One of: `team`, `app`.

Example input: `{"team_id":"<team_id>"}`

### `codemagic_team_previews_list`

List Team App Previews · Read-only

List app previews in a Codemagic team.
Returns a page of previews with ID, build, status and timings.
Use Get App Preview for one preview.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.

Example input: `{"team_id":"<team_id>"}`

### `codemagic_team_roles_list`

List Team Roles · Read-only

List the roles available in a Codemagic team.
Returns each role's name, scope and permissions.
Use this before Update Team Membership or Create Team Invitation to pick valid roles.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"team_id":"<team_id>"}`

### `codemagic_team_variable_groups_list`

List Team Variable Groups · Read-only

List the environment variable groups defined at Codemagic team level.
Returns a page of groups with ID, name and security settings.
Use List App Variable Groups for app-level groups.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.

Example input: `{"team_id":"<team_id>"}`

### `codemagic_tester_group_contacts_list`

List Tester Group Contacts · Read-only

List the testers in a Codemagic tester group.
Returns a page of contacts with ID and email.
Use this to find a contact ID for Remove Tester Group Contact.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `tester_group_id` (`string`, required): Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.

Example input: `{"tester_group_id":"<tester_group_id>"}`

### `codemagic_tester_group_get`

Get Tester Group · Read-only

Get one Codemagic tester group by ID.
Returns the group's ID, name and app.
Use List Tester Group Contacts for its testers.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `tester_group_id` (`string`, required): Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.

Example input: `{"tester_group_id":"<tester_group_id>"}`

### `codemagic_user_apps_list`

List My Apps · Read-only

List the applications the token's user can access, with paging and an optional name filter.
Returns a page of apps with each app's ID, name and repository.
Use this to find an app by name. Use List Team Apps for one team's apps.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `name` (`string`, optional): Only return apps whose name contains this text. Example: my-app.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.

Example input: `{}`

### `codemagic_user_get`

Get Current User · Read-only

Get the Codemagic user that owns the API token.
Returns the user's ID, name, email and account details.
Use this to check the token works and to find your user ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `codemagic_user_team_permissions_get`

Get My Team Permissions · Read-only

Get the permissions the token's user has in one Codemagic team.
Returns the user's roles and permitted actions in that team.
Use this to check access before calling team admin tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"team_id":"<team_id>"}`

### `codemagic_user_teams_list`

List Teams · Read-only

List the Codemagic teams the token's user belongs to.
Returns a page of teams with each team's ID and name.
Use this to find a team ID for the team tools.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.

Example input: `{}`

### `codemagic_variable_group_get`

Get Variable Group · Read-only

Get one Codemagic environment variable group by ID.
Returns the group's ID, name, owner and security settings.
Use List Group Variables for the variables in it.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `variable_group_id` (`string`, required): Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.

Example input: `{"variable_group_id":"<variable_group_id>"}`

### `codemagic_variable_group_variable_get`

Get Group Variable · Read-only

Get one variable in a Codemagic variable group.
Returns the variable's ID, name, secure flag and value if it is not secure.
Use List Group Variables to find the variable ID.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `variable_group_id` (`string`, required): Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
- `variable_id` (`string`, required): Variable ID, from List Group Variables. Example: 64f1c2a8b5d3e40012a1b2d4.

Example input: `{"variable_group_id":"<variable_group_id>","variable_id":"<variable_id>"}`

### `codemagic_variable_group_variables_list`

List Group Variables · Read-only

List the variables in a Codemagic variable group, optionally searched by name.
Returns a page of variables with ID, name and whether each is secure; secure values are hidden.
Use Get Group Variable for one variable.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `variable_group_id` (`string`, required): Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
- `page` (`integer`, optional): Page number to return, starting at 1. Example: 1.
- `page_size` (`integer`, optional): Number of items per page. Example: 20.
- `search` (`string`, optional): Only return variables whose name contains this text. Example: API_.

Example input: `{"variable_group_id":"<variable_group_id>"}`

### `codemagic_app_create`

Add App · Write

Add a Git repository to Codemagic as a new application.
Returns the new app's _id and appName.
Use this for repositories Codemagic can already clone. Use Add App From Private Repository to supply an SSH key.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `repository_url` (`string`, required): SSH or HTTPS URL used to clone the repository. Example: git@github.com:my-organization/my-repo.git.
- `team_id` (`string`, optional): Team ID to add the app directly to one of your teams; you must be an admin of that team. Omit to add it to your personal account. Example: 5fabc6414c483700143f4f11.

Example input: `{"repository_url":"<repository_url>"}`

### `codemagic_app_create_from_private_repo`

Add App From Private Repository · Write

Add a private Git repository to Codemagic, using an SSH private key for cloning.
Returns the new application's _id and appName.
Use this when Codemagic has no access to the repository. Use Add App when it can already clone it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `repository_url` (`string`, required): SSH or HTTPS URL used to clone the repository. Example: git@github.com:my-organization/my-repo.git.
- `ssh_key` (`object`, required): SSH key Codemagic uses to clone the repository: an object with data (the private key file, base64-encoded) and passphrase (the key's passphrase, or null if it has none). Example: {"data": "LS0tLS1CRUdJTiBPUEVOU1NIIFBSSVZBVEUgS0VZLS0tLS0K..", "passphrase": null}.
- `project_type` (`string`, optional): Set to flutter-app when adding a Flutter application; omit otherwise. Example: flutter-app.
- `team_id` (`string`, optional): Team ID to add the app to; you must be an admin of that team. Omit to add it to your personal account. Example: 5fabc6414c483700143f4f11.

Example input: `{"repository_url":"<repository_url>","ssh_key":{"data":"LS0tLS1CRUdJTiBPUEVOU1NIIFBSSVZBVEUgS0VZLS0tLS0K..","passphrase":null}}`

### `codemagic_app_tester_group_create`

Create Tester Group · Write

Create a tester group for a Codemagic application.
Returns the new group's ID.
Use Import Tester Group Contacts to add testers.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
- `name` (`string`, required): Name of the tester group. Example: QA team.

Example input: `{"app_id":"<app_id>","name":"<name>"}`

### `codemagic_app_variable_group_create`

Create App Variable Group · Write

Create an environment variable group for one Codemagic application.
Returns the new group's ID.
Use Import Group Variables to add variables to it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
- `name` (`string`, required): Name of the variable group, as referenced from codemagic.yaml. Example: staging_secrets.

Example input: `{"app_id":"<app_id>","name":"<name>"}`

### `codemagic_artifact_public_url_create`

Create Artifact Public URL · Write

Create a time-limited public download URL for a build artifact.
Returns url (anyone with it can download the artifact) and expiresAt.
Use this to share an artifact with someone outside Codemagic. Get the artifact path from Get Build.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `artifact_path` (`string`, required): Path of the artifact after https://api.codemagic.io/artifacts/ in its authenticated download URL, from the build's artifacts in Get Build. Example: ef45fb91-4c89-4395-8f7d-9368b97490de/2dd0b3d6-ae58-4894-b470-8bc2b24e259a/myapp.ipa. Example: ef45fb91-4c89-4395-8f7d-9368b97490de/2dd0b3d6-ae58-4894-b470-8bc2b24e259a/myapp.ipa.
- `expires_at` (`integer`, required): When the public URL expires, as a UNIX timestamp in seconds. Example: 1767225600.

Example input: `{"artifact_path":"<artifact_path>","expires_at":1767225600}`

### `codemagic_build_cancel`

Cancel Build · Write

Cancel a queued or running Codemagic build.
Returns an empty success response, or status 208 if the build had already finished.
Use Get Build first to check the build is still running.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `build_id` (`string`, required): Codemagic build ID, as returned by Start Build or List Team Builds. Example: 5fabc6414c483700143f4f92.

Example input: `{"build_id":"<build_id>"}`

### `codemagic_build_preview_start`

Start App Preview · Write

Start an in-browser app preview from a build artifact on a cloud device.
Returns the new preview with its ID and status.
Use Get App Preview to follow it and Share App Preview to get a link. Can fail with 402 if the plan has no preview minutes.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `artifact_path` (`string`, required): Path of the build artifact to run (an .apk or simulator .app build), from the build's artifacts in Get Build. Example: ef45fb91-4c89-4395-8f7d-9368b97490de/2dd0b3d6-ae58-4894-b470-8bc2b24e259a/myapp.apk.
- `build_id` (`string`, required): Codemagic build ID, as returned by Start Build or List Team Builds. Example: 5fabc6414c483700143f4f92.

Example input: `{"artifact_path":"<artifact_path>","build_id":"<build_id>"}`

### `codemagic_build_start`

Start Build · Write

Start a new build of a Codemagic app workflow on a branch or tag.
Returns the new buildId.
Use Get Build to follow its status. Branch and trigger settings in the workflow are ignored; the branch or tag you pass is built.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `app_id` (`string`, required): Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
- `workflow_id` (`string`, required): Workflow ID: the workflow key in codemagic.yaml, or the Workflow Editor workflow ID from Get App. Example: release.
- `branch` (`string`, optional): Git branch to build. Provide either branch or tag. Example: main.
- `environment` (`object`, optional): Overrides for this build: variables (object of name to value), groups (array of variable group names) and softwareVersions (object such as xcode or flutter to version). Example: {"variables": {"API_URL": "https://staging.example.com"}, "groups": ["staging_secrets"], "softwareVersions": {"xcode": "15.4"}}.
- `instance_type` (`string`, optional): Build machine type, e.g. mac_mini_m2 or linux_x2. Example: mac_mini_m2.
- `labels` (`array`, optional): Labels to add to the build, in addition to existing labels. Example: ["nightly"].
- `tag` (`string`, optional): Git tag to build. Provide either branch or tag. Example: v1.0.0.

Example input: `{"app_id":"<app_id>","workflow_id":"<workflow_id>"}`

### `codemagic_preview_share`

Share App Preview · Write

Create a shareable link to a running Codemagic app preview.
Returns the shared preview with its public URL.
Anyone with the link can open the preview.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `preview_id` (`string`, required): App preview ID, from Start App Preview or List Team Previews. Example: 64f1c2a8b5d3e40012a1b2f6.

Example input: `{"preview_id":"<preview_id>"}`

### `codemagic_team_allowed_email_domains_update`

Update Allowed Email Domains · Write

Replace the email domains allowed for a Codemagic team's external build notification recipients.
Returns the updated list of domains.
The list you send replaces the current one. Requires team admin rights.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `domains` (`array`, required): Complete list of allowed email domains; replaces the current list. Example: ["example.com"].
- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"domains":["example.com"],"team_id":"<team_id>"}`

### `codemagic_team_external_recipients_add`

Add External Recipients · Write

Register external email addresses to receive a Codemagic team's build notifications.
Returns the registered recipients.
Addresses must be in the team's allowed email domains; see Get Allowed Email Domains.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `emails` (`array`, required): Email addresses to register as notification recipients. Example: ["qa@example.com"].
- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"emails":["qa@example.com"],"team_id":"<team_id>"}`

### `codemagic_team_invitation_create`

Create Team Invitation · Write

Invite a person by email to join a Codemagic team with the given roles.
Returns the new invitation; Codemagic emails the invitee.
Use List Team Roles for valid roles. Requires team admin rights.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `email` (`string`, required): Email address of the person to invite. Example: dev@example.com.
- `roles` (`array`, required): Roles to give the invitee. A team role is {role: admin or member, scope: team}; an app role is {role: app_developer or app_viewer, scope: app, app_id}. Example: [{"role": "member", "scope": "team"}].
- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"email":"<email>","roles":[{"role":"member","scope":"team"}],"team_id":"<team_id>"}`

### `codemagic_team_membership_update`

Update Team Membership · Write

Change a member's roles in a Codemagic team.
Returns the updated membership.
Use List Team Members to find the user ID and List Team Roles for valid roles. Requires team admin rights.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
- `user_id` (`string`, required): Codemagic user ID of the team member, from List Team Members. Example: 5d85eaa0e941e00019e81bc2.
- `role` (`string`, optional): Team-wide role to give the member: admin or member. Example: member. One of: `admin`, `member`.
- `roles` (`array`, optional): Full list of roles to give the member. A team role is {role: admin or member, scope: team}; an app role is {role: app_developer or app_viewer, scope: app, app_id}. Example: [{"role": "member", "scope": "team"}].

Example input: `{"team_id":"<team_id>","user_id":"<user_id>"}`

### `codemagic_team_variable_group_create`

Create Team Variable Group · Write

Create an environment variable group at Codemagic team level.
Returns the new group's ID.
Use Import Group Variables to add variables to it.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `advanced_security` (`object`, required): Which apps may use the group: enabled (true to restrict it) and selected_apps (app IDs allowed when enabled). Example: {"enabled": false, "selected_apps": []}.
- `name` (`string`, required): Name of the variable group, as referenced from codemagic.yaml. Example: staging_secrets.
- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"advanced_security":{"enabled":false,"selected_apps":[]},"name":"<name>","team_id":"<team_id>"}`

### `codemagic_tester_group_contacts_import`

Import Tester Group Contacts · Write

Add testers to a Codemagic tester group by email.
Returns the created contacts.
May fail with 402 if the team's plan limits testers.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `emails` (`array`, required): Email addresses of the testers to add. Example: ["tester@example.com"].
- `tester_group_id` (`string`, required): Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.

Example input: `{"emails":["tester@example.com"],"tester_group_id":"<tester_group_id>"}`

### `codemagic_tester_group_update`

Rename Tester Group · Write

Rename a Codemagic tester group.
Returns an empty success response.
Use List App Tester Groups to find the group ID.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): New name for the tester group. Example: Beta testers.
- `tester_group_id` (`string`, required): Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.

Example input: `{"name":"<name>","tester_group_id":"<tester_group_id>"}`

### `codemagic_variable_group_update`

Update Variable Group · Write

Rename a Codemagic variable group or change which apps may use it.
Returns an empty success response.
Only the fields you send are changed.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `variable_group_id` (`string`, required): Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
- `advanced_security` (`object`, optional): Which apps may use the group: enabled (true to restrict it) and selected_apps (app IDs allowed when enabled). Example: {"enabled": true, "selected_apps": ["5c9c064185dd2310123b8e96"]}.
- `name` (`string`, optional): New name for the group. Example: production_secrets.

Example input: `{"variable_group_id":"<variable_group_id>"}`

### `codemagic_variable_group_variable_update`

Update Group Variable · Write

Change a variable's name, value or secure flag in a Codemagic variable group.
Returns an empty success response.
Only the fields you send are changed.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `variable_group_id` (`string`, required): Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
- `variable_id` (`string`, required): Variable ID, from List Group Variables. Example: 64f1c2a8b5d3e40012a1b2d4.
- `name` (`string`, optional): New variable name. Example: API_TOKEN.
- `secure` (`boolean`, optional): Set true to store the value as a secret. Example: true.
- `value` (`string`, optional): New variable value. Example: def456.

Example input: `{"variable_group_id":"<variable_group_id>","variable_id":"<variable_id>"}`

### `codemagic_variable_group_variables_import`

Import Group Variables · Write

Add one or more environment variables to a Codemagic variable group.
Returns the created variables.
All variables in one call share the same secure setting.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `secure` (`boolean`, required): Set true to store the values as secrets that are hidden after saving. Example: true.
- `variable_group_id` (`string`, required): Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
- `variables` (`array`, required): Variables to add, each with a name and a value. Example: [{"name": "API_TOKEN", "value": "abc123"}].

Example input: `{"secure":true,"variable_group_id":"<variable_group_id>","variables":[{"name":"API_TOKEN","value":"abc123"}]}`

### `codemagic_app_cache_delete`

Delete App Cache · Destructive

Delete one stored build cache of a Codemagic application.
Returns the cache ID queued for deletion; deletion finishes asynchronously.
Use List App Caches to find the cache ID. Use Delete All App Caches to clear every cache.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.
- `cache_id` (`string`, required): Cache ID, from List App Caches. Example: 620f9f218ab90da6b1b22e0e.

Example input: `{"app_id":"<app_id>","cache_id":"<cache_id>"}`

### `codemagic_app_caches_delete_all`

Delete All App Caches · Destructive

Delete every stored build cache of a Codemagic application.
Returns the IDs of the caches queued for deletion; deletion finishes asynchronously.
Use Delete App Cache to remove a single workflow's cache instead.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `app_id` (`string`, required): Codemagic application ID. Find it with List Apps or List Team Apps. Example: 5c9c064185dd2310123b8e96.

Example input: `{"app_id":"<app_id>"}`

### `codemagic_preview_stop`

Stop App Preview · Destructive

Stop a running Codemagic app preview.
Returns an empty success response.
Use this to release the cloud device when testing is done.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `preview_id` (`string`, required): App preview ID, from Start App Preview or List Team Previews. Example: 64f1c2a8b5d3e40012a1b2f6.

Example input: `{"preview_id":"<preview_id>"}`

### `codemagic_team_external_recipient_delete`

Delete External Recipient · Destructive

Remove an external email recipient from a Codemagic team's build notifications.
Returns an empty success response.
Use List External Recipients to find the recipient ID.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `recipient_id` (`string`, required): External recipient ID, from List External Recipients. Example: 64f1c2a8b5d3e40012a1b3b8.
- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"recipient_id":"<recipient_id>","team_id":"<team_id>"}`

### `codemagic_team_invitation_revoke`

Revoke Team Invitation · Destructive

Revoke a pending invitation to a Codemagic team.
Returns an empty success response; the invite link stops working.
Use List Team Invitations to find the invitation ID.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `invitation_id` (`string`, required): Invitation ID, from List Team Invitations. Example: 64f1c2a8b5d3e40012a1b3a7.
- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.

Example input: `{"invitation_id":"<invitation_id>","team_id":"<team_id>"}`

### `codemagic_team_member_remove`

Remove Team Member · Destructive

Remove a user from a Codemagic team.
Returns an empty success response.
Use List Team Members to find the user ID. Requires team admin rights.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `team_id` (`string`, required): Codemagic team ID. Find it with List Teams (user_teams_list) or in the team settings URL. Example: 5fabc6414c483700143f4f11.
- `user_id` (`string`, required): Codemagic user ID of the team member, from List Team Members. Example: 5d85eaa0e941e00019e81bc2.

Example input: `{"team_id":"<team_id>","user_id":"<user_id>"}`

### `codemagic_tester_group_contact_remove`

Remove Tester Group Contact · Destructive

Remove one tester from a Codemagic tester group.
Returns an empty success response.
Use List Tester Group Contacts to find the contact ID.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `contact_id` (`string`, required): Contact ID, from List Tester Group Contacts. Example: 64f1c2a8b5d3e40012a1b3c9.
- `tester_group_id` (`string`, required): Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.

Example input: `{"contact_id":"<contact_id>","tester_group_id":"<tester_group_id>"}`

### `codemagic_tester_group_delete`

Delete Tester Group · Destructive

Delete a Codemagic tester group and its contact list.
Returns an empty success response.
The testers stop receiving shares sent to this group.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `tester_group_id` (`string`, required): Tester group ID, from List App Tester Groups. Example: 64f1c2a8b5d3e40012a1b2e5.

Example input: `{"tester_group_id":"<tester_group_id>"}`

### `codemagic_variable_group_delete`

Delete Variable Group · Destructive

Delete a Codemagic environment variable group and all variables in it.
Returns an empty success response.
Builds that reference the group will no longer get its variables.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `variable_group_id` (`string`, required): Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.

Example input: `{"variable_group_id":"<variable_group_id>"}`

### `codemagic_variable_group_variable_delete`

Delete Group Variable · Destructive

Delete one variable from a Codemagic variable group.
Returns an empty success response.
Use List Group Variables to find the variable ID.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `variable_group_id` (`string`, required): Variable group ID, from List Team Variable Groups or List App Variable Groups. Example: 64f1c2a8b5d3e40012a1b2c3.
- `variable_id` (`string`, required): Variable ID, from List Group Variables. Example: 64f1c2a8b5d3e40012a1b2d4.

Example input: `{"variable_group_id":"<variable_group_id>","variable_id":"<variable_id>"}`

## Related

Other Developer Tools connectors ([all 200](/agentkit/connectors/?category=developer-tools)):

- [GitHub](/agentkit/connectors/github/): Scalekit connector, OAuth, 217 tools
- [Datadog](/agentkit/connectors/datadog/): Scalekit connector, API key, 105 tools
- [Linear](/agentkit/connectors/linear/): Scalekit connector, OAuth, 64 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
