Shift templates and the activity types

GET

/v1/workspace/contact-center/wfm/shift-templates

const url = 'https://api.vocapable.com/v1/workspace/contact-center/wfm/shift-templates';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.vocapable.com/v1/workspace/contact-center/wfm/shift-templates \
  --header 'Authorization: Bearer <token>'

Authorizations

HTTPBearer

Responses

200

Successful Response

application/json

CcWfmShiftTemplates

object

data

required

Data

Array<object>

CcWfmShiftTemplate

object

required

string

revision

required

Revision

integer

name

required

Name

string

start_time

required

Start Time

string

duration_minutes

required

Duration Minutes

integer

weekdays

required

Weekdays

Array<integer>

activities

required

Activities

Array<object>

CcWfmTemplateActivity

object

kind

required

Kind

string

Allowed values: break lunch meeting training coaching custom time_off

offset_minutes

required

Offset Minutes

integer

<= 960

duration_minutes

required

Duration Minutes

integer

>= 15 <= 960

reason_code

Any of:

string
null

string

>= 1 characters <= 96 characters /^[A-Za-z0-9_:-]+$/

archived

required

Archived

boolean

created_at

required

Created At

string format: date-time

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
null

string

label

required

Label

string

Example

{
  "data": [
    {
      "activities": [
        {
          "kind": "break"
        }
      ]
    }
  ],
  "activity_types": [
    {
      "kind": "break"
    }
  ]
}