Skip to main content
GET
/
brands
List brands you own
curl --request GET \
  --url https://api.example.com/brands \
  --header 'Authorization: Bearer <token>'
{
  "total_count": 123,
  "fetched_count": 123,
  "skip": 123,
  "limit": 123,
  "brands": [
    {
      "brand_id": "<string>",
      "brand_name": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.archeraffiliates.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

skip
integer
default:0

How many brands to skip — used for paging.

Required range: x >= 0
limit
integer
default:100

How many brands to return per page (1–500). Defaults to 100.

Required range: 1 <= x <= 500
search
string | null

Find brands matching the given text in their name.

brand_name
string | null

Match brands whose display name contains the given text (case-insensitive).

brand_id
string | null

Fetch a single brand by its identifier.

Response

Successful Response

The response from GET /brands.

total_count
integer
required

Total brands matching your filters across every page.

fetched_count
integer
required

Brands in this page.

skip
integer
required

The skip value that produced this page.

limit
integer
required

The limit value that produced this page.

brands
BrandRow · object[]
required

The brands on this page.