{"_id":"590a04f5ed80861900cbc776","parentDoc":null,"category":{"_id":"590a04f3ed80861900cbc73a","__v":0,"project":"55b2d5baa74a380d00e290c4","version":"590a04f2ed80861900cbc737","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-04-22T20:33:51.487Z","from_sync":false,"order":2,"slug":"rest-api","title":"REST API"},"user":"55b2d5626862a10d00887af9","version":{"_id":"590a04f2ed80861900cbc737","project":"55b2d5baa74a380d00e290c4","__v":4,"createdAt":"2017-05-03T16:27:30.085Z","releaseDate":"2017-05-03T16:27:30.085Z","categories":["590a04f3ed80861900cbc738","590a04f3ed80861900cbc739","590a04f3ed80861900cbc73a","590a04f3ed80861900cbc73b","590a04f3ed80861900cbc73c","590a04f3ed80861900cbc73d","590a04f3ed80861900cbc73e","590a04f3ed80861900cbc73f","590a04f3ed80861900cbc740","590a04f3ed80861900cbc741","590a04f3ed80861900cbc742","590a04f3ed80861900cbc743","590a04f3ed80861900cbc744","590a04f3ed80861900cbc745","590a04f3ed80861900cbc746","590a04f3ed80861900cbc747","590a04f3ed80861900cbc748","590a04f3ed80861900cbc749","590a04f3ed80861900cbc74a","590a04f3ed80861900cbc74b","590a04f3ed80861900cbc74c","590a04f3ed80861900cbc74d","59124949de13f61900336a7a","5914b04e7c2c552d008b7104","5914b47242c6a22300b9dc20"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"7.0.0","version":"7"},"__v":0,"project":"55b2d5baa74a380d00e290c4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-03-18T22:30:47.567Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"curl -X GET \\\n    -H 'Authorization: Bearer {{access_token}}' \\\n    'https://api.buddybuild.com/v1/apps/{{app_id}}/builds?branch={{branch}}&scheme={{scheme}}&status={{status}}&limit={{limit}}'","language":"curl"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"[{\n  \"_id\": \"58b899061baced0100616172\",\n  \"app_id\": \"58b897fb1baced010061616e\",\n  \"repo_url\": \"git:::at:::github.com:myorg/2048.git\",\n  \"build_status\": \"failed\",\n  \"finished\": true,\n  \"commit_info\": {\n    \"tags\": [],\n    \"branch\": \"master\",\n    \"commit_sha\": \"54a9faeccc0979aaa16f3226562a24fb3330e9f0\",\n    \"author\": \"David Pie\",\n    \"message\": \"Add new crash type\",\n    \"html_url\": \"https://github.com/myorg/2048/commit/54a9faeccc0979aaa16f3226562a24fb3330e9f0\"\n  },\n  \"build_number\": 2,\n  \"created_at\": \"2017-03-02T22:13:26.728Z\",\n  \"started_at\": \"2017-03-02T22:15:11.381Z\",\n  \"finished_at\": \"2017-03-02T22:20:06.432Z\",\n  \"test_summary\": {\n    \"tests_count\": 10,\n    \"tests_passed\": 9,\n    \"code_coverage_percentage\": 0.6878079796534735\n  },\n  \"links\": {\n    \"download\": [\n      {\n        \"name\": \"m2048 - Release\",\n        \"url\": \"https://dashboard.buddybuild.com/api/download/download-ipa?buildID=58b899061baced0100616172\"\n      }\n    ],\n    \"install\": [\n      {\n        \"name\": \"m2048 - Release\",\n        \"url\": \"https://dashboard.buddybuild.com/download/ios?buildID=58b899061baced0100616172\"\n      }\n    ]\n  }\n}]","name":""}]},"auth":"required","params":[{"_id":"57b41a41da7a913200179de4","ref":"","in":"path","required":true,"desc":"App identifier","default":"","type":"string","name":"app_id"},{"_id":"57b41a41da7a913200179de3","ref":"","in":"query","required":false,"desc":"URL encoded name of the branch","default":"","type":"string","name":"branch"},{"_id":"58b56edc4b2d4c2300abd662","ref":"","in":"query","required":false,"desc":"URL encoded name of the scheme (iOS only)","default":"","type":"string","name":"scheme"},{"_id":"57b41a41da7a913200179de2","ref":"","in":"query","required":false,"desc":"One of `cancelled`, `failed`, `queued`, `running`, `success`","default":"","type":"string","name":"status"},{"_id":"58cdb59e32f9b90f002e7421","ref":"","in":"query","required":false,"desc":"Number of builds to list in the response. You can list up to 100 builds.","default":"5","type":"int","name":"limit"}],"url":"/apps/:app_id/builds"},"isReference":true,"order":3,"body":"Use this method to list the most recent builds for the specified app. The number of results are limited to the 5 most recent builds by default, but you can request up to 100 builds using the `limit` query parameter.\n\nYou can apply optional filters to the query:\n\n* Specify a branch name (`branch`) to restrict the output to the most recent builds for the specified branch. The branch name must be URL encoded.\n* Specify a build status (`status`) to restrict the output to the most recent builds for the specified build status. Valid values are `cancelled`, `failed`, `queued`, `running`, or `success`. Use this to get a list of recently failed builds for example.\n\nFor iOS apps, you can also apply the optional scheme filter to the query:\n\n* Each build of a multi-scheme build is returned separately. Specify an iOS scheme name (`scheme`) to restrict the output to the most recent builds for the specified scheme. The scheme name must be URL encoded.\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Read more about [authenticating with buddybuild](http://docs.buddybuild.com/docs/api-developer-guide#authentication) or show <a href=\\\"https://dashboard.buddybuild.com/account/access-token\\\" target=\\\"_blank\\\">your personal access token</a>.\",\n  \"title\": \"Looking for your API access token?\"\n}\n[/block]","excerpt":"","slug":"list-builds","type":"get","title":"List builds"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App identifier

Query Params

branch:
string
URL encoded name of the branch
scheme:
string
URL encoded name of the scheme (iOS only)
status:
string
One of `cancelled`, `failed`, `queued`, `running`, `success`
limit:
integer5
Number of builds to list in the response. You can list up to 100 builds.

Examples


Result Format


Documentation

Use this method to list the most recent builds for the specified app. The number of results are limited to the 5 most recent builds by default, but you can request up to 100 builds using the `limit` query parameter. You can apply optional filters to the query: * Specify a branch name (`branch`) to restrict the output to the most recent builds for the specified branch. The branch name must be URL encoded. * Specify a build status (`status`) to restrict the output to the most recent builds for the specified build status. Valid values are `cancelled`, `failed`, `queued`, `running`, or `success`. Use this to get a list of recently failed builds for example. For iOS apps, you can also apply the optional scheme filter to the query: * Each build of a multi-scheme build is returned separately. Specify an iOS scheme name (`scheme`) to restrict the output to the most recent builds for the specified scheme. The scheme name must be URL encoded. [block:callout] { "type": "info", "body": "Read more about [authenticating with buddybuild](http://docs.buddybuild.com/docs/api-developer-guide#authentication) or show <a href=\"https://dashboard.buddybuild.com/account/access-token\" target=\"_blank\">your personal access token</a>.", "title": "Looking for your API access token?" } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}