Brands are the core entities in Qwairy. Each brand represents a company or product you’re monitoring across AI platforms. Use these endpoints to list all brands in your team or get details about a specific brand.
See Entities for the complete Brand object structure. List Brands Bearer token. Example: Bearer qw-api-xxx
Response Indicates if the request was successful
Unique brand identifier (UUID)
Primary domain for the brand
Example Request curl -X GET "https://qwairy.co/api/v1/brands" \ -H "Authorization: Bearer qw-api-your-token-here"
Example Response { "success" : true , "total" : 2 , "brands" : [ { "id" : "cm1234567890abcdef" , "name" : "My Brand" , "domain" : "mybrand.com" }, { "id" : "cm0987654321fedcba" , "name" : "My Other Brand" , "domain" : "myotherbrand.com" } ] }
Get Brand Details Retrieve detailed information about a specific brand.
Bearer token. Example: Bearer qw-api-xxx
The unique brand identifier
GET /api/v1/brands/{brandId}
Response Indicates if the request was successful
Unique brand identifier (UUID)
Primary domain for the brand
Brand description (can be null)
ISO 8601 creation timestamp
Number of prompts tracked for this brand
Total number of AI responses analyzed
Number of competitors (SELF + DIRECT)
Example Request curl -X GET "https://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 Status Code Description 401 INVALID_TOKENAuthentication failed 404 BRAND_NOT_FOUNDBrand doesn’t exist or not accessible
Next Steps Once you have your brand IDs, you can:
