List brands
Brands visible to the caller. For a PAT, this is pinned to the token's issuing organization (never the owner's other orgs, even for a superuser-owned key).
/api/brands/Personal Access Token (create one from Settings -> API Keys in the dashboard). Send as Authorization: Bearer gr_live_.... An X-API-Key: gr_live_... header (see the apiKeyAuth scheme) is accepted as an equivalent alternative — send ONE of the two, not both.
In: header
Query Parameters
true to include archived rows (excluded by default).
Filter by whether the brand has any monitored prompt.
Value in
- "off"
- "on"
List a reachable organization's brands instead of the caller's own. API tokens only: a session request that sends it gets 403, and changes organization with POST /api/org/active/ instead. Omitted, the caller's own organization is used. One organization per call: there is no value that spans several. An id the caller cannot reach returns 404, the same as one that does not exist. GET /api/org/reachable/ lists the valid ids.
1-based page number.
Rows per page. Server-side default/cap vary per endpoint.
Free-text search over brand name + website.
Sort order. Default last-run.
Value in
- "last-run"
- "name"
- "recent"
Response Body
application/json
curl -X GET "https://example.com/api/brands/"{ "results": [ { "id": "string", "name": "string", "internalLabel": "string", "website": "string", "averageScore": 0, "previousScore": 0, "hasScoreData": true, "categoryCount": 0, "promptCount": 0, "monitoredPromptCount": 0, "recCount": 0, "lastActivity": "string", "status": "string", "hasInFlightRun": true, "runInFlightProgress": { "property1": null, "property2": null }, "monitoringRefreshInProgress": true, "mergedInto": { "property1": null, "property2": null }, "mergedAt": "string", "orgId": "string", "orgName": "string", "executiveSummary": "string", "executiveSummaryUpdatedAt": "string", "lastMonitoredRunAt": "string", "nextMonitoredRunAt": "string", "nextRunPromptCount": 0 } ], "count": 0, "next": "string", "previous": "string"}