API v1 requires an active Growth, Business, or Enterprise plan, or an Agency Growth or Agency Business plan. Review your subscription if authentication reports an insufficient plan.
Base URL
All API endpoints are relative to:Available endpoints
The API exposes these monitoring resources:Quick start
1
Get your API token
Go to Team Management → REST API and create a new API token.
2
Make your first request
3
Explore your data
Use the brand ID to access performance metrics, competitors, sources, and more.
Response format
Responses are JSON. List endpoints generally return a resource array and apagination object:
pagination object with:
total: Total items matching the querycount: Items in this responselimit: Max items per pageoffset: Items skipped
/brands endpoint is the exception: it returns the full list with a top-level total count and no pagination object.
See Entities for detailed data structures.
Validation and resource errors include machine-readable codes:
Get help
- Check the Authentication guide
- Review Rate Limits
- See Error codes
- Contact us at team@qwairy.co

