Get all addresses
POST /api/connector/v1/addresses/getAll
Returns all addresses associated with the specified accounts within the enterprise. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of Chain. If not specified, the operation returns data for all chains within scope of the Access Token.
Unique identifiers of Addresses within the enterprise. Use this property if you want to fetch specific addresses. Required if no other filter is provided.
Interval of Address last update date and time. Required if no other filter is provided.
object
Whether to return only active, only deleted or both records.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ChainIds": [ "1df21f06-0cfc-4960-9c58-a3bf1261663e", "5fcd1933-22f2-40b9-84da-7db04cbecec2" ], "AccountIds": [ "3db2c989-7d95-42b4-a502-a9f246db1634" ], "AddressIds": [ "fc7b2df3-de66-48a6-907d-af4600ecd892" ], "UpdatedUtc": { "StartUtc": "2022-12-10T00:00:00Z", "EndUtc": "2022-12-17T00:00:00Z" }, "ActivityStates": [ "Active" ], "Limitation": { "Count": 10 }}Responses
Section titled “ Responses ”OK
object
The collection of Account addresses, containing address and account information.
object
Unique identifier of the address.
Unique identifier of the chain.
First line of the address.
Second line of the address.
The city.
Postal code.
ISO 3166-1 alpha-2 code of the Country.
ISO 3166-2 code of the administrative division, e.g. DE-BW.
The latitude.
The longitude.
Last update date and time of the address in UTC timezone in ISO 8601 format.
Whether the address is still active.
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.
Example
{ "Addresses": [ { "Id": "fc7b2df3-de66-48a6-907d-af4600ecd892", "AccountId": "3db2c989-7d95-42b4-a502-a9f246db1634", "AccountType": "Customer", "Line1": "I.P. Pavlova 5", "Line2": null, "City": "Prague", "PostalCode": "12000", "CountryCode": "CZ", "CountrySubdivisionCode": null, "Latitude": null, "Longitude": null, "UpdatedUtc": "2023-11-29T14:49:29.982Z", "IsActive": true } ]}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.