ListShiftSegmentsByShiftInstanceSids

POST

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

Lists shift segments for the specified shift instances for the org sending the request.
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.
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.
The given @shift_instance_sids must all belong to the given @schedule_type.
Errors:

grpc.Invalid: the request data is invalid.

grpc.NotFound: a shift instance doesn't exist.

grpc.Internal: error occurs when getting the data.

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/listshiftsegmentsbyshiftinstancesids' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

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

ListShiftInstanceSidsForSchedule

SetSchedulingTarget