Skip to content
vocapable.Docs

Colleagues who can take one of your shifts

GET
/v1/workspace/contact-center/wfm/swap-candidates
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/contact-center/wfm/swap-candidates?shift_id=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
shift_id
required
Shift Id
string
<= 96 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcWfmSwapCandidates
object
shift_id
required
Shift Id
string
data
required
Data
Array<object>
CcWfmSwapCandidate
object
user_id
required
User Id
string
name
required
Name
string
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
Example
{
  "data": [
    {
      "shifts": [
        {
          "activities": [
            {
              "kind": "break"
            }
          ],
          "status": "draft",
          "origin": "manual"
        }
      ]
    }
  ]
}

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