Get brand by ID

GET

/brands/{id}

curl --request GET \
  --url https://api.example.com/brands/example \
  --header 'Authorization: Bearer <token>'

• API base URL

Retrieve a single brand by its unique identifier.

Authorizations

• M2MAuth
  crm-api/brands.read

Parameters

Path Parameters

id

required

string

Responses

200

The brand record.

Media type application/json

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"
}

401

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

nullable

details

object

key

additional properties

any

Example

{
  "error": "UNAUTHORIZED",
  "message": "Valid authentication token required."
}

403

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

nullable

details

object

key

additional properties

any

Example

{
  "error": "FORBIDDEN",
  "message": "Insufficient scope for this operation."
}

404

Resource not found.

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

nullable

details

object

key

additional properties

any

Example

{
  "error": "NOT_FOUND",
  "message": "Product not found"
}