Braze Endpoints

braze · Company

Company No Auth Free & Open marketing

# 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 predefined schema. Braze has created many different endpoints with specific requirements that will perform various actions and/or return various data. API access is done using HTTPS web requests to your company's REST API endpoint (this will correspond to your Dashboard URL as shown i

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Campaign Analytics

This endpoint allows you to retrieve a daily series of various stats for a campaign over time. Data returned includes how many messages were sent, opened, clicked, converted, etc., broken down by message channel. ### Components Used -[Campaign Identifier](https://www.braze.com/docs/api/identifier_

https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/data_series?length=7&ending_at=2020-06-28T23:59:59-5:00&campaign_id={{campaign_identifier}}

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/data_series?length=7&ending_at=2020-06-28T23%3A59%3A59-5%3A00&campaign_id=%7B%7Bcampaign_identifier%7D%7D"

import requests
params = {
    "length": "7",
    "ending_at": "2020-06-28T23:59:59-5:00",
    "campaign_id": "{{campaign_identifier}}"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/data_series",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/data_series');
url.searchParams.set('length', '7');
url.searchParams.set('ending_at', '2020-06-28T23:59:59-5:00');
url.searchParams.set('campaign_id', '{{campaign_identifier}}');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/data_series")
	q := baseURL.Query()
	q.Set("length", "7")
	q.Set("ending_at", "2020-06-28T23:59:59-5:00")
	q.Set("campaign_id", "{{campaign_identifier}}")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/data_series")
uri.query = URI.encode_www_form({
  "length" => "7",
  "ending_at" => "2020-06-28T23:59:59-5:00",
  "campaign_id" => "{{campaign_identifier}}"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/data_series?" . http_build_query([
    "length" => "7",
    "ending_at" => "2020-06-28T23:59:59-5:00",
    "campaign_id" => "{{campaign_identifier}}"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Campaign Details

This endpoint allows you to retrieve relevant information on a specified campaign, which can be identified by the `campaign_id`. > The campaign_id for API campaigns can be found on the Developer Console page and the campaign details page within your dashboard or you can use the Campaign List Endpo

https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/details?campaign_id={{campaign_identifier}}

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/details?campaign_id=%7B%7Bcampaign_identifier%7D%7D"

import requests
params = {
    "campaign_id": "{{campaign_identifier}}"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/details",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/details');
url.searchParams.set('campaign_id', '{{campaign_identifier}}');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/details")
	q := baseURL.Query()
	q.Set("campaign_id", "{{campaign_identifier}}")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/details")
uri.query = URI.encode_www_form({
  "campaign_id" => "{{campaign_identifier}}"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/details?" . http_build_query([
    "campaign_id" => "{{campaign_identifier}}"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Campaign List

This endpoint allows you to export a list of campaigns, each of which will include its name, Campaign API Identifier, whether it is an API Campaign, and Tags associated with the campaign. The campaigns are returned in groups of 100 sorted by time of creation (oldest to newest by default). ## Campai

https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/list?page=0&sort_direction=desc&include_archived=false&last_edit.time[gt]=2020-06-28T23:59:59-5:00

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/list?page=0&sort_direction=desc&include_archived=false&last_edit.time[gt]=2020-06-28T23%3A59%3A59-5%3A00"

import requests
params = {
    "page": "0",
    "sort_direction": "desc",
    "include_archived": "false",
    "last_edit.time[gt]": "2020-06-28T23:59:59-5:00"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/list",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/list');
url.searchParams.set('page', '0');
url.searchParams.set('sort_direction', 'desc');
url.searchParams.set('include_archived', 'false');
url.searchParams.set('last_edit.time[gt]', '2020-06-28T23:59:59-5:00');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/list")
	q := baseURL.Query()
	q.Set("page", "0")
	q.Set("sort_direction", "desc")
	q.Set("include_archived", "false")
	q.Set("last_edit.time[gt]", "2020-06-28T23:59:59-5:00")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/list")
uri.query = URI.encode_www_form({
  "page" => "0",
  "sort_direction" => "desc",
  "include_archived" => "false",
  "last_edit.time[gt]" => "2020-06-28T23:59:59-5:00"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/braze.com/1.0.0/campaigns/list?" . http_build_query([
    "page" => "0",
    "sort_direction" => "desc",
    "include_archived" => "false",
    "last_edit.time[gt]" => "2020-06-28T23:59:59-5:00"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Braze Endpoints?

Braze Endpoints is a Company API. Developers commonly use company APIs for:

enriching CRM records with company firmographics
building lead-generation and prospecting tools
verifying business identity and registration details
monitoring competitors and market intelligence
powering B2B data enrichment pipelines

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Braze Endpoints is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗