List all builds

GET /builds

List all the Bitrise builds that can be accessed with the authenticated account. Filter builds based on their owner, using the owner slug, or the status of the build.

Query parameters

  • owner_slug string

    The slug of the owner of the app or apps

  • is_on_hold boolean

    Indicates whether the build has started yet (true: the build hasn't started)

  • status integer

    The status of the build: not finished (0), successful (1), failed (2), aborted with failure (3), aborted with success (4)

    Maximum value is 4.

  • next string

    Slug of the first build in the response

  • limit integer

    Max number of elements per page (default: 50)

    Maximum value is 50.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • data array[object]
      Hide data attributes Show data attributes object
      • abort_reason string
      • branch string
      • build_number integer
      • commit_hash string
      • commit_message string
      • commit_view_url string
      • credit_cost integer
      • environment_prepare_finished_at string
      • finished_at string
      • is_on_hold boolean
      • is_processed boolean
      • machine_type_id string
      • original_build_params object

        Additional properties are allowed.

      • pull_request_id integer
      • pull_request_target_branch string
      • pull_request_view_url string
      • repository object

        Additional properties are allowed.

        Hide repository attributes Show repository attributes object
        • avatar_url string
        • is_disabled boolean
        • is_github_checks_enabled boolean
        • is_public boolean
        • owner object

          Additional properties are allowed.

          Hide owner attributes Show owner attributes object
          • account_type string
          • name string
          • slug string
        • project_type string
        • provider string
        • repo_owner string
        • repo_slug string
        • repo_url string
        • slug string
        • status integer
        • title string
      • slug string
      • stack_identifier string
      • started_on_worker_at string
      • status integer
      • status_text string
      • tag string
      • triggered_at string
      • triggered_by string
      • triggered_workflow string
    • paging object

      pagination

      Additional properties are allowed.

      Hide paging attributes Show paging attributes object
      • next string

        Next is the "anchor" for pagination. This value should be passed to the same endpoint to get the next page. Empty/not included if there's no "next" page. Stop paging when there's no "Next" item in the response!

      • page_item_limit integer

        PageItemLimit - per-page item count. A given page might include less items if there's not enough items. This value is the "max item count per page".

      • total_item_count integer

        TotalItemCount - total item count, through "all pages"

  • 400

    Bad Request

    Hide response attribute Show response attribute object
    • message string
  • 401

    Unauthorized

    Hide response attribute Show response attribute object
    • message string
  • 404

    Not Found

    Hide response attribute Show response attribute object
    • message string
  • 500

    Internal Server Error

    Hide response attribute Show response attribute object
    • message string
GET /builds
curl \
 --request GET 'https://api.bitrise.io/v0.1/builds' \
 --header "Authorization: $API_KEY"
Response examples (200)
{
  "data": [
    {
      "abort_reason": "string",
      "branch": "string",
      "build_number": 42,
      "commit_hash": "string",
      "commit_message": "string",
      "commit_view_url": "string",
      "credit_cost": 42,
      "environment_prepare_finished_at": "string",
      "finished_at": "string",
      "is_on_hold": true,
      "is_processed": true,
      "machine_type_id": "string",
      "original_build_params": {},
      "pull_request_id": 42,
      "pull_request_target_branch": "string",
      "pull_request_view_url": "string",
      "repository": {
        "avatar_url": "string",
        "is_disabled": true,
        "is_github_checks_enabled": true,
        "is_public": true,
        "owner": {
          "account_type": "string",
          "name": "string",
          "slug": "string"
        },
        "project_type": "string",
        "provider": "string",
        "repo_owner": "string",
        "repo_slug": "string",
        "repo_url": "string",
        "slug": "string",
        "status": 42,
        "title": "string"
      },
      "slug": "string",
      "stack_identifier": "string",
      "started_on_worker_at": "string",
      "status": 42,
      "status_text": "string",
      "tag": "string",
      "triggered_at": "string",
      "triggered_by": "string",
      "triggered_workflow": "string"
    }
  ],
  "paging": {
    "next": "string",
    "page_item_limit": 42,
    "total_item_count": 42
  }
}
Response examples (400)
{
  "message": "string"
}
Response examples (401)
{
  "message": "string"
}
Response examples (404)
{
  "message": "string"
}
Response examples (500)
{
  "message": "string"
}