List brands

List all brands with optional filtering by name or organization.

GET /brands/api/v1/brands

List brands

cURL

curl --request GET \
  --url https://www.closient.com/brands/api/v1/brands \
  --header 'X-API-Key: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "has_social_links": true,
      "created": "2023-11-07T05:31:56Z",
      "metadata": {},
      "website": "",
      "description": "",
      "logo_url": "<string>"
    }
  ],
  "pagination": {
    "page": 2,
    "page_size": 2,
    "total_count": 1,
    "total_pages": 2,
    "has_next": true,
    "has_previous": true
  }
}

Authorizations

APIKeyHeaderAuthOAuthTokenAuthSessionAuth

X-API-Key · string · header · required

Query Parameters

name · string | null

Filter brands by name (case-insensitive substring match).

organization_id · string | null

Filter brands by organization UUID.

ordering · string | null

Sort field: 'name', 'created', '-name', '-created'.

page · integer · default: 1

Page number (1-indexed).

Required range: x >= 1

page_size · integer · default: 25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

200 - application/json

OK

data · BrandOut · object[] · required

Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or page is past the end.

Show child attributes

pagination · PaginationMeta · object · required

Pagination envelope describing position within the full result set.

Show child attributes

Example:

{
  "has_next": true,
  "has_previous": false,
  "page": 1,
  "page_size": 25,
  "total_count": 342,
  "total_pages": 14
}