# List Brands

`POST /brands/list`

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

## Authentication

Send your API key in the `PINNACLE-API-KEY` header.

## Request body

Required.

Content type: `application/json`.

### Fields

- `pageIndex` — `integer`, optional, default: 0; minimum: 0
- `pageSize` — `integer`, optional, default: 20; minimum: 1; maximum: 100
- `status` — `string`, optional, values: `PENDING`, `UNVERIFIED`, `VERIFIED`, `VETTED`, `FAILED`, `INCOMPLETE`
- `isArchived` — `boolean`, optional
- `name` — `string`, optional, minimum length: 1; maximum length: 200. Case-insensitive substring search on brand name.

### Example

```json
{
  "pageIndex": 0,
  "pageSize": 20,
  "status": "PENDING",
  "isArchived": true,
  "name": "Acme Support"
}
```

## Responses

### 200

Returns paginated list of brands.

Content type: `application/json`. Schema: `ListBrandsResponse`.

- `data` — `object[]`
- `data[].createdAt` — `string`. ISO 8601 formatted timestamp of when this brand was added to our system.
- `data[].id` — `string`. The brand's ID. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
- `data[].isArchived` — `boolean`. Indicates if this brand is archived.
- `data[].status` — `BrandStatusEnum`, values: `PENDING`, `UNVERIFIED`, `VERIFIED`, `VETTED`, `FAILED`, `INCOMPLETE`. 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.
- `data[].updatedAt` — `string`. ISO 8601 formatted timestamp of when this brand was last updated.
- `data[].address` — `string`, optional. Primary brand address where this brand is located.
- `data[].contact` — `OptionalContacts`, optional. Contact information for the primary brand representative.
- `data[].contact.email` — `string`, optional. Email address of the contact person.
- `data[].contact.name` — `string`, optional. Full name of the contact person.
- `data[].contact.phone` — `string`, optional. Phone number of the contact person in E.164 format.
- `data[].contact.title` — `string`, optional. Job title or position oft he contact person.
- `data[].dba` — `string`, optional. "Doing Business As" name - the public name this brand operates under.
- `data[].description` — `string`, optional. Brief description of what this brand does.
- `data[].ein` — `string`, optional. Employer Identification Number (EIN) assigned by the IRS.
- `data[].email` — `string`, optional. Main contact email address for this brand.
- `data[].name` — `string`, optional. Legal name of the brand as registered.
- `data[].sector` — `CompanySectorEnum`, optional, values: `AGRICULTURE`, `COMMUNICATION`, `CONSTRUCTION`, `EDUCATION`, `ENERGY`, `ENTERTAINMENT`, `FINANCIAL`, `GAMBLING`, `GOVERNMENT`, `HEALTHCARE`, `HOSPITALITY`, `INSURANCE`, `MANUFACTURING`, `NGO`, `REAL_ESTATE`, `RETAIL`, `TECHNOLOGY`. Industry the Brand operates in.
- `data[].type` — `CompanyTypeEnum`, optional, values: `GOVERNMENT`, `NON_PROFIT`, `PRIVATE_PROFIT`, `PUBLIC_PROFIT`, `SOLE_PROPRIETOR`. Legal structure of the brand.
- `data[].entityType` — `CompanyEntityTypeEnum`, optional, values: `LLC`, `SOLE_PROPRIETORSHIP`, `PARTNERSHIP`, `CORP`, `S_CORP`. Legal entity type of the brand.
- `data[].website` — `string`, optional. Brand website URL.
- `hasMore` — `boolean`
- `count` — `integer`

Example:

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

### 400

Validation failed. The payload has missing required fields and/or invalid types.

See https://zod.dev/error-formatting for more information.

Content type: `application/json`. Schema: `object`.

- `description` — `string`. Human-readable summary of validation failures.
- `errors` — `object`. 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

Example:

```json
{
  "description": "✖ Invalid input: expected string, received number\n  → at example_field",
  "errors": {
    "errors": [
      "Unrecognized key: 'extraKey'"
    ],
    "properties": {
      "example_field": {
        "errors": [
          "Invalid input: expected string, received NaN"
        ]
      }
    }
  }
}
```

### 401

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.

Content type: `application/json`. Schema: `object`.

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

Example:

```json
{
  "error": "Invalid API key."
}
```

### 500

An unexpected error occurred on Pinnacle's servers while processing your request.

If this error persists, please contact support with the request details.

Content type: `application/json`. Schema: `object`.

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

Example:

```json
{
  "error": "An unexpected error occurred while processing your request."
}
```

## SDK examples

### TypeScript

```typescript
import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.brands.list();
```

### Python

```python
import os
from rcs import Pinnacle

client = Pinnacle(
    api_key=os.environ["PINNACLE_API_KEY"],
)

client.brands.list()
```

### Ruby

```ruby
require "rcs"

client = Pinnacle::Client.new(
  api_key: ENV.fetch("PINNACLE_API_KEY")
)

client.brands.list
```

## Machine-readable schema

[OpenAPI 3.1 JSON](https://docs.pinnacle.sh/openapi.json)