AgentListLeavePetitions

POST

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

Lists agent leave petitions over the @datetime_range for the agent and org sending the request.
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 list will be returned.
Errors:

grpc.Invalid: the request data is invalid.

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

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

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

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

AgentGetSchedule

AgentCreateLeavePetition