Skip to content
TBC CRM Docs

Search brands

GET
/brands/search
 
curl --request GET \
  --url 'https://api.example.com/brands/search?size=20&from=0' \
  --header 'Authorization: Bearer <token>'

Search brands by query string. Offset-based pagination only — unlike product search, the response does not include syncToken, hasMore, or totalIsLowerBound.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
q
string

Search query. Omit to match all brands.

size
integer
default: 20 <= 100
from
integer
0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Search results (offset pagination).

Media type application/json

Offset-paginated brand search results (no syncToken/hasMore).

object
data
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
pagination
object
total
integer
from
integer
size
integer
meta
object
queryTimeMs
integer
source
string
Example generated
{
  "data": [
    {
      "id": "example",
      "name": "example",
      "slug": "example"
    }
  ],
  "pagination": {
    "total": 1,
    "from": 1,
    "size": 1
  },
  "meta": {
    "queryTimeMs": 1,
    "source": "example"
  }
}

401

Section titled “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

Section titled “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."
}