List competitors
List the brand’s active, non-preview competitors.
GET
/api/v1/brands/{brandId}/competitorsreadThis operation is available through REST only.
Request details
Required scope: A valid read or write token.
Request example
curl --request GET \
--url "https://searchseal.com/api/v1/brands/b7e4c2a0-5d1f-4c8e-9a3b-2f6d8e1c4a70/competitors" \
--header "Authorization: Bearer $SEARCHSEAL_TOKEN"Request parameters
| Name | Location | Required | Type | Description |
|---|---|---|---|---|
brandId | path | Yes | uuid | An active brand ID returned by the brand list. |
Response fields
Response body example
{
"items": [
{
"id": "c2d4e6f8-1a3b-4c5d-8e7f-9a0b1c2d3e4f",
"name": "Rival Resort",
"domain": "rival.com"
}
],
"meta": {
"generatedAt": "2026-09-26T08:15:02.114Z",
"timeZone": "Asia/Jakarta"
}
}| Field | Type | Description |
|---|---|---|
id | uuid | Unique identifier for the competitor. |
name | string | Saved competitor name. |
domain | string | null | Website domain assigned to the competitor. |
Successful REST responses from this endpoint include the shown meta fields. Read about data-through dates.
Possible errors
400 invalid_request— An input failed validation. Field details may appear inerrors.401 unauthorized— Authentication failed because the token is absent, unrecognized or revoked.403 forbidden— Account access or token permissions do not allow this request. Check the message for the cause.404 not_found— The resource is missing or unavailable to this account, including inactive brands.429 rate_limited— A quota was reached or could not be checked. Wait theRetry-Afterdelay before retrying.500 server_error— The server failed to complete the operation.
For the shared error format, see status codes, quotas and retries. Next endpoint: List questions.