Skip to main content
GET
/
v1
/
brands
List brand catalogs
curl --request GET \
  --url https://api.shareofmodel.ai/v1/brands \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "brand": "<string>",
      "domain": "<string>",
      "colors": [
        "<string>"
      ],
      "logos": [
        "<string>"
      ],
      "banner": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
brand__in
string

Comma-separated list of brand names to filter by.

​
domain
string

Filter by a single domain.

​
limit
integer

Number of results to return per page (default: 100, max: 1000).

​
offset
integer

The initial index from which to return the results.

Response

200 - application/json

List of brand catalogs.

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"