List brands

Returns every brand belonging to the active project. The response is paginated.

GET /api/v1/brands

Query parameters

Name	Type	Required	Description
page	integer	Optional	The page number to return. Defaults to `1`.
per_page	integer	Optional	The number of items per page. Defaults to `25`, maximum `100`.
sort_by	string	Optional	The column to sort by. Defaults to `display_name`.
sort_order	string	Optional	The direction to sort by. Each endpoint has its own default.
include	string	Optional	A comma-separated list of related resources to include in the response. Allowed values: `project`, `project.organization`.

Response

Response schema

Field	Type	Description
data	Brand[]
links	PaginationLinks
meta	PaginationMeta

The brand object

Field	Type	Description
id	integer	The unique ID of the brand.
project_id	integer	The ID of the project the brand belongs to.
display_name	string	The canonical display name of the brand.
aliases	string[]	Alternative names that the brand is referred to by.
domains	string[]	The web domains associated with the brand.
kind	string	The brand's classification. One of `own`, `competitor`, `discovered`, or `ignored`.
created_at	datetime	When the brand was created.
updated_at	datetime	When the brand was last updated.

import os import requests response = requests.get( "https://pineprompt.com/api/v1/brands", headers={ "Authorization": f"Bearer {os.environ['PINEPROMPT_TOKEN']}", "Pineprompt-Project-Id": "1", }, ) response.raise_for_status() payload = response.json()

use GuzzleHttp\Client; $response = (new Client())->get('https://pineprompt.com/api/v1/brands', [ 'headers' => [ 'Authorization' => 'Bearer '.getenv('PINEPROMPT_TOKEN'), 'Pineprompt-Project-Id' => '1', ], ]); // Guzzle throws on 4xx/5xx by default, so no manual check needed. $payload = json_decode((string) $response->getBody(), true);

{ "data": [ { "id": 555, "project_id": 42, "display_name": "Acme Inc.", "aliases": [ "Acme", "Acme Co" ], "domains": [ "acme.com", "acme.co" ], "kind": "competitor", "created_at": "2026-05-15T09:11:42+00:00", "updated_at": "2026-05-15T09:11:42+00:00" } ], "links": { "first": "https://pineprompt.com/api/v1/monitors?page=1", "last": "https://pineprompt.com/api/v1/monitors?page=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "https://pineprompt.com/api/v1/monitors", "per_page": 25, "to": 1, "total": 1, "links": [ { "url": "https://pineprompt.com/api/v1/monitors?page=2", "label": "2", "page": 2, "active": false } ] } }