Skip to main content
GET
List Brands

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Query Parameters

relation
enum<string>

Filter by brand relation

Available options:
SELF,
DIRECT_COMPETITOR,
OTHER,
IGNORED
query
string

Search by brand name or domain

page
integer
default:1

Page number (1-based)

Required range: x >= 1
size
integer
default:50

Page size

Required range: 1 <= x <= 100

Response

Default Response

brands
object[]
required

Array of brands

total
integer
required

Total brands matching filters

page
integer

Page number (1-based)

size
integer

Page size

totalPages
integer

Total pages for this page size