---
title: "List dashboard builds"
method: GET
path: "/api/v3/dashboards/{uuid}/builds"
tags: ["Build Dashboards Sharing"]
deprecated: true
---

# List dashboard builds

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

## Request

- Base URL: `https://codemagic.io`
- URL: `https://codemagic.io/api/v3/dashboards/{uuid}/builds`
- Auth: none required
- TypeScript: <https://skmtc.dev/codemagic/apis/codemagic-api/docs/api/v3/dashboards/:uuid/builds/get.ts> (a function with typed inputs; its response is checked against the schema)

> **Deprecated.**

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

## Path parameters

- `uuid` string, uuid, required

## Query parameters

- `cursor` unknown
- `page_size` integer: The maximum number of results per page.

## Response `200`

The response headers include a `link` header that provides URLs for fetching additional pages of results.
The `link` header looks something like this:
```
link: <https://codemagic.io/shared-dashboards/{uuid}/builds>; rel="first", <https://codemagic.io/shared-dashboards/{uuid}/builds?cursor=xxx>; rel="next"
```

- The URL for the first page is followed by `rel="first"`.
- The URL for the next page is followed by `rel="next"`.

- DashboardBuildCursorPagination
  - `data` DashboardBuild[], required
    - `id` string, required
    - `app` ApplicationRef, required
      - `id` string, required
      - `name` string, required
      - `icon_url` string, nullable, required: URL of the application icon, if there is one.
    - `workflow` Workflow, required
      - `id` string, required: Workflow ID for workflows defined in the Workflow Editor, or the workflow key in `codemagic.yaml` for file workflows.
      - `source` 'file' | 'ui', required: Where configuration is defined: in `codemagic.yaml` (`file`) or in the Workflow Editor (`ui`).
      - `name` string, nullable: Display name of the workflow, if known.
    - `status` 'initializing' | 'queued' | 'waiting' | 'preparing' | 'fetching' | 'testing' | 'building' | 'publishing' | 'finishing' | 'finished' | 'failed' | 'canceled' | 'timeout' | 'skipped', required: The stage a build is at, or how it ended.
    - `index` integer, required: Sequential number of the build within its workflow.
    - `artifacts` Artifact[], required: Files the build produced.
      - `name` string, required: File name of the artifact.
      - `size_in_bytes` integer, required: Size of the artifact in bytes.
      - `type` 'aab' | 'aar' | 'apk' | 'app' | 'bundle' | 'coverage_binary' | 'coverage_data' | 'device_recording' | 'directory' | 'dsym' | 'flutter_drive_log' | 'flutter_web_build_dir' | 'glob_matched' | 'ios_uitest_package' | 'ios_xctest_package' | 'ipa' | 'jar' | 'lint_result' | 'linux_app' | 'log' | 'logcat' | 'msix' | 'pkg' | 'proguard_map' | 'ios_simulator_log' | 'snap' | 'static_lib' | 'sylph_artefact_dir' | 'test_results_bundle' | 'windows_exe' | 'xcarchive' | 'xcodebuild_log', required: The kind of file a build artifact is.
      - `short_lived_download_url` string, required: URL to download the artifact. It stays valid for a limited time.
      - `version_code` string, nullable, required: Version code of the app in the artifact, if known.
      - `version_name` string, nullable, required: Version name of the app in the artifact, if known.
    - `labels` string[], required: Labels attached to the build.
    - `release_notes` ReleaseNote[], required
      - `language` string, required
      - `text` string, required
    - `created_at` string, date-time, required
    - `commit` Commit
      - `hash` string, nullable
      - `avatar_url` string, nullable: URL of the commit author's avatar, if known.
      - `author_name` string, nullable
      - `author_email` string, nullable
      - `message` string, nullable
      - `url` string, nullable: Web URL of the commit, if known.
    - `branch` string, nullable: Git branch the build ran from, if any.
    - `tag` string, nullable: Git tag the build ran from, if any.
    - `pull_request` PullRequest
      - `number` integer, required
      - `source_branch` string, required
      - `destination_branch` string, required
    - `started_at` string, date-time, nullable: When the build started running, if it has.
    - `finished_at` string, date-time, nullable: When the build finished, if it has.
  - `page_size` integer, required
  - `cursor` unknown, required

## Other responses

- `400`: The request could not be validated
- `404`: The requested resource does not exist
- `429`: The rate limit has been exceeded

---

[API](https://skmtc.dev/codemagic/apis/codemagic-api.md) - [All operations](https://skmtc.dev/codemagic/apis/codemagic-api/llms.txt) - [OpenAPI document](https://skmtc.dev/codemagic/apis/codemagic-api/revisions/be09630f65e2?raw)