brands

Get a brand

Returns a single brand. The brand must belong to the active project.

get/api/v1/brands/{brand}

Request

  • Base URL: https://pineprompt.com
  • URL: https://pineprompt.com/api/v1/brands/{brand}
  • Auth: HTTP bearer

Path parameters

brandinteger required
Example:555

The numeric ID of the brand.

Query parameters

includestring
Example:project

A comma-separated list of related resources to include in the response. Allowed values: project, project.organization.

Headers

Pineprompt-Project-Idinteger required

The active project's numeric ID.

Response

OK

idinteger

The unique ID of the brand.

project_idinteger

The ID of the project the brand belongs to.

display_namestring

The canonical display name of the brand.

aliasesstring[]

Alternative names that the brand is referred to by.

domainsstring[]

The web domains associated with the brand.

kind'own' | 'competitor' | 'discovered' | 'ignored'

The brand's classification, derived from its context rather than stored: the brand the project's brand_id points at is own, a brand with ignored_at set is ignored, a brand attached to any segment is a competitor, and a brand with none of those is discovered. This field is read-only.

colorstring

A hex color used to color the brand consistently across charts. It is derived from the brand's favicon, or assigned automatically when no color can be derived. This field is read-only and is always present.

ignored_atstring date-time nullable

When the brand was ignored, or null while it is not. Set and cleared through the ignored field on the update endpoint.

created_atstring date-time

When the brand was created.

updated_atstring date-time

When the brand was last updated.

Example response

{
  "id": 555,
  "project_id": 42,
  "display_name": "Acme Inc.",
  "aliases": [
    "Acme",
    "Acme Co"
  ],
  "domains": [
    "acme.com",
    "acme.co"
  ],
  "kind": "competitor",
  "color": "#008FFB",
  "project": {
    "id": 42,
    "organization_id": 7,
    "name": "Acme Marketing",
    "brand_id": 555,
    "organization": {
      "id": 7,
      "name": "Acme Inc.",
      "created_at": "2026-05-15T09:11:42+00:00",
      "updated_at": "2026-05-15T09:11:42+00:00"
    },
    "created_at": "2026-05-15T09:11:42+00:00",
    "updated_at": "2026-05-15T09:11:42+00:00"
  },
  "created_at": "2026-05-15T09:11:42+00:00",
  "updated_at": "2026-05-15T09:11:42+00:00"
}

Changes

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