{
  "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"
  }
}

Languages: every operation supports cURL, Node.js (TypeScript), Python, Go, Ruby, and PHP. The first 15 operations on this page show all six languages; the remaining 16 show cURL and TypeScript — the two most-used.

WFM API

WFM endpoints exposed by the Devotel CPaaS API Base path: /api/v1/wfm Endpoint count: 31

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.

List the per-agent skill registry

GET /api/v1/wfm/agent-skills

Lists agent-skill rows — the registry schedule generation matches against each shift’s required_skills list. An agent is only proposed for a generated assignment when their registry skills cover the shift’s requirements. Skills are free-form tenant-defined text (up to 64 characters); proficiency_level runs 1 (novice) to 5 (expert). Filterable by agent_id and/or skill; composite-key cursor pagination stays stable across concurrent upserts/deletes. Available to all roles.

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/agent-skills" \
  -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/agent-skills', {
  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/agent-skills", 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/agent-skills", 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/agent-skills')
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/agent-skills');
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"
  }
}

List open-shifts

GET /api/v1/wfm/open-shifts

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/open-shifts" \
  -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/open-shifts', {
  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/open-shifts", 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/open-shifts", 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/open-shifts')
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/open-shifts');
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"
  }
}

Get open-shifts

GET /api/v1/wfm/open-shifts/{id}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", 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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", 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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
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"
  }
}

List bids

GET /api/v1/wfm/open-shifts/{id}/bids

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids" \
  -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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids', {
  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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids", 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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids", 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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids')
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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids');
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"
  }
}

List overtime-offers

GET /api/v1/wfm/overtime-offers

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/overtime-offers" \
  -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/overtime-offers', {
  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/overtime-offers", 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/overtime-offers", 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/overtime-offers')
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/overtime-offers');
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"
  }
}

Get overtime-offers

GET /api/v1/wfm/overtime-offers/{id}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", 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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", 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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
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"
  }
}

List claims

GET /api/v1/wfm/overtime-offers/{id}/claims

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims" \
  -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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims', {
  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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims", 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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims", 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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims')
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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims');
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"
  }
}

Get the WFM overview summary

GET /api/v1/wfm/summary

Single-request aggregate behind the scheduling overview: forecast coverage, rostered staffing, live adherence, pending requests, open shifts, unfilled overtime/VTO offers, and pending adherence exceptions for the operating day. Counts follow the same role scoping as the underlying list endpoints — non-managers see their own queue counts.

string

Operating-date override (YYYY-MM-DD). Defaults to the tenant’s local operating day — the same resolution the intraday staffing and adherence panels use.

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/summary" \
  -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', {
  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", 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", 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')
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');
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"
  }
}

List vto-offers

GET /api/v1/wfm/vto-offers

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/vto-offers" \
  -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/vto-offers', {
  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/vto-offers", 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/vto-offers", 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/vto-offers')
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/vto-offers');
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"
  }
}

Get vto-offers

GET /api/v1/wfm/vto-offers/{id}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3" \
  -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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3', {
  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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", 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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3", 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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3')
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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3');
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"
  }
}

List claims

GET /api/v1/wfm/vto-offers/{id}/claims

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/wfm/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims" \
  -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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims', {
  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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims", 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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims", 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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims')
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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims');
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"
  }
}

Open-shifts wfm

POST /api/v1/wfm/open-shifts

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/open-shifts" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/open-shifts', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/wfm/open-shifts", headers=headers, json={})
print(r.json())

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/wfm/open-shifts", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/wfm/open-shifts')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
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/open-shifts');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
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"
  }
}

Create award

POST /api/v1/wfm/open-shifts/{id}/award

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/award" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/award', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/award", headers=headers, json={})
print(r.json())

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/award", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/award')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/award');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
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"
  }
}

Create bids

POST /api/v1/wfm/open-shifts/{id}/bids

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids", headers=headers, json={})
print(r.json())

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
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"
  }
}

Create withdraw

POST /api/v1/wfm/open-shifts/{id}/bids/{bidId}/withdraw

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids/{bidId}/withdraw" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids/{bidId}/withdraw', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids/{bidId}/withdraw", headers=headers, json={})
print(r.json())

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids/{bidId}/withdraw", bytes.NewBuffer([]byte(`{}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids/{bidId}/withdraw')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {}.to_json
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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/bids/{bidId}/withdraw');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{}
JSON);
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"
  }
}

Create cancel

POST /api/v1/wfm/open-shifts/{id}/cancel

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/cancel" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/open-shifts/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/cancel', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Overtime-offers wfm

POST /api/v1/wfm/overtime-offers

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/overtime-offers" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/overtime-offers', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Create award

POST /api/v1/wfm/overtime-offers/{id}/award

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/award" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/award', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Create cancel

POST /api/v1/wfm/overtime-offers/{id}/cancel

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/cancel" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/cancel', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Create claims

POST /api/v1/wfm/overtime-offers/{id}/claims

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Create withdraw

POST /api/v1/wfm/overtime-offers/{id}/claims/{claimId}/withdraw

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims/{claimId}/withdraw" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/overtime-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims/{claimId}/withdraw', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Apply rebalancing

POST /api/v1/wfm/rebalancing/apply

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/rebalancing/apply" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/rebalancing/apply', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Generate schedules

POST /api/v1/wfm/schedules/generate

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/schedules/generate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/schedules/generate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Commit generate

POST /api/v1/wfm/schedules/generate/commit

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/schedules/generate/commit" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/schedules/generate/commit', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Vto-offers wfm

POST /api/v1/wfm/vto-offers

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/vto-offers" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/vto-offers', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Create award

POST /api/v1/wfm/vto-offers/{id}/award

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/award" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/award', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Create cancel

POST /api/v1/wfm/vto-offers/{id}/cancel

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/cancel" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/cancel', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Create claims

POST /api/v1/wfm/vto-offers/{id}/claims

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Create withdraw

POST /api/v1/wfm/vto-offers/{id}/claims/{claimId}/withdraw

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/wfm/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims/{claimId}/withdraw" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/vto-offers/num_8fb2d1b7c00c4ec9a1d3f5e7b9c1d3/claims/{claimId}/withdraw', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Upsert one agent-skill row (set or re-rate proficiency)

PUT /api/v1/wfm/agent-skills/{agentId}/{skill}

Upserts the (agent_id, skill) pair with the given proficiency_level — idempotent on the composite key, so re-rating an agent’s proficiency is a single PUT with no read-then-write race. Schedule generation only proposes an agent for a generated assignment when the agent’s registry skills cover the shift’s required_skills. Owner/admin only.

string

required

—

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/wfm/agent-skills/agt_7e3b9c1f/{skill}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/agent-skills/agt_7e3b9c1f/{skill}', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

Remove one agent-skill row

DELETE /api/v1/wfm/agent-skills/{agentId}/{skill}

Removes the (agent_id, skill) pair from the registry. Returns 404 when the pair is not registered. Owner/admin only.

string

required

—

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/wfm/agent-skills/agt_7e3b9c1f/{skill}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

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/agent-skills/agt_7e3b9c1f/{skill}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "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"
  }
}

API Reference

All Endpoints

WFM API

WFM API

Overview summary response shape

List the per-agent skill registry

List open-shifts

Get open-shifts

List bids

List overtime-offers

Get overtime-offers

List claims

Get the WFM overview summary

List vto-offers

Get vto-offers

List claims

Open-shifts wfm

Create award

Create bids

Create withdraw

Create cancel

Overtime-offers wfm

Create award

Create cancel

Create claims

Create withdraw

Apply rebalancing

Generate schedules

Commit generate

Vto-offers wfm

Create award

Create cancel

Create claims

Create withdraw

Upsert one agent-skill row (set or re-rate proficiency)

Remove one agent-skill row

​WFM API

​Overview summary response shape

​List the per-agent skill registry

​List open-shifts

​Get open-shifts

​List bids

​List overtime-offers

​Get overtime-offers

​List claims

​Get the WFM overview summary

​List vto-offers

​Get vto-offers

​List claims

​Open-shifts wfm

​Create award

​Create bids

​Create withdraw

​Create cancel

​Overtime-offers wfm

​Create award

​Create cancel

​Create claims

​Create withdraw

​Apply rebalancing

​Generate schedules

​Commit generate

​Vto-offers wfm

​Create award

​Create cancel

​Create claims

​Create withdraw

​Upsert one agent-skill row (set or re-rate proficiency)

​Remove one agent-skill row

WFM API

Overview summary response shape

List the per-agent skill registry

List open-shifts

Get open-shifts

List bids

List overtime-offers

Get overtime-offers

List claims

Get the WFM overview summary

List vto-offers

Get vto-offers

List claims

Open-shifts wfm

Create award

Create bids

Create withdraw

Create cancel

Overtime-offers wfm

Create award

Create cancel

Create claims

Create withdraw

Apply rebalancing

Generate schedules

Commit generate

Vto-offers wfm

Create award

Create cancel

Create claims

Create withdraw

Upsert one agent-skill row (set or re-rate proficiency)

Remove one agent-skill row