Workload

Get a live workload snapshot

Returns live workspace, team, and admin workload. Admin rows use cursor pagination. teamId and adminId filter admin and team rows. The summary stays workspace-wide. The snapshot is cached for five seconds.

GET

/v2/workload

curl --request GET \
  --url 'https://do.featurebase.app/v2/workload?limit=50&cursor=eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9&idleThresholdMinutes=30&teamId=%3Cstring%3E&adminId=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-09-03.pulsar'

{
  "admins": {
    "data": [
      {
        "adminId": "<string>",
        "assignmentLimit": {
          "adminId": "<string>",
          "effectiveLimit": 123,
          "limit": 123,
          "mode": "inherit",
          "object": "assignment_limit",
          "paused": true
        },
        "atCapacity": true,
        "availability": {
          "adminId": "<string>",
          "automatic": true,
          "away": true,
          "changedAt": "2023-11-07T05:31:56Z",
          "lastActiveAt": "2023-11-07T05:31:56Z",
          "object": "admin_availability",
          "reason": {
            "id": "<string>",
            "label": "<string>"
          },
          "reassignReplies": true
        },
        "idleCount": 123,
        "inboxes": [
          {
            "assignmentLimit": 123,
            "atCapacity": true,
            "idleCount": 123,
            "openCount": 123,
            "snoozedCount": 123,
            "teamId": "<string>",
            "waitingCount": 123
          }
        ],
        "object": "workload_admin",
        "openCount": 123,
        "snoozedCount": 123,
        "waitingCount": 123
      }
    ],
    "nextCursor": "<string>",
    "object": "list"
  },
  "generatedAt": "2023-11-07T05:31:56Z",
  "object": "workload",
  "summary": {
    "avgWaitMs": 123,
    "awayReasonBreakdown": [
      {
        "count": 123,
        "reason": "<string>"
      }
    ],
    "closedToday": 123,
    "idleConversations": 123,
    "idleThresholdMinutes": 123,
    "longestWaitingMs": 123,
    "openConversations": 123,
    "snoozedConversations": 123,
    "unassignedConversations": 123,
    "waitingConversations": 123,
    "waitingFirstReplyConversations": 123
  },
  "teams": [
    {
      "assignedCount": 123,
      "assignmentLimit": 123,
      "atCapacityCount": 123,
      "avgWaitMs": 123,
      "awayCount": 123,
      "closedToday": 123,
      "idleCount": 123,
      "longestWaitingMs": 123,
      "memberCount": 123,
      "name": "<string>",

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Query Parameters

limitintegerquerydefault:50

Required range: 1 <= x <= 100

cursorstringquery

An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page of results.

Maximum string length: 512

Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9

idleThresholdMinutesnumberquerydefault:30

teamIdstringquery

adminIdstringquery

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-09-03.pulsar, 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-09-03.pulsar

Response

Success

adminsobjectrequired

Show child attributes

generatedAtstringrequired

objectenum<string>required

Available options: workload

summaryobjectrequired

Show child attributes

teamsobject[]required

Show child attributes

Still need help? Ask the team