ListShiftInstancesBySid

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/listshiftinstancesbysid

Lists the shift instances with the corresponding @shift_instance_sids for the org sending the request.
If @include_shift_template is set to true then the related shift template for the shift instances will be returned in the shift template field.
If @include_shift_segments is set to true then the related shift segments for the shift instances will be returned in the shift segments field.
If @include_shift_segment_call_stats is set to true then the related shift segment call stats for the shift segments will be returned in the call stats by skill collection field on the shift segments.
If @include_scheduling_activity is set to true then the related scheduling activity for the shift segment will be returned in the scheduling activity field.
@include_shift_segments must be true to take effect.
If @include_activity is set to true then the related non skill activity for the scheduling activity will be returned in the scheduling
activities member non skill activity field. @include_scheduling_activity must be true to take effect.
The given @shift_instance_sids must all belong to the given @schedule_type.
Errors:

grpc.Invalid: @shift_instance_sids in the request are invalid.

grpc.Internal: error occurs when listing the shift instances or their shift segments.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/listshiftinstancesbysid' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

Modified at 2025-08-14 21:02:57

DeleteDraftSchedule

CopyScheduleToSchedule