Sign in
Addresses

Get all addresses

Returns all addresses associated with the specified accounts within the enterprise. Note this operation uses Pagination and supports Portfolio Access Tokens.

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

ChainIdsstring[] nullable

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

AccountIdsstring[] nullable

Unique identifiers of Companies or Customers within the enterprise. Required if no other filter is provided.

AddressIdsstring[] nullable

Unique identifiers of Addresses within the enterprise. Use this property if you want to fetch specific addresses. Required if no other filter is provided.

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

Changes

No recorded changes to this endpoint across all 10 revisions of this API.