The buddybuild API is a RESTful interface, providing programmatic access to much of the data in the system. It provides predictable URLs for accessing resources, and uses built-in HTTP features to receive commands and return responses. This makes it easy to communicate with from a wide variety of environments, from command-line utilities to client libraries to apps.

The API accepts JSON or form-encoded content in requests and returns JSON content in all of its responses, including errors. Only the UTF-8 character encoding is supported for both requests and responses.

At this time the buddybuild API responds to a single version of the API. All resources are available under the https://api.buddybuild.com/v1/ base URL.

Each user in buddybuild has their own unique Personal Access Token, which can be used to talk to buddybuild on behalf of the user.

Many of the buddybuild API methods accept URL parameters that must be percent encoded to avoid conflicts with reserved characters. Reserved characters are those characters that sometimes have special meaning in a URL.

For example, when passing a Git branch named feature/find&replace as a branch parameter it must be percent encoded as feature%2Ffind%26replace.

Sometimes requests to the API are not successful. Failures can occur for a wide range of reasons. In all cases, the API returns an HTTP Status Code that indicates the reason for the failure, with a response body in JSON format containing additional information.

In the event of an error, the response body contains an error field at the top level. This error message provides more detail about the error that occurred, if available.