Skip to Content
DevelopersAPI ReferenceSchedules

Schedules

REST endpoints for Schedules. 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 monitoring schedules

GET/v1/projects/{projectId}/schedules

Get monitoring schedules for all dimensions in a project. Returns the current configuration (enabled/disabled, interval) and timing (next run, last run) for each monitoring dimension. Use this to monitor scheduling health, detect stalled dimensions, or build alerting around missed runs.

Returns · { items }

Path parameters

NameTypeDescription
projectIdstringProject ID

Request

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

Response 200 OK

{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "dimension": "tech-trust",
      "enabled": true,
      "intervalDays": 14,
      "nextRunAt": "2026-03-29T10:00:00.000Z",
      "lastRunAt": "2026-03-15T10:00:00.000Z"
    }
  ]
}

Errors

StatusCodeMeaning
401api_key_missing · api_key_invalid · api_key_revoked · api_key_expired · insufficient_scopeThe CL-API-Key is missing, malformed, revoked, expired, or lacks the required scope.

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
  }
}
Last updated on
AlertsStrategic Briefing