# Braze Endpoints API

> Braze Endpoints API on Apizie: 31 endpoints (Campaign Analytics, Campaign Details, Campaign List, Canvas Data Series Analytics, …) returned as clean JSON through one API key. 31 endpoints are live now. Call it over REST at https://apizie.tech/v1/business:braze/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:braze`
- Category: Business
- Status: live
- Source: https://braze.com
- Page: https://apizie.tech/api/business/braze
- OpenAPI: https://apizie.tech/api/business/braze/openapi.json

# Braze API Overview Braze provides a high performance REST API to allow you to track users, send messages, export data, and more. A REST API is a way to programmatically transfer information over the web using a…

## Endpoints

### Campaign Analytics
`GET https://apizie.tech/v1/business:braze/campaign-analytics`

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaign_id | string | no | (Required) String Campaign API identifier |
| length | string | no | (Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive |
| ending_at | string | no | (Optional) DateTime (ISO 8601 string) Date on which the data series should end - defaults to time of the request |

### Campaign Details
`GET https://apizie.tech/v1/business:braze/campaign-details`

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaign_id | string | no | (Required) String Campaign API identifier |

### Campaign List
`GET https://apizie.tech/v1/business:braze/campaign-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | string | no | (Optional) Integer The page of campaigns to return, defaults to 0 (returns the first set of up to 100) |
| include_archived | string | no | (Optional) Boolean Whether or not to include archived campaigns, defaults to false |
| sort_direction | string | no | (Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If… |
| last_edit.time[gt] | string | no | (Optional) DateTime (ISO 8601 string) Filters the results and only returns campaigns that were edited greater than the time provided till… |

### Canvas Data Series Analytics
`GET https://apizie.tech/v1/business:braze/canvas-data-series-analytics`

| Parameter | Type | Required | Description |
|---|---|---|---|
| canvas_id | string | no | (Required) String Canvas API Identifier |
| ending_at | string | no | (Required) DateTime (ISO 8601 string) Date on which the data export should end - defaults to time of the request |
| starting_at | string | no | (Optional) DateTime (ISO 8601 string) Date on which the data export should begin (either length or starting_at are required) |
| length | string | no | (Optional) DateTime (ISO 8601 string) Max number of days before ending_at to include in the returned series - must be between 1 and 14… |
| include_variant_breakdown | string | no | (Optional) Boolean Whether or not to include variant stats (defaults to false) |
| include_step_breakdown | string | no | (Optional) Boolean Whether or not to include step stats (defaults to false) |
| include_deleted_step_data | string | no | (Optional) Boolean Whether or not to include step stats for deleted steps (defaults to false) |

### Canvas Data Analytics Summary
`GET https://apizie.tech/v1/business:braze/canvas-data-analytics-summary`

| Parameter | Type | Required | Description |
|---|---|---|---|
| canvas_id | string | no | (Required) String Canvas API identifier |
| ending_at | string | no | (Required) DateTime (ISO 8601 string) Date on which the data export should end - defaults to time of the request |
| starting_at | string | no | (Optional) DateTime (ISO 8601 string) Date on which the data export should begin (either length or starting_at required) |
| length | string | no | (Optional) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 14 inclusive (either… |
| include_variant_breakdown | string | no | (Optional) Boolean Whether or not to include variant stats (defaults to false) |
| include_step_breakdown | string | no | (Optional) Boolean Whether or not to include step stats (defaults to false) |
| include_deleted_step_data | string | no | (Optional) Boolean Whether or not to include step stats for deleted steps (defaults to false) |

### Canvas Details
`GET https://apizie.tech/v1/business:braze/canvas-details`

| Parameter | Type | Required | Description |
|---|---|---|---|
| canvas_id | string | no | (Required) String Canvas API Identifier |

### Canvas List
`GET https://apizie.tech/v1/business:braze/canvas-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | string | no | (Optional) Integer The page of Canvases to return, defaults to `0` (returns the first set of up to 100) |
| include_archived | string | no | (Optional) Boolean Whether or not to include archived Canvases, defaults to `false`. |
| sort_direction | string | no | (Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If… |
| last_edit.time[gt] | string | no | (Optional) DateTime (ISO 8601 string) Filters the results and only returns Canvases that were edited greater than the time provided till… |

### Schedule API Triggered Canvases
`POST https://apizie.tech/v1/business:braze/schedule-api-triggered-canvases`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### See Content Block Information
`GET https://apizie.tech/v1/business:braze/see-content-block-information`

| Parameter | Type | Required | Description |
|---|---|---|---|
| content_block_id | string | no | (Required) String The Content Block ID. This can be found by either listing Content Block information or going to the Developer Console,… |
| include_inclusion_data | string | no | (Optional) Boolean When set to ‘true’, the API returns back the Message Variation API ID of Campaigns and Canvases where this content… |

### List Available Content Blocks
`GET https://apizie.tech/v1/business:braze/list-available-content-blocks`

| Parameter | Type | Required | Description |
|---|---|---|---|
| modified_after | string | no | (Optional) String in ISO 8601 Retrieve only content blocks updated at or after the given time. |
| modified_before | string | no | (Optional) String in ISO 8601 Retrieve only content blocks updated at or before the given time. |
| limit | string | no | (Optional) Positive Number Maximum number of content blocks to retrieve, default to 100 if not provided, maximum acceptable value is 1000. |
| offset | string | no | (Optional) Positive Number Number of content blocks to skip before returning rest of the templates that fit the search criteria. |

### Query Hard Bounced Emails
`GET https://apizie.tech/v1/business:braze/query-hard-bounced-emails`

| Parameter | Type | Required | Description |
|---|---|---|---|
| start_date | string | no | (Optional*) String in YYYY-MM-DD format Start date of the range to retrieve hard bounces, must be earlier than `end_date`. This is treated… |
| end_date | string | no | (Optional*) String in YYYY-MM-DD format String in YYYY-MM-DD format. End date of the range to retrieve hard bounces. This is treated as… |
| limit | string | no | (Optional) Integer Optional field to limit the number of results returned. Defaults to 100, maximum is 500. |
| offset | string | no | (Optional) Integer Optional beginning point in the list to retrieve from. |
| email | string | no | (Optional*) String If provided, we will return whether or not the user has hard bounced. *You must provide either an `email` or a… |

### Query List of Unsubscribed Email Addresses
`GET https://apizie.tech/v1/business:braze/query-list-of-unsubscribed-email-addresses`

| Parameter | Type | Required | Description |
|---|---|---|---|
| start_date | string | no | (Optional*) String in YYYY-MM-DD format Start date of the range to retrieve unsubscribes, must be earlier than end_date. This is treated… |
| end_date | string | no | (Optional*) String in YYYY-MM-DD format End date of the range to retrieve unsubscribes. This is treated as midnight in UTC time by the API. |
| limit | string | no | (Optional) Integer Optional field to limit the number of results returned. Limit must be greater than 1. Defaults to 100, maximum is 500. |
| offset | string | no | (Optional) Integer Optional beginning point in the list to retrieve from |
| sort_direction | string | no | (Optional) String Pass in the value `asc` to sort unsubscribes from oldest to newest. Pass in `desc` to sort from newest to oldest. If… |
| email | string | no | (Optional*) String If provided, we will return whether or not the user has unsubscribed |

### Custom Events Analytics
`GET https://apizie.tech/v1/business:braze/custom-events-analytics`

| Parameter | Type | Required | Description |
|---|---|---|---|
| event | string | no | (Required) String The name of the custom event for which to return analytics |
| length | string | no | (Required) Integer Max number of units (days or hours) before ending_at to include in the returned series - must be between 1 and 100… |
| unit | string | no | (Optional) String Unit of time between data points - can be "day" or "hour" (defaults to "day") |
| ending_at | string | no | (Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request |
| app_id | string | no | (Optional) String App API identifier retrieved from the Developer Console to limit analytics to a specific app |
| segment_id | string | no | (Optional) String Segment API identifier indicating the analytics enabled segment for which event analytics should be returned |

### Custom Events List
`GET https://apizie.tech/v1/business:braze/custom-events-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | string | no | (Optional) Integer The page of event names to return, defaults to 0 (returns the first set of up to 250) |

### News Feed Card Analytics
`GET https://apizie.tech/v1/business:braze/news-feed-card-analytics`

| Parameter | Type | Required | Description |
|---|---|---|---|
| card_id | string | no | (Required) String Card API identifier |
| length | string | no | (Required) Integer Max number of units (days or hours) before ending_at to include in the returned series - must be between 1 and 100… |
| unit | string | no | (Optional) String Unit of time between data points - can be "day" or "hour" (defaults to "day") |
| ending_at | string | no | (Optional) DateTime (ISO 8601 string) Date on which the data series should end - defaults to time of the request |

### News Feed Cards Details
`GET https://apizie.tech/v1/business:braze/news-feed-cards-details`

| Parameter | Type | Required | Description |
|---|---|---|---|
| card_id | string | no | (Required) String Card API identifier |

### News Feed Cards List
`GET https://apizie.tech/v1/business:braze/news-feed-cards-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | string | no | (Optional) Integer The page of cards to return, defaults to 0 (returns the first set of up to 100) |
| include_archived | string | no | (Optional) Boolean Whether or not to include archived cards, defaults to false |
| sort_direction | string | no | (Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If… |

### Daily Active Users by Date
`GET https://apizie.tech/v1/business:braze/daily-active-users-by-date`

| Parameter | Type | Required | Description |
|---|---|---|---|
| length | string | no | (Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive |
| ending_at | string | no | (Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request |
| app_id | string | no | (Optional) String App API identifier; if excluded, results for all apps in app group will be returned |

### Monthly Active Users for Last 30 Days
`GET https://apizie.tech/v1/business:braze/monthly-active-users-for-last30-days`

| Parameter | Type | Required | Description |
|---|---|---|---|
| length | string | no | (Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive |
| ending_at | string | no | (Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request |
| app_id | string | no | (Optional) String App API identifier; if excluded, results for all apps in app group will be returned |

### Daily New Users by Date
`GET https://apizie.tech/v1/business:braze/daily-new-users-by-date`

| Parameter | Type | Required | Description |
|---|---|---|---|
| length | string | no | (Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive |
| ending_at | string | no | (Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request |
| app_id | string | no | (Optional) String App API identifier; if excluded, results for all apps in app group will be returned |

### KPIs for Daily App Uninstalls by Date
`GET https://apizie.tech/v1/business:braze/kp-is-for-daily-app-uninstalls-by-date`

| Parameter | Type | Required | Description |
|---|---|---|---|
| length | string | no | (Required) Integer Max number of days before ending_at to include in the returned series - must be between 1 and 100 inclusive |
| ending_at | string | no | (Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request |
| app_id | string | no | (Optional) String App API identifier; if excluded, results for all apps in app group will be returned |

### Get Upcoming Scheduled Campaigns and Canvases
`GET https://apizie.tech/v1/business:braze/get-upcoming-scheduled-campaigns-and-canvases`

| Parameter | Type | Required | Description |
|---|---|---|---|
| end_time | string | no | (Required) String in ISO 8601 format End date of the range to retrieve upcoming scheduled Campaigns and Canvases. This is treated as… |

### Segment Analytics
`GET https://apizie.tech/v1/business:braze/segment-analytics`

| Parameter | Type | Required | Description |
|---|---|---|---|
| segment_id | string | no | (Required) String Segment API identifier. |
| length | string | no | (Required) Integer Max number of days before `ending_at` to include in the returned series - must be between 1 and 100 inclusive. |
| ending_at | string | no | (Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request. |

### Segment Details
`GET https://apizie.tech/v1/business:braze/segment-details`

| Parameter | Type | Required | Description |
|---|---|---|---|
| segment_id | string | no | (Required) String Segment API identifier |

### Segment List
`GET https://apizie.tech/v1/business:braze/segment-list`

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | string | no | (Optional) Integer The page of segments to return, defaults to 0 (returns the first set of up to 100) |
| sort_direction | string | no | (Optional) String Pass in the value `desc` to sort by creation time from newest to oldest. Pass in `asc` to sort from oldest to newest. If… |

### Send Analytics
`GET https://apizie.tech/v1/business:braze/send-analytics`

| Parameter | Type | Required | Description |
|---|---|---|---|
| campaign_id | string | no | (Required) String Campaign API identifier. |
| send_id | string | no | (Required) String Send API identifier. |
| length | string | no | (Required) Integer Maximum number of days before `ending_at` to include in the returned series. Must be between 1 and 100 inclusive. |
| ending_at | string | no | (Optional) Datetime ISO 8601 string Date on which the data series should end. Defaults to time of the request. |

### App Sessions by Time
`GET https://apizie.tech/v1/business:braze/app-sessions-by-time`

| Parameter | Type | Required | Description |
|---|---|---|---|
| length | string | no | (Required) Integer Max number of units (days or hours) before ending_at to include in the returned series - must be between 1 and 100… |
| unit | string | no | (Optional) String Unit of time between data points - can be "day" or "hour" (defaults to "day"). |
| ending_at | string | no | (Optional) DateTime (ISO 8601 string) Point in time when the data series should end - defaults to time of the request. |
| app_id | string | no | (Optional) String App API identifier retrieved from the Developer Console to limit analytics to a specific app. |
| segment_id | string | no | (Optional) String Segment API identifier indicating the analytics enabled segment for which sessions should be returned. |

### List User's Subscription Group Status - SMS
`GET https://apizie.tech/v1/business:braze/list-user-s-subscription-group-status-sms`

| Parameter | Type | Required | Description |
|---|---|---|---|
| subscription_group_id | string | no | (Required) String The `id` of your subscription group. |
| external_id | string | no | (Required*) String The `external_id` of the user (must include at least one and at most 50 `external_ids`). Only external_id or phone is… |
| phone | string | no | (Required*) String The phone number of the user (must include at least one phone number and at most 50 phone numbers). The recommendation… |

### List User's Subscription Group - SMS
`GET https://apizie.tech/v1/business:braze/list-user-s-subscription-group-sms`

| Parameter | Type | Required | Description |
|---|---|---|---|
| external_id | string | no | (Required*) String The external_id of the user. Must include at least one and at most 50 `external_ids`. |
| limit | string | no | (Optional) Integer The limit on the maximum number of results returned. Default (and max) limit is 100. |
| offset | string | no | (Optional) Integer Number of templates to skip before returning rest of the templates that fit the search criteria. |
| phone | string | no | (Required*) String The phone number of the user (must include at least one phone number and at most 50 phone numbers). The recommendation… |

### See Email Template Information
`GET https://apizie.tech/v1/business:braze/see-email-template-information`

| Parameter | Type | Required | Description |
|---|---|---|---|
| email_template_id | string | no | (Required) String Your email template's API Identifier. |

### List Available Email Templates
`GET https://apizie.tech/v1/business:braze/list-available-email-templates`

| Parameter | Type | Required | Description |
|---|---|---|---|
| modified_after | string | no | (Optional) String in ISO 8601 Retrieve only templates updated at or after the given time. |
| modified_before | string | no | (Optional) String in ISO 8601 Retrieve only templates updated at or before the given time |
| limit | string | no | (Optional) Positive Number Maximum number of templates to retrieve, default to 100 if not provided, maximum acceptable value is 1000. |
| offset | string | no | (Optional) Positive Number Number of templates to skip before returning rest of the templates that fit the search criteria. |

## Example
```
curl "https://apizie.tech/v1/business:braze/campaign-analytics" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Braze Endpoints API?
Create a free Apizie key, then send GET https://apizie.tech/v1/business:braze/campaign-analytics with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Braze Endpoints API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the Braze Endpoints API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:braze.

### What is the status of the Braze Endpoints API?
Live: works with just an Apizie key