List branches

{
  "base":     "\https://api.buddybuild.com/v1",
  "endpoint": "/apps/:app_id:/branches",
  "method":   "get",
  "params": {
    "headers": [
      {
        "name": "Authorization",
        "type": "Bearer :api-access-token:",
        "req":  true,
        "cue":  "Enter your API access token"
      }
    ],
    "path":   [
      {
        "name": ":app_id:",
        "type": "string",
        "desc": 'App identifier',
        "req":  true,
        "cue":  'Enter an app id'
      }
    ],
    "query":  [
      {
        "name": "includeDeleted",
        "type": "boolean",
        "desc": 'Set to "true" to include deleted branches',
        "req":  false,
        "cue":  'Enter "true" to include deleted branches'
      }
    ],
    "body":   []
  },
  "authentication": "required"
}

Definition

Placeholder for the definition; auto-generated from JSON above.

Use this method to retrieve a list of branches associated with the specified app_id.

Deleted branches are not included in the response by default. To include deleted branches in the response set the includeDeleted query parameter to true.

Note

Looking for your API access token?

Parameters

Required = *

Placeholder for the endpoint parameters; auto-generated from JSON above.

curl
curl -X GET \
  -H 'Authorization: Bearer :api-access-token:' \
  'https://api.buddybuild.com/v1/apps/:app_id:/branches'
jquery
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://api.buddybuild.com/v1/apps/:app_id:/branches?includeDeleted=true",
  "method": "GET",
  "headers": {
    "authorization": "Bearer :api-access-token:"
  }
}
$.ajax(settings).done(function (response) {
  console.log(response);
});
Response
[
  {
    "name": "master"
  },
  {
    "name": "release"
  }
]

results matching ""

    No results matching ""