Sign in

v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Cancellation policies

Get all cancellation policies

Restricted!

This operation is currently in beta-test and as such it is subject to change. Returns all cancellation policies, filtered by services, rate groups and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/cancellationPolicies/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

ServiceIdsstring[] required

Unique identifiers of the Service.

CancellationPolicyIdsstring[] nullable

Unique identifiers of the Cancellation Policy. Required if no other filter is provided.

RateGroupIdsstring[] nullable

Unique identifiers of the Rate group. Required if no other filter is provided.

ActivityStatesActivityStates[] nullable

Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned.

Response

OK

Cursorstring uuid nullable

Unique identifier of the last and hence oldest cancellation policy returned. This can be used in Limitation in a subsequent request to fetch the next batch of older cancellation policies.