Competitors

REST endpoints for Competitors. Base URL https://api.competlab.com; every request needs a CL-API-Key header (see Authentication). Responses wrap in { item } or { items }; errors in { error }.

List project competitors

List all competitors monitored within a project. Includes the project’s own domain (marked with isOwn: true) and all added competitor domains.

Path parameters

Request

curl "https://api.competlab.com/v1/projects/507f1f77bcf86cd799439011/competitors" \
  -H "CL-API-Key: YOUR_COMPETLAB_API_KEY"

Response 200 OK

{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "domain": "competitor.com",
      "isOwn": false,
      "preparationStatus": "complete",
      "createdAt": "2026-01-15T12:00:00.000Z"
    }
  ]
}

Errors

Every error uses the shared { error: { code, message, status } } envelope; code is one of the values listed above.

{
  "error": {
    "code": "api_key_invalid",
    "message": "Invalid API key",
    "status": 401
  }
}

Get competitor details

Get detailed information about a specific competitor within a project, including monitored page URLs (homepage and pricing).

Path parameters

Request

curl "https://api.competlab.com/v1/projects/507f1f77bcf86cd799439011/competitors/507f1f77bcf86cd799439012" \
  -H "CL-API-Key: YOUR_COMPETLAB_API_KEY"

Response 200 OK

{
  "item": {
    "id": "507f1f77bcf86cd799439011",
    "domain": "competitor.com",
    "isOwn": false,
    "preparationStatus": "complete",
    "createdAt": "2026-01-15T12:00:00.000Z",
    "monitoredPages": {
      "homepage": "https://competitor.com/",
      "pricing": "https://competitor.com/pricing"
    }
  }
}

Errors

Every error uses the shared { error: { code, message, status } } envelope; code is one of the values listed above.

{
  "error": {
    "code": "api_key_invalid",
    "message": "Invalid API key",
    "status": 401
  }
}