Skip to main content
GET
/
brands
/
api
/
v1
/
brands
List brands
curl --request GET \
  --url https://www.closient.com/brands/api/v1/brands \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "public_id": "<string>",
      "has_social_links": true,
      "created": "2023-11-07T05:31:56Z",
      "website": "",
      "description": "",
      "logo_url": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "page_size": 123,
    "total_count": 123,
    "total_pages": 123,
    "has_next": true,
    "has_previous": true
  }
}

Authorizations

​
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
​
pagination
PaginationMeta · object
required
Example:
{
  "has_next": true,
  "has_previous": false,
  "page": 1,
  "page_size": 25,
  "total_count": 342,
  "total_pages": 14
}