Brands

Get Brand by ID

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

get/brands/{id}

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/brands/{id}
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

idstring required

The unique identifier of the brand you want to retrieve from your account. <br><br> This identifier is a string that always begins with the prefix b_, for example: b_1234567890.

Query parameters

hideEINboolean

Optional flag to mask the Employer Identification Number in the response for security purposes.<br>

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

Response

Returns the brand.

createdAtstring required

ISO 8601 formatted timestamp of when this brand was added to our system.

idstring required

The brand's ID. This identifier is a string that always begins with the prefix b_, for example: b_1234567890.

isArchivedboolean required

Indicates if this brand is archived.

status'PENDING' | 'UNVERIFIED' | 'VERIFIED' | 'VETTED' | 'FAILED' | 'INCOMPLETE' required

Current review status of the brand.

INCOMPLETE: Has not been submitted. PENDING: Currently being reviewed. VERIFIED: Verified and good to go. UNVERIFIED: No longer verified due to an update in the brand details. VETTED: Brand has been vetted by an external provider and has received vetting scores.

updatedAtstring required

ISO 8601 formatted timestamp of when this brand was last updated.

addressstring

Primary brand address where this brand is located.

dbastring nullable

"Doing Business As" name - the public name this brand operates under.

descriptionstring

Brief description of what this brand does.

einstring

Employer Identification Number (EIN) assigned by the IRS.

emailstring

Main contact email address for this brand.

namestring

Legal name of the brand as registered.

sector'AGRICULTURE' | 'COMMUNICATION' | 'CONSTRUCTION' | 'EDUCATION' | 'ENERGY' | 'ENTERTAINMENT' | 'FINANCIAL' | 'GAMBLING' | 'GOVERNMENT' | 'HEALTHCARE' | 'HOSPITALITY' | 'INSURANCE' | 'MANUFACTURING' | 'NGO' | 'REAL_ESTATE' | 'RETAIL' | 'TECHNOLOGY'

Industry the Brand operates in.

type'GOVERNMENT' | 'NON_PROFIT' | 'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'SOLE_PROPRIETOR'

Legal structure of the brand.

entityType'LLC' | 'SOLE_PROPRIETORSHIP' | 'PARTNERSHIP' | 'CORP' | 'S_CORP'

Legal entity type of the brand.

websitestring

Brand website URL.

lastTcrVettingDatestring nullable required

ISO 8601 formatted timestamp of the last TCR vetting.

Changes

No recorded changes to this operation across all 1 revision of this API.