List all builds of an app

GET /apps/{app-slug}/builds

List all the builds of a specified Bitrise app. Set parameters to filter builds: for example, you can search for builds run with a given workflow or all builds that were triggered by Pull Requests. It returns all the relevant data of the build.

Path parameters

  • app-slug string Required

    App slug

Query parameters

  • sort_by string

    Order of builds: sort them based on when they were created or the time when they were triggered

    Values are running_first or created_at.

  • branch string

    The branch which was built

  • workflow string

    The name of the workflow used for the build

  • commit_message string

    The commit message of the build

  • trigger_event_type string

    The event that triggered the build (push, pull-request, tag)

  • pull_request_id integer

    The id of the pull request that triggered the build

  • build_number integer

    The build number

  • after integer

    List builds run after a given date (Unix Timestamp)

  • before integer

    List builds run before a given date (Unix Timestamp)

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

  • is_pipeline_build boolean

    Whether the builds are part of a pipeline or not

  • 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
      • is_status_sent boolean
      • log_format string
      • machine_type_id string
      • original_build_params object

        Additional properties are allowed.

      • pipeline_workflow_id string
      • pull_request_id integer
      • pull_request_target_branch string
      • pull_request_view_url string
      • rebuildable boolean
      • 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 /apps/{app-slug}/builds
curl \
 --request GET 'https://api.bitrise.io/v0.1/apps/{app-slug}/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,
      "is_status_sent": true,
      "log_format": "string",
      "machine_type_id": "string",
      "original_build_params": {},
      "pipeline_workflow_id": "string",
      "pull_request_id": 42,
      "pull_request_target_branch": "string",
      "pull_request_view_url": "string",
      "rebuildable": true,
      "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"
}