ListAgentLeavePetitions

POST

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

Lists agent leave petitions for the @wfm_agent_sids over @datetime_range for the org sending the request.
If no @wfm_agent_sids are provided, all agent leave petitions overlapping @datetime_range for the org sending the request will be returned.
If no @datetime_range is provided, petitions will be returned across all datetimes.
If @include_archived is true, archived agent leave petitions will be returned as well, otherwise archived requests will not be included.
If no agent leave petitions are found for the given parameters, an empty slice will be returned.
Errors:

grpc.Invalid: the request data is invalid.

grpc.Internal: error occurs when listing the agent leave petitions.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "wfm_agent_sids": [
        0
    ],
    "datetime_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "include_archived": 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/listagentleavepetitions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "wfm_agent_sids": [
        0
    ],
    "datetime_range": {
        "start_datetime": "1s",
        "end_datetime": "1s"
    },
    "include_archived": true
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "agent_leave_petitions": [
        {
            "agent_leave_petition_id": 0,
            "wfm_agent_sid": 0,
            "petition_status": "UNSPECIFIED_PETITION_STATUS",
            "petition_comment": "string",
            "response_comment": "string",
            "requested_datetime_ranges": [
                {
                    "start_datetime": "1s",
                    "end_datetime": "1s"
                }
            ],
            "created_time": "1s",
            "archived_time": "1s",
            "resolved_time": "1s",
            "resolved_by_user_id": "string",
            "requested_hours_off": 0
        }
    ]
}

🟢200Success

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

CreateAgentLeavePetition

ArchiveAgentLeavePetition