Wfm

{
  "data": {
    "date": "2026-08-27",
    "generated_at": "2026-08-27T13:42:11.802Z",
    "operating_date_is_override": false,
    "forecast": {
      "channels": 2,
      "intervals": 96,
      "required_agent_minutes": 14820,
      "by_channel": [
        { "channel": "voice", "intervals": 48, "required_agent_minutes": 9410 },
        { "channel": "sms", "intervals": 48, "required_agent_minutes": 5410 }
      ]
    },
    "staffing": {
      "agents_scheduled": 12,
      "assignments": 14,
      "scheduled_minutes": 6520
    },
    "open_shifts": {
      "open_count": 3,
      "pending_bids": 1
    },
    "requests": {
      "pending_total": 5,
      "by_type": [
        { "type": "time_off", "count": 3 },
        { "type": "shift_swap", "count": 2 }
      ]
    },
    "adherence": {
      "open_events": 4,
      "non_adherent_open_events": 1,
      "unevaluated_open_events": 2
    },
    "overtime": {
      "open_offers": 2
    },
    "vto": {
      "open_offers": 1
    },
    "exceptions": {
      "pending_count": 6
    }
  },
  "meta": {
    "request_id": "req_9f1c4a7b2d8e",
    "timestamp": "2026-08-27T13:42:11.802Z"
  }
}

{
  "data": {
    "date": "2026-08-27",
    "generated_at": "2026-08-27T13:42:11.802Z",
    "operating_date_is_override": false,
    "forecast": {
      "channels": 2,
      "intervals": 96,
      "required_agent_minutes": 14820,
      "by_channel": [
        { "channel": "voice", "intervals": 48, "required_agent_minutes": 9410 },
        { "channel": "sms", "intervals": 48, "required_agent_minutes": 5410 }
      ]
    },
    "staffing": {
      "agents_scheduled": 12,
      "assignments": 14,
      "scheduled_minutes": 6520
    },
    "open_shifts": {
      "open_count": 3,
      "pending_bids": 1
    },
    "requests": {
      "pending_total": 5,
      "by_type": [
        { "type": "time_off", "count": 3 },
        { "type": "shift_swap", "count": 2 }
      ]
    },
    "adherence": {
      "open_events": 4,
      "non_adherent_open_events": 1,
      "unevaluated_open_events": 2
    },
    "overtime": {
      "open_offers": 2
    },
    "vto": {
      "open_offers": 1
    },
    "exceptions": {
      "pending_count": 6
    }
  },
  "meta": {
    "request_id": "req_9f1c4a7b2d8e",
    "timestamp": "2026-08-27T13:42:11.802Z"
  }
}

Overview summary response shape

GET /api/v1/wfm/summary aggregates the whole scheduling overview in one response. The blocks below are the same shape the endpoint returns — every count is as-of-query-time, mirroring the list endpoints it reads from, so the KPI chip on the dashboard and the drill-in page it links to never disagree. Pass ?date=YYYY-MM-DD to pin a day; omit it and the date resolves to the tenant’s local operating day (same resolution the intraday panels use). The Node SDK has no typed summary() helper — call it through the generic request() escape hatch below. Request

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/summary?date=2026-08-27" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/wfm/summary?date=2026-08-27', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/wfm/summary?date=2026-08-27", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/wfm/summary?date=2026-08-27", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/wfm/summary?date=2026-08-27')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/wfm/summary?date=2026-08-27');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "date": "2026-08-27",
    "generated_at": "2026-08-27T13:42:11.802Z",
    "operating_date_is_override": false,
    "forecast": {
      "channels": 2,
      "intervals": 96,
      "required_agent_minutes": 14820,
      "by_channel": [
        { "channel": "voice", "intervals": 48, "required_agent_minutes": 9410 },
        { "channel": "sms", "intervals": 48, "required_agent_minutes": 5410 }
      ]
    },
    "staffing": {
      "agents_scheduled": 12,
      "assignments": 14,
      "scheduled_minutes": 6520
    },
    "open_shifts": {
      "open_count": 3,
      "pending_bids": 1
    },
    "requests": {
      "pending_total": 5,
      "by_type": [
        { "type": "time_off", "count": 3 },
        { "type": "shift_swap", "count": 2 }
      ]
    },
    "adherence": {
      "open_events": 4,
      "non_adherent_open_events": 1,
      "unevaluated_open_events": 2
    },
    "overtime": {
      "open_offers": 2
    },
    "vto": {
      "open_offers": 1
    },
    "exceptions": {
      "pending_count": 6
    }
  },
  "meta": {
    "request_id": "req_9f1c4a7b2d8e",
    "timestamp": "2026-08-27T13:42:11.802Z"
  }
}

Field semantics:

operating_date_is_override — true when you passed ?date=YYYY-MM-DD explicitly; false when the date resolved to your tenant’s local operating day (the same resolution the intraday staffing and adherence panels use).
forecast — null when no forecast rows exist for the day; otherwise per-channel required agent-minutes (required_agents × interval), resolved with the same math the forecast scheduler writes.
staffing — null when no roster exists for the day; otherwise the distinct agents rostered, assignment rows, and shift-window minutes (paid-included) resolved in each shift’s local timezone — matching the adherence scorer exactly across DST boundaries and midnight-spanning shifts.
requests — the agent self-serve queue; scoped to the caller. Managers (“owner”/“admin”) see org-wide counts; agents see only their own pending requests — the same scoping /wfm/requests applies, so the chip total and the page count cannot diverge.
adherence — live open events right now, split into currently non-adherent and awaiting-the-scorer buckets.
exceptions — adherence exceptions pending supervisor review only; approved/denied/cancelled close them, mirroring /wfm/adherence-exceptions.

Worked request and response samples

Copy the request as written, substitute your own ids, and compare the response envelope — a success in the same shape the numbered error sections spell out.

Open a shift for bids

POST /api/v1/wfm/open-shifts

Publish the shift to agents holding the required skill; the bid list endpoint tracks the claims until you fill it. Request

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/open-shifts" \
  -H "Content-Type: application/json" \
  -d '{
  "starts_at": "2026-09-09T14:00:00Z",
  "ends_at": "2026-09-09T22:00:00Z",
  "skill": "spanish-support"
}'

{
  "data": {
    "id": "shift_91e4b7c2d5f80316",
    "skill": "spanish-support",
    "state": "open"
  },
  "meta": {
    "request_id": "req_wfm",
    "timestamp": "2026-09-08T12:00:00Z"
  }
}

API Reference

All Endpoints

Overview summary response shape

Worked request and response samples

Open a shift for bids

​Overview summary response shape

​Worked request and response samples

​Open a shift for bids

Overview summary response shape

Worked request and response samples

Open a shift for bids