CompetitorsList competitors

List competitors

Returns the competitors tracked in the workspace, one page at a time.

Required scope: v2:org.

url can be null.

curl -X GET "https://api.opttab.com/v1/external/competitors?page=1&pageSize=20" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "items": [
    {
      "id": "55555555-5555-4555-8555-555555555555",
      "name": "South Running",
      "url": "https://south.example"
    }
  ],
  "page": 1,
  "pageSize": 20,
  "totalCount": 1
}
GET
/v1/external/competitors
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.

An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.
query
pageinteger

The page to return, starting at 1.

Min: 1
query
pageSizeinteger

Items per page. Maximum 100.

Min: 1 • Max: 100
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An API key secret from Settings › API. It starts with opt_live_. Send it as Authorization: Bearer opt_live_xxxxxxxx. A session cookie, an X-API-Key header and an ?api_key= query parameter do not authenticate.

Query Parameters

pageinteger

The page to return, starting at 1.

Example:
1
pageSizeinteger

Items per page. Maximum 100.

Example:
20

Responses

itemsarray
Required
pageinteger
Required

The page returned.

pageSizeinteger
Required

Items per page.

totalCountinteger
Required

Total items across all pages.