# Get Brand by ID

`GET /brands/{id}`

Retrieve detailed information for a specific brand in your account by ID.

## Authentication

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

## Parameters

- `id` — path, string. The unique identifier of the brand you want to retrieve from your account.

 This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
- `hideEIN` — query, boolean, optional, default: false. Optional flag to mask the Employer Identification Number in the response for security purposes.

When you set this to true, the EIN value will be replaced with a masked placeholder instead of the actual number.

## Responses

### 200

Returns the brand.

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

- `createdAt` — `string`. ISO 8601 formatted timestamp of when this brand was added to our system.
- `id` — `string`. The brand's ID. This identifier is a string that always begins with the prefix `b_`, for example: `b_1234567890`.
- `isArchived` — `boolean`. Indicates if this brand is archived.
- `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.
- `updatedAt` — `string`. ISO 8601 formatted timestamp of when this brand was last updated.
- `address` — `string`, optional. Primary brand address where this brand is located.
- `contact` — `OptionalContacts`. Contact information for the primary brand representative.
- `contact.email` — `string`, optional. Email address of the contact person.
- `contact.name` — `string`, optional. Full name of the contact person.
- `contact.phone` — `string`, optional. Phone number of the contact person in E.164 format.
- `contact.title` — `string`, optional. Job title or position oft he contact person.
- `dba` — `string`, optional. "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` — `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.
- `type` — `CompanyTypeEnum`, optional, values: `GOVERNMENT`, `NON_PROFIT`, `PRIVATE_PROFIT`, `PUBLIC_PROFIT`, `SOLE_PROPRIETOR`. Legal structure of the brand.
- `entityType` — `CompanyEntityTypeEnum`, optional, values: `LLC`, `SOLE_PROPRIETORSHIP`, `PARTNERSHIP`, `CORP`, `S_CORP`. Legal entity type of the brand.
- `website` — `string`, optional. Brand website URL.
- `lastTcrVettingDate` — `string`. ISO 8601 formatted timestamp of the last TCR vetting.
- `tcrFeedback` — `VettingFeedback[]`. Feedback from The Campaign Registry if TCR vetting was performed.
- `tcrFeedback[].description` — `string`. Detailed description of the feedback.
- `tcrFeedback[].displayName` — `string`. Human-readable name of the feedback item.
- `tcrFeedback[].fields` — `string[]`. Fields affected by this feedback item.
- `tcrFeedback[].id` — `string`. Feedback item identifier.
- `vettingHistory` — `object[]`. History of all external vetting attempts for this brand.
- `vettingHistory[].provider` — `string`, values: `AEGIS`. The vetting provider used.
- `vettingHistory[].vettingClass` — `string`, values: `STANDARD`. The vetting class level.
- `vettingHistory[].vettingDate` — `string`. ISO 8601 formatted timestamp of when the vetting was initiated.
- `vettingHistory[].vettingScore` — `number`, optional. Vetting score if available.
- `vettingHistory[].vettingStatus` — `string`, values: `ACTIVE`, `FAILED`, `IN_PROGRESS`, `PENDING`. Current status of the vetting process.

Example:

```json
{
  "id": "b_1234567890",
  "createdAt": "2024-09-11T19:41:12.099",
  "updatedAt": "2024-05-08T07:58:01.291",
  "isArchived": false,
  "status": "VERIFIED",
  "name": "Pinnacle",
  "dba": "Pinnacle RCS",
  "address": "500 Folsom St, San Francisco, CA 94105",
  "email": "founders@trypinnacle.app",
  "website": "https://www.pinnacle.sh",
  "entityType": "LLC",
  "type": "PRIVATE_PROFIT",
  "sector": "TECHNOLOGY",
  "ein": "88-1234567",
  "contact": {
    "name": "Michael Chen",
    "email": "michael.chen@trypinnacle.app",
    "phone": "+14155551234",
    "title": "Customer Support Representative"
  },
  "tcrFeedback": null,
  "lastTcrVettingDate": null,
  "vettingHistory": []
}
```

### 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."
}
```

### 403

Your subscription does not include access to this feature.

This occurs when attempting to use functionality that requires a higher subscription tier.
Please upgrade your subscription to access this feature.

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": "Your subscription does not include access to this feature."
}
```

### 404

The requested resource could not be found.

This may occur if the identifier is incorrect, the resource has been deleted, or you don't have permission to access it.

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": "The requested resource could not be found."
}
```

### 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.get("b_1234567890");
```

### Python

```python
import os
from rcs import Pinnacle

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

client.brands.get(
    id="b_1234567890",
)
```

### Ruby

```ruby
require "rcs"

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

client.brands.get(id: "b_1234567890")
```

## Machine-readable schema

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