Sign in

v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Rate groups

Get all rate groups

Returns all rate groups, filtered by unique identifiers and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/rateGroups/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.

RateGroupIdsstring[] nullable

Unique identifiers of the Rate group. Required if ServiceIds filter is not provided.

ServiceIdsstring[] nullable

Unique identifiers of the Service. Required if RateGroupIds filter is not provided.

ExternalIdentifiersstring[] nullable

Identifiers of Rate group from external systems.

ActivityStatesActivityStates[] nullable

Whether to return only active, only deleted or both records.

Response

OK

Cursorstring uuid nullable

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