> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pinnacle.sh/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pinnacle.sh/_mcp/server.

# List Brands

POST https://api.pinnacle.sh/brands/list
Content-Type: application/json

List all brands with optional filtering and pagination. Results are sorted by creation date, newest first.

Reference: https://docs.pinnacle.sh/api-reference/brands/list

## Authentication

- `PINNACLE-API-KEY` header (required) — API Key authentication via header

## Request

### Body (application/json)

This endpoint expects a ListBrandsRequest.

- `pageIndex` (integer, optional, default: 0)
- `pageSize` (integer, optional, default: 20)
- `status` (enum, optional)
  - Allowed values: `PENDING`, `UNVERIFIED`, `VERIFIED`, `VETTED`, `FAILED`, `INCOMPLETE`
- `isArchived` (boolean, optional)
- `name` (string, optional) — Case-insensitive substring search on brand name.

## Response

### 200

Returns paginated list of brands.

- `data` (list of ExtendedBrand, required)
- `hasMore` (boolean, required)
- `count` (integer, required)

## Errors

### 400 Bad Request Error

Validation failed. The payload has missing required fields and/or invalid types.  See [https://zod.dev/error-formatting](https://zod.dev/error-formatting) for more information.

- `description` (string, required) — Human-readable summary of validation failures.
- `errors` (ZodErrorErrors, required) — Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array

### 401 Unauthorized Error

The request lacks valid authentication credentials or the provided credentials are invalid.  Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 500 Internal Server Error

An unexpected error occurred on Pinnacle's servers while processing your request.  If this error persists, please contact support with the request details.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

## Types

### ExtendedBrand

- `createdAt` (string, required) — ISO 8601 formatted timestamp of when this brand was added to our system.
- `id` (string, required) — The brand's ID. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
- `isArchived` (boolean, required) — Indicates if this brand is archived.
- `status` (enum, required) — Current review status of the brand.  `INCOMPLETE`: Not submitted.  `IN REVIEW`: Being reviewed by carriers.  `VERIFIED`: Approved and ready to send messages.  `FAILED`: Issues and errors related to the campaign's details.  `VETTED`: Has undergone additional vetting by a third party service post the brand being verified. Your brand will be assigned a trust score, with higher trust scores having higher message volumes.  `UNVERIFIED`: Brand details have been updated, and the brand will need to undergo re-verification.
  - Allowed values: `PENDING`, `UNVERIFIED`, `VERIFIED`, `VETTED`, `FAILED`, `INCOMPLETE`
- `updatedAt` (string, required) — ISO 8601 formatted timestamp of when this brand was last updated.
- `address` (string, optional) — Primary brand address where this brand is located.
- `contact` (optionalContactSchema, optional) — Contact information for the primary brand representative.
- `dba` (string, optional, nullable) — "Doing Business As" name - the public name this brand operates under.
- `description` (string, optional) — Brief description of what this brand does.
- `ein` (string, optional) — Employer Identification Number (EIN) assigned by the IRS.
- `email` (string, optional) — Main contact email address for this brand.
- `name` (string, optional) — Legal name of the brand as registered.
- `sector` (enum, optional) — Industry the Brand operates in.
  - Allowed values: `AGRICULTURE`, `COMMUNICATION`, `CONSTRUCTION`, `EDUCATION`, `ENERGY`, `ENTERTAINMENT`, `FINANCIAL`, `GAMBLING`, `GOVERNMENT`, `HEALTHCARE`, `HOSPITALITY`, `INSURANCE`, `MANUFACTURING`, `NGO`, `REAL_ESTATE`, `RETAIL`, `TECHNOLOGY`
- `type` (enum, optional) — Legal structure of the brand.
  - Allowed values: `GOVERNMENT`, `NON_PROFIT`, `PRIVATE_PROFIT`, `PUBLIC_PROFIT`, `SOLE_PROPRIETOR`
- `entityType` (enum, optional) — Legal entity type of the brand.
  - Allowed values: `LLC`, `SOLE_PROPRIETORSHIP`, `PARTNERSHIP`, `CORP`, `S_CORP`
- `website` (string, optional) — Brand website URL.

### ZodErrorErrors

Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array

### optionalContactSchema

Contact information for the primary brand representative.

- `email` (string, optional) — Email address of the contact person.
- `name` (string, optional) — Full name of the contact person.
- `phone` (string, optional) — Phone number of the contact person in E.164 format.
- `title` (string, optional) — Job title or position oft he contact person.

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "data": [
    {
      "createdAt": "2025-01-15T10:30:00Z",
      "id": "brand_abc123",
      "isArchived": false,
      "status": "VERIFIED",
      "updatedAt": "2025-02-20T14:00:00Z",
      "description": "Leading provider of innovative solutions",
      "name": "Acme Corp",
      "website": "https://acme.com"
    }
  ],
  "hasMore": false,
  "count": 1
}
```

**SDK Code**

```python List Brands
import requests

url = "https://api.pinnacle.sh/brands/list"

payload = {}
headers = {
    "PINNACLE-API-KEY": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript List Brands
const url = 'https://api.pinnacle.sh/brands/list';
const options = {
  method: 'POST',
  headers: {'PINNACLE-API-KEY': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go List Brands
package main

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

func main() {

	url := "https://api.pinnacle.sh/brands/list"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("PINNACLE-API-KEY", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby List Brands
require 'uri'
require 'net/http'

url = URI("https://api.pinnacle.sh/brands/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["PINNACLE-API-KEY"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java List Brands
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.pinnacle.sh/brands/list")
  .header("PINNACLE-API-KEY", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php List Brands
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.pinnacle.sh/brands/list', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
    'PINNACLE-API-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp List Brands
using RestSharp;

var client = new RestClient("https://api.pinnacle.sh/brands/list");
var request = new RestRequest(Method.POST);
request.AddHeader("PINNACLE-API-KEY", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift List Brands
import Foundation

let headers = [
  "PINNACLE-API-KEY": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.pinnacle.sh/brands/list")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```