List Brands API Reference

Serverhttps://api.pinnacle.sh/

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

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

pageIndexintegerOptional

Range

0 <= value

Default

pageSizeintegerOptional

Range

1 <= value <= 100

Default

statusstringOptional

Allowed values

"PENDING""UNVERIFIED""VERIFIED""VETTED""FAILED""INCOMPLETE"

isArchivedbooleanOptional

Example

true

namestringOptional

Case-insensitive substring search on brand name.

Length

1 <= length <= 200

Example

"Acme Support"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

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

await client.brands.list();

Responses

{  "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}

List Brands

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

List Brands

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`