Sign in
latestOpenAPI 3.0.42026-08-202078952.1 MB

f37f136ed35a

Business segments

Get all business segments

Returns all business segments. This operation supports Portfolio Access Tokens.

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

Idsstring[] nullable

Unique identifiers of the requested Business segment.

ServiceIdsstring[] nullable

Unique identifiers of the Services from which the business segments are requested.

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 business segment item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older business segment.