Skip to content
vocapable.Docs

The planning grid: people, shifts and coverage

GET
/v1/workspace/contact-center/wfm/schedule
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/contact-center/wfm/schedule?days=7' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
start
Any of:
string format: date
days
Days
integer
default: 7 >= 1 <= 28
team
Any of:
string
<= 96 characters
user
Any of:
Array<string>
<= 200 items
queue
Any of:
Array<string>
<= 50 items

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcWfmSchedule
object
start
required
Start
string format: date
end
required
End
string format: date
timezone
required
Timezone
string
people
required
People
Array<object>
CcWfmSchedulePerson
object
user_id
required
User Id
string
name
required
Name
string
team_ids
required
Team Ids
Array<string>
queue_keys
required
Queue Keys
Array<string>
time_off_days
required
Time Off Days
Array<string>
has_working_hours
required
Has Working Hours
boolean
shifts
required
Shifts
Array<object>
CcWfmShift
object
id
required
Id
string
revision
required
Revision
integer
user_id
required
User Id
string
user_name
required
User Name
string
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
day
required
Day
string format: date
activities
required
Activities
Array<object>
CcWfmActivity
object
kind
required
Kind
string
Allowed values: break lunch meeting training coaching custom time_off
starts_at
required
Starts At
string format: date-time
ends_at
required
Ends At
string format: date-time
reason_code
Any of:
string
label
Any of:
string
status
required
Status
string
Allowed values: draft published
template_id
required
Any of:
string
origin
required
Origin
string
Allowed values: manual generated swap template
published_at
required
Any of:
string format: date-time
changed_since_publish
required
Changed Since Publish
boolean
can_edit
required
Can Edit
boolean
coverage
required
Coverage
Array<object>
CcWfmCoverageInterval

The planning view’s coverage line: required (from the forecast) vs scheduled.

object
interval_start
required
Interval Start
string format: date-time
required
required
Required
integer
required_scheduled
required
Required Scheduled
integer
scheduled_heads
required
Scheduled Heads
integer
scheduled_on_queue
required
Scheduled On Queue
integer
gap
required
Gap
integer
activity_types
required
Activity Types
Array<object>
CcWfmActivityType

What a planner can put on a shift: the built-in reasons and the company’s own CC2 reason codes (custom + reason_code).

object
kind
required
Kind
string
Allowed values: break lunch meeting training coaching custom time_off
reason_code
required
Any of:
string
label
required
Label
string
can_edit
required
Can Edit
boolean
Example
{
  "shifts": [
    {
      "activities": [
        {
          "kind": "break"
        }
      ],
      "status": "draft",
      "origin": "manual"
    }
  ],
  "activity_types": [
    {
      "kind": "break"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}