API ReferenceBrands

Get Brand by ID

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

Path parameters

idintegerRequired>=1
ID of an existing brand in your account that you want to retrieve.

Headers

PINNACLE-API-KEYstringRequired

Query parameters

hideEINbooleanOptionalDefaults to 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.

Response

Returns the brand.
createdAtstring
ISO 8601 formatted timestamp of when this brand was added to our system.
idinteger
The brand's ID.
isArchivedboolean
Indicates if this brand is archived.
lastTcrVettingDatestring or null
ISO 8601 formatted timestamp of the last TCR vetting.
statusenum

Current review status of the campaign.

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.

tcrFeedbacklist of objects or null
Feedback from The Campaign Registry if TCR vetting was performed.
updatedAtstring
ISO 8601 formatted timestamp of when this brand was last updated.
vettingHistorylist of objects
History of all external vetting attempts for this brand.
addressstring or null
Primary brand address where this brand is located.
contactobject or null
Contact information for the primary brand representative.
dbastring or null

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

descriptionstring or null
Brief description of what this brand does.
einstring or null

Employer Identification Number (EIN) assigned by the IRS.

emailstring or null
Main contact email address for this brand.
namestring or null
Legal name of the brand as registered.
sectorenum or null
Industry the Brand operates in.
typeenum or null
Legal structure of the brand.
Allowed values:
websitestring or null
Brand website URL.

Errors