Skip to main content
GET
/
api
/
v1
/
brands
/
{brandId}
Get Brand
curl --request GET \
  --url https://api.example.com/api/v1/brands/{brandId} \
  --header 'Authorization: <authorization>'
{
  "success": true,
  "brand": {
    "id": "<string>",
    "name": "<string>",
    "domain": "<string>",
    "description": "<string>",
    "createdAt": "<string>",
    "stats": {
      "promptsCount": 123,
      "answersCount": 123,
      "competitorsCount": 123
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.qwairy.co/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve detailed information about a specific brand, including aggregate statistics for prompts, answers, and competitors.
​
Authorization
string
required
Bearer token. Example: Bearer qw-api-xxx

​
Path Parameters

​
brandId
string
required
The unique brand identifier

​
Response

​
success
boolean
Indicates if the request was successful
​
brand
object

​
Example Request

curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef" \
  -H "Authorization: Bearer qw-api-your-token-here"

​
Example Response

{
  "success": true,
  "brand": {
    "id": "cm1234567890abcdef",
    "name": "My Brand",
    "domain": "mybrand.com",
    "description": "Leading provider of innovative solutions",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "stats": {
      "promptsCount": 156,
      "answersCount": 312,
      "competitorsCount": 8
    }
  }
}

​
Error Responses

StatusCodeDescription
401INVALID_TOKENAuthentication failed
404BRAND_NOT_FOUNDBrand doesn’t exist or not accessible