v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Enterprises

Get all enterprises

Returns all enterprises within scope of the Access Token, optionally filtered by enterprise identifiers and external identifiers. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/enterprises/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, all enterprises within scope of the Access Token are returned.

ExternalIdentifiersstring[] nullable

Identifiers of the Enterprise from external system.

Response

OK

Cursorstring uuid nullable

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