Interactive API reference
The authoritative, always-current reference for request and response schemas is the machine-generated OpenAPI specification.
The API follows the OpenAPI 3.0.1 standard.
Where to find it
- Swagger UI explorer:
https://api.brandindex.com/v1/— browse every endpoint and its schema, and try requests in the browser once logged in. - Raw specification:
https://api.brandindex.com/v1/openapi.json— the OpenAPI document, for generating clients or importing into tools like Postman.
The Swagger UI is for exploring the API, not for retrieving data in production. The intended way to consume the API is from your own code.
How this documentation relates to it
- The OpenAPI spec is the source of truth for exact field names, types and the full endpoint list.
- These prose pages explain the concepts, behaviour and workflows that a schema cannot convey — start here to understand how to use the API, then use the spec for precise field-level detail.
Authenticating in the explorer
Use the login option in the explorer (SSO) before trying authenticated endpoints. See Authentication.