cURL
curl --request GET \
--url 'https://api.branduo.io/v1/platform/brands?approved=true&page=1' \
--header 'X-Api-Key: YOUR_PLATFORM_KEY'
const response = await fetch("https://api.branduo.io/v1/platform/brands?approved=true&page=1", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
});
const data = await response.json();
import requests
response = requests.request(
"GET",
"https://api.branduo.io/v1/platform/brands?approved=true&page=1",
headers={
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
)
data = response.json()
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.branduo.io/v1/platform/brands?approved=true&page=1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PLATFORM_KEY"
],
]);
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.branduo.io/v1/platform/brands?approved=true&page=1"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "YOUR_PLATFORM_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
require "uri"
require "net/http"
url = URI("https://api.branduo.io/v1/platform/brands?approved=true&page=1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP.const_get("GET".capitalize).new(url)
request["X-Api-Key"] = "YOUR_PLATFORM_KEY"
response = http.request(request)
puts response.read_body
using var client = new HttpClient();
using var request = new HttpRequestMessage(
new HttpMethod("GET"),
"https://api.branduo.io/v1/platform/brands?approved=true&page=1");
request.Headers.TryAddWithoutValidation("X-Api-Key", "YOUR_PLATFORM_KEY");
using var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class BranduoRequest {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.branduo.io/v1/platform/brands?approved=true&page=1"))
.header("X-Api-Key", "YOUR_PLATFORM_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
{
"items": [
{
"shop": "northwind-goods.myshopify.com",
"approved": true,
"stage": "live",
"error": null,
"types": [
{
"type": "post-purchase",
"placementOn": true,
"live": true,
"pausedReason": null
}
]
},
{
"shop": "harbor-lantern.myshopify.com",
"approved": false,
"stage": "approve",
"error": null
}
],
"total": 2,
"page": 1
}
Partner API
List brands
Page through the merchants who approved your platform, and the brands you synced.
GET
/
platform
/
brands
cURL
curl --request GET \
--url 'https://api.branduo.io/v1/platform/brands?approved=true&page=1' \
--header 'X-Api-Key: YOUR_PLATFORM_KEY'
const response = await fetch("https://api.branduo.io/v1/platform/brands?approved=true&page=1", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
});
const data = await response.json();
import requests
response = requests.request(
"GET",
"https://api.branduo.io/v1/platform/brands?approved=true&page=1",
headers={
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
)
data = response.json()
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.branduo.io/v1/platform/brands?approved=true&page=1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PLATFORM_KEY"
],
]);
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.branduo.io/v1/platform/brands?approved=true&page=1"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "YOUR_PLATFORM_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
require "uri"
require "net/http"
url = URI("https://api.branduo.io/v1/platform/brands?approved=true&page=1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP.const_get("GET".capitalize).new(url)
request["X-Api-Key"] = "YOUR_PLATFORM_KEY"
response = http.request(request)
puts response.read_body
using var client = new HttpClient();
using var request = new HttpRequestMessage(
new HttpMethod("GET"),
"https://api.branduo.io/v1/platform/brands?approved=true&page=1");
request.Headers.TryAddWithoutValidation("X-Api-Key", "YOUR_PLATFORM_KEY");
using var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class BranduoRequest {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.branduo.io/v1/platform/brands?approved=true&page=1"))
.header("X-Api-Key", "YOUR_PLATFORM_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
{
"items": [
{
"shop": "northwind-goods.myshopify.com",
"approved": true,
"stage": "live",
"error": null,
"types": [
{
"type": "post-purchase",
"placementOn": true,
"live": true,
"pausedReason": null
}
]
},
{
"shop": "harbor-lantern.myshopify.com",
"approved": false,
"stage": "approve",
"error": null
}
],
"total": 2,
"page": 1
}
Returns your platform’s merchants, 50 per page. Each item has the same shape as Get a brand.
cURL
curl --request GET \
--url 'https://api.branduo.io/v1/platform/brands?approved=true&page=1' \
--header 'X-Api-Key: YOUR_PLATFORM_KEY'
const response = await fetch("https://api.branduo.io/v1/platform/brands?approved=true&page=1", {
method: "GET",
headers: {
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
});
const data = await response.json();
import requests
response = requests.request(
"GET",
"https://api.branduo.io/v1/platform/brands?approved=true&page=1",
headers={
"X-Api-Key": "YOUR_PLATFORM_KEY",
},
)
data = response.json()
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.branduo.io/v1/platform/brands?approved=true&page=1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: YOUR_PLATFORM_KEY"
],
]);
$response = curl_exec($curl);
curl_close($curl);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://api.branduo.io/v1/platform/brands?approved=true&page=1"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "YOUR_PLATFORM_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
require "uri"
require "net/http"
url = URI("https://api.branduo.io/v1/platform/brands?approved=true&page=1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP.const_get("GET".capitalize).new(url)
request["X-Api-Key"] = "YOUR_PLATFORM_KEY"
response = http.request(request)
puts response.read_body
using var client = new HttpClient();
using var request = new HttpRequestMessage(
new HttpMethod("GET"),
"https://api.branduo.io/v1/platform/brands?approved=true&page=1");
request.Headers.TryAddWithoutValidation("X-Api-Key", "YOUR_PLATFORM_KEY");
using var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class BranduoRequest {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.branduo.io/v1/platform/brands?approved=true&page=1"))
.header("X-Api-Key", "YOUR_PLATFORM_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
What’s listed
- Approvals of your platform, oldest change first: merchants who approved you, and merchants whose approval ended (they disconnected you or uninstalled Branduo).
- Then brands you synced with Sync brands that have no approval. These show only
not_connectedorin_progress, unless you sent the store the connect link.
Query parameters
true: only merchants with an active approval. false: ended approvals and
synced brands with no approval. Omit it for everything.An ISO-8601 UTC instant, such as
2026-11-01T00:00:00Z. Returns only brands
whose approval or sync row changed at or after it. Use it to pick up
approvals and disconnects since your last call.1-based page number. See Pagination.
Response
The brands on this page, in the Get a brand
shape.
Errors
| Status | error | Cause |
|---|---|---|
401 | unauthorized | The platform key is missing or invalid. |
403 | platform_inactive | Your platform isn’t active on Branduo. |
{
"items": [
{
"shop": "northwind-goods.myshopify.com",
"approved": true,
"stage": "live",
"error": null,
"types": [
{
"type": "post-purchase",
"placementOn": true,
"live": true,
"pausedReason": null
}
]
},
{
"shop": "harbor-lantern.myshopify.com",
"approved": false,
"stage": "approve",
"error": null
}
],
"total": 2,
"page": 1
}

