Skip to content
vocapable.Docs

Your published shifts and requests

GET
/v1/workspace/contact-center/wfm/my-schedule
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/contact-center/wfm/my-schedule?days=14' \
  --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: 14 >= 1 <= 28

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CcWfmMySchedule
object
timezone
required
Timezone
string
start
required
Start
string format: date
end
required
End
string format: date
days
required
Days
Array<object>
CcWfmMyDay
object
day
required
Day
string format: date
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
time_off
required
Time Off
boolean
requests
required
Requests
Array<object>
CcWfmRequest
object
id
required
Id
string
revision
required
Revision
integer
kind
required
Kind
string
Allowed values: time_off swap
status
required
Status
string
Allowed values: pending approved denied cancelled
requester_user_id
required
Requester User Id
string
requester_name
required
Requester Name
string
note
required
Any of:
string
start_date
required
Any of:
string format: date
end_date
required
Any of:
string format: date
shift
required
Any of:
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
counterpart_user_id
required
Any of:
string
counterpart_name
required
Any of:
string
counterpart_shift
required
Any of:
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
counterpart_status
required
Any of:
string
Allowed values: pending accepted declined
decided_by_name
required
Any of:
string
decision_note
required
Any of:
string
decided_at
required
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
can_respond
required
Can Respond
boolean
can_decide
required
Can Decide
boolean
can_cancel
required
Can Cancel
boolean
published_at
required
Any of:
string format: date-time
Example
{
  "days": [
    {
      "shifts": [
        {
          "activities": [
            {
              "kind": "break"
            }
          ],
          "status": "draft",
          "origin": "manual"
        }
      ]
    }
  ],
  "requests": [
    {
      "kind": "time_off",
      "status": "pending",
      "shift": {
        "activities": [
          {
            "kind": "break"
          }
        ],
        "status": "draft",
        "origin": "manual"
      },
      "counterpart_shift": {
        "activities": [
          {
            "kind": "break"
          }
        ],
        "status": "draft",
        "origin": "manual"
      },
      "counterpart_status": "pending"
    }
  ]
}

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