Trying APIs

  • Updated on Jul 31, 2025
  • Published on Mar 4, 2025
Prev Next

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

Note

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 Cross-Events Export API, you will need your app ID and your access token:

Branch API keys and parameters for app ID and access token authentication explained clearly.

Branch API authentication section with fields for appId and accessToken input.

Required Parameters

In order for the APIs to function properly, you need to have the correct input/format, and make sure to provide values for all required fields:

Branch API body parameters including start date, end date, and dimensions array example.

Branch API JSON code snippet showing date range and filter parameters for data analysis.

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 & see response button and get a response directly on the page.

Branch API request body showing date range and filter parameters for user data.