GetTourPattern

POST

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

Gets the Tour Pattern belonging to @shift_template_sid and the org sending the request.
Errors:

grpc.Invalid: the request data is invalid.

grpc.NotFound: the requested Tour Pattern does not exist.

grpc.Internal: error occurs when getting the data.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "shift_template_sid": 0
}

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/gettourpattern' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shift_template_sid": 0
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "tour_pattern": {
        "tour_pattern_sid": 0,
        "shift_template_sid": 0,
        "member_tour_week_patterns": [
            {
                "tour_week_pattern_sid": 0,
                "tour_pattern_sid": 0,
                "week_pattern_number": 0,
                "member_tour_shift_instance_configs": [
                    {
                        "tour_shift_instance_config_sid": 0,
                        "tour_week_pattern_sid": 0,
                        "start_minute_in_week": 0,
                        "width_in_minutes": 0,
                        "member_tour_shift_segment_configs": [
                            {
                                "tour_shift_segment_config_sid": 0,
                                "tour_shift_instance_config_sid": 0,
                                "start_minute_in_shift": 0,
                                "width_in_minutes": 0,
                                "scheduling_activity_sid": 0
                            }
                        ]
                    }
                ]
            }
        ],
        "member_tour_agent_collections": [
            {
                "tour_agent_collection_sid": 0,
                "tour_pattern_sid": 0,
                "min_agents_to_schedule": 0,
                "max_agents_to_schedule": 0,
                "first_week_pattern_number": 0,
                "name": "string",
                "wfm_agent_sids": [
                    0
                ]
            }
        ]
    }
}

🟢200Success

Modified at 2025-09-26 15:44:58

UpsertTourPatternWithMembers

GetTourPatternWithMembers