ListReasonCodes

POST

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

Lists the reason codes for @scheduling_activity_sids and the org sending the request.
If include_inactive is set to true, inactivate reason codes will be included in the response.
Otherwise, only active reason codes will be included.
Required permissions:
NONE
Errors:

grpc.Internal: error occours when listing the reason codes.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "scheduling_activity_sids": [
        0
    ],
    "include_inactive": true
}

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/listreasoncodes' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "scheduling_activity_sids": [
        0
    ],
    "include_inactive": true
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "reason_codes_by_scheduling_activity": {
        "property1": {
            "reason_codes": [
                {
                    "reason_code_id": 0,
                    "name": "string",
                    "scheduling_activity_sid": 0,
                    "is_planned": true,
                    "is_paid": true,
                    "is_default": true,
                    "datetime_set_to_inactive": "1s"
                }
            ]
        },
        "property2": {
            "reason_codes": [
                {
                    "reason_code_id": 0,
                    "name": "string",
                    "scheduling_activity_sid": 0,
                    "is_planned": true,
                    "is_paid": true,
                    "is_default": true,
                    "datetime_set_to_inactive": "1s"
                }
            ]
        }
    }
}

🟢200Success

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

GetDefaultReasonCode

DeleteShiftInstances