List a brand's competitors

GET/brands/{brand_id}/competitors

Authorization

AuthorizationBearer token · headerrequired

API key sent as Authorization: Bearer <key>. A key belongs to one workspace, has scopes, and can be limited to some brands.

AuthorizationOAuth2 access token · headerrequired

OAuth 2.1 sign-in (authorization code with PKCE) used by AI assistants that connect through the Zaraftis MCP server. Discovery URLs are at https://api.zaraftis.com/api/auth.

Path parameters

brand_idstring<uuid>required

Query parameters

page_tokenstring

The next_page_token from the previous page. Send it with the same filters and limit.

limitinteger

Items per page. A route can set a lower maximum or default; its own entry says so.

min 1 · max 100 · default: 25

Responses

200

One competitor list page

successbooleanrequired

dataBrandCompetitorListPagerequired

One keyset page: items plus the pagination footer.

Show properties

itemsBrandCompetitorListItem[]required

Show properties

Array of BrandCompetitorListItem

idstring<uuid>required

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

namestringrequired

min length 1

urlstringrequired

min length 1

is_activebooleanrequired

paginationListPaginationrequired

Cursor pagination footer. next_page_token is present only when has_more is true; the token is opaque and filter- and limit-bound.

Show properties

has_morebooleanrequired

next_page_tokenstring

min length 1

request_idstringrequired

min length 1

404

not_found: unknown id, or an id this key cannot see

successbooleanrequired

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsobject

field_errorsobject[]

Show properties

Array of object

fieldstringrequired

codestringrequired

Allowed:requiredformattoo_smalltoo_largeunrecognized_keyinvalid

messagestringrequired

request_idRequestIdrequired

Request

curl -X GET 'https://api.zaraftis.com/v1/brands/497f6eca-6276-4993-bfeb-53cbbbba6f08/competitors' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.zaraftis.com/v1/brands/497f6eca-6276-4993-bfeb-53cbbbba6f08/competitors", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.zaraftis.com/v1/brands/497f6eca-6276-4993-bfeb-53cbbbba6f08/competitors",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "url": "string",
        "is_active": true
      }
    ],
    "pagination": {
      "has_more": true,
      "next_page_token": "string"
    }
  },
  "request_id": "string"
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": {},
    "field_errors": [
      {
        "field": "string",
        "code": "required",
        "message": "string"
      }
    ]
  },
  "request_id": "string"
}