List brands
GET
/brands
const url = 'https://api.example.com/brands?includeArchived=false';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.example.com/brands?includeArchived=false' \ --header 'Authorization: Bearer <token>'Returns a raw JSON array of all brands — not paginated, not wrapped
in an envelope. There are no limit/lastKey parameters.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” includeArchived
boolean
Pass true to include archived brands. Default returns only active brands.
Responses
Section titled “ Responses ”A raw array of brand records.
Media type application/json
Array<object>
The external brand representation — what GET /brands,
GET /brands/search, and GET /brands/{id} return. Exhaustive: id,
name, and slug are the only fields ever returned to an M2M caller.
object
id
string
name
string
slug
string
Example generated
[ { "id": "example", "name": "example", "slug": "example" }]Authentication required or failed.
Media type application/json
object
error
Machine-readable code. Best-effort — the generic 500 path carries none.
string
message
required
string
requestId
Unique request ID for tracing.
string
details
object
key
additional properties
any
Example
{ "error": "UNAUTHORIZED", "message": "Valid authentication token required."}Insufficient permissions (missing scope or Admin role).
Media type application/json
object
error
Machine-readable code. Best-effort — the generic 500 path carries none.
string
message
required
string
requestId
Unique request ID for tracing.
string
details
object
key
additional properties
any
Example
{ "error": "FORBIDDEN", "message": "Insufficient scope for this operation."}