Trying APIs

Overview

Each of the Branch APIs has a fully flushed out reference page which includes general API information, usage instructions, and additional resources.

While you are on an API’s reference page, you can also try out the API by adding your preferred query/body parameters and get a response directly on the page.

Authentication

Permissions

Make sure your Branch account has sufficient access rights to your Branch app.

Different APIs require different types of authentication using your Branch credentials. For example, for the Aggregate API, you will need your Branch app_id/organization_id and your developer user Access-Token, while the Daily Export API just requires your branch_key and branch_secret.

920

Required Parameters

In order for the APIs to function properly, you need to have the correct input/format for the respective parameter.

1252

Try It!

After you have the correct authentication credentials and filled out the required parameters for the API, you can then click the Try It! button and get a response directly on the page.

2520