API keys and authentication

To try out API calls from this documentation:

Enter your API key as the apikey header in the Credentials section

Select the Sandbox as the Base URL

Under Path Params, enter the orgId associated with the API key

Press the green "Try It!" button to send the request

Test this using the Get Organization endpoint

Requests

While viewing any Branch endpoint in this reference documentation you can find examples of the code for making API requests, in the code language you have selected. Here for example is the Get Payroll Calendar endpoint entry, showing how you would code a request for this endpoint using Ruby (click to enlarge).

Responses

To see response examples, click the arrow next to the response listed, as shown, or click to select from a list in cases where there are multiple responses:

OpenAPI JSON

The Branch API Reference documentation is generated from an OpenAPI 3.0.1 specification available in JSON here.