{"_id":"590a04f5ed80861900cbc775","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"},"project":"55b2d5baa74a380d00e290c4","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-20T00:13:39.922Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X GET \\\n    -H 'Authorization: Bearer {{access_token}}' \\\n    'https://api.buddybuild.com/v1/apps/{{app_id}}/branches'"}]},"method":"get","results":{"codes":[{"name":"","code":"[\n  {\n    \"name\": \"master\"\n  },\n  {\n    \"name\": \"release\"\n  }\n]","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"58aa34b3e1510419001d3a2a","ref":"","in":"path","required":true,"desc":"App identifier","default":"","type":"string","name":"app_id"},{"_id":"58ccc7341a9a972300b2c286","ref":"","in":"query","required":false,"desc":"Include deleted branches in the response","default":"false","type":"boolean","name":"includeDeleted"}],"url":"/apps/:app_id/branches"},"isReference":true,"order":2,"body":"Use this method to retrieve a list of branches associated with the specified app.\n\nDeleted branches are not included in the response by default. To include deleted branches in the response set the `includeDeleted` query parameter to `true`.\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-branches","type":"get","title":"List branches"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App identifier

Query Params

includeDeleted:
booleanfalse
Include deleted branches in the response

Examples


Result Format


Documentation

Use this method to retrieve a list of branches associated with the specified app. Deleted branches are not included in the response by default. To include deleted branches in the response set the `includeDeleted` query parameter to `true`. [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 }}