ConnectCloud Developers

SLA clocks of an item with the share of the target used (desk:read)

GET /api/desk/v1/items/{ref}/sla

Module: Desk · operationId: getItemSla · Tag: SLA · Auth: access token (Authorization: Bearer <accessToken>)

Parameters

Name In Type Required Description
ref path string yes Item id or number

Responses

  • 200 Clocks (application/json)

Fields of the 200 answer:

  • items (array of SLAClock, required)
    • breachedAt (string (date-time), nullable): When the target was breached
    • cycle (integer): Cycle of the target on the item (a target can run more than once)
    • dueAt (string (date-time), nullable): When the target is due
    • itemId (string): Item of the clock
    • metAt (string (date-time), nullable): When the target was met
    • mode (string): business: counts service hours; wall: counts wall-clock time
    • percent (integer): Share of the target used (percent)
    • policyKey (string): Policy the clock started with
    • startedAt (string (date-time)): When the clock started
    • state (string): State of the clock (one of running, paused, met, stopped)
    • target (string): Target the clock measures
    • targetMinutes (integer): Target in minutes
    • usedMinutes (integer): Minutes used so far
    • warnAt (string (date-time), nullable): When the warning is due
    • warnedAt (string (date-time), nullable): When the warning was written

Example 200 answer:

{
  "items": [
    {
      "cycle": 1,
      "dueAt": "2026-11-17T11:12:00Z",
      "itemId": "4a1b2c3d-5e6f-4a7b-8c9d-1e2f3a4b5c01",
      "metAt": "2026-11-17T07:20:04Z",
      "mode": "business",
      "percent": 3,
      "policyKey": "standard",
      "startedAt": "2026-11-17T07:12:00Z",
      "state": "met",
      "target": "first_response",
      "targetMinutes": 240,
      "usedMinutes": 8
    },
    {
      "cycle": 1,
      "dueAt": "2026-11-17T15:12:00Z",
      "itemId": "4a1b2c3d-5e6f-4a7b-8c9d-1e2f3a4b5c01",
      "mode": "business",
      "percent": 21,
      "policyKey": "standard",
      "startedAt": "2026-11-17T07:12:00Z",
      "state": "running",
      "target": "resolution",
      "targetMinutes": 480,
      "usedMinutes": 103,
      "warnAt": "2026-11-17T13:36:00Z"
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/desk/v1/items/string/sla' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI