elmo
Sign up

List competitors

GET
/competitors

Authorization

BearerAuth
headerAuthorizationBearer <token>

An instance admin key from ADMIN_API_KEYS, or an organization key (elmo_…) issued from the dashboard.

Query Parameters

brandId?string
page?integer

Page number, 1-based.

Range1 <= value
Default1
limit?integer

Items per page. Values above the maximum are clamped, not rejected.

Range1 <= value <= 100
Default20

Response Body

Paginated list of competitors

application/json
  1. response
data*array<>

The items on this page. Read this rather than the named key below.

competitors*array<>Deprecated

Deprecated: read data instead. Kept while the one known consumer migrates, and removed in a future release.

pagination*
Example Request
curl -X GET 'https://app.elmohq.com/api/v1/competitors'
Example Response
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "brandId": "string",
      "name": "string",
      "domains": [
        "string"
      ],
      "aliases": [
        "string"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "competitors": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "brandId": "string",
      "name": "string",
      "domains": [
        "string"
      ],
      "aliases": [
        "string"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0
  }
}