The Branch APIs let you query and export data, create Branch Links, generate custom Branch QR codes, and more.
Data APIs
| API | Purpose | Type of data | Timing | Export window |
|---|---|---|---|---|
| Daily Exports | Export all device-level data in batches on a daily basis. | Log | Delayed and batched | Rolling 7 days |
| Custom Exports | Export select device-level data using your own filters. | Log | Delayed and batched | Rolling 120 days |
| Scheduled Log Exports | Set up a recurring export of select device-level data. | Log | Delayed and batched (hourly or daily) | — |
| Cross-Events Export | Query and compare large pools of data across multiple sources. | Aggregate | Delayed and batched | Rolling 2 years |
| Aggregate | Pull aggregate Branch data filtered for limited-access users. | Aggregate | Delayed and batched | Rolling 2 years |
| Cohort | Pull cohort data to understand user behavior and performance over time. | Aggregate | Delayed and batched | Rolling 2 years |
| Query | Export select campaign-level data. | Aggregate | Real time | Rolling 2 years |
Functional APIs
| API | Purpose |
|---|---|
| Deep Linking | Create, read, update, and delete Branch Links. |
| Quick Links | Programmatically create, update, and bulk-manage Branch Quick Links. |
| QR Code | Programmatically generate and customize Branch-powered QR codes. |
| Events | Track events and conversions for your app. |
| Attribution | Attribute app sessions to your active campaigns. |
| App | View and update an existing Branch app configuration. |
| Data Subject Request | GDPR and CCPA workflows for accessing and erasing user or device data from Branch. |
Access
Availability varies by Branch plan. See Branch pricing.
Authentication
All Branch APIs authenticate with your Branch Key. Most endpoints accept the key in the JSON request body as branch_key; export and data APIs accept an Access Token.
Retrieve your Branch Key
In the New Branch experience:
- Navigate to Configuration > Security & Access > Credentials.
- Use the copy icon to copy your Branch Key.
In the legacy Branch experience:
- Navigate to Account > Settings > Profile.
- Use the copy icon to copy your Branch Key.
See the Credentials guide for managing Access Tokens, organization IDs, and additional credentials.
Conventions
- Base URL:
https://api2.branch.io - Versioning: included in the path (
/v1/,/v2/,/v3/) - Content type:
application/jsonunless otherwise noted - Errors: every endpoint returns a JSON error body of
{ "error": { "message": string, "code": integer } } - Rate limits: documented per API in the operation reference