EQequalsmoney
Addresses

List addresses

Returns a list of addresses associated with a given account.

get/addresses

Request

Query parameters

accountIdstring required

The ID of the account to work with.

Example:F50091
limitinteger

The maximum number of results to return.

Example:200
offsetinteger

The number of items to skip before returning results.

Example:100
searchstring

The term to search the records for.

Example:Cesar+Treutel
'registered' | 'office'
OR
string[]
format'iso20022'

The format to return the addresses in.

Response

OK

limitinteger

The maximum number of results to return.

offsetinteger

The number of items to skip before returning results.

countinteger required

The total amount of records matching the querying when "limit" is ignored.

Example response

{
  "limit": 200,
  "offset": 100,
  "count": 67,
  "rows": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "office",
      "nickName": "office",
      "addressLine1": "Great Building",
      "addressLine2": "Four Maple Street",
      "addressLine3": "Southwark",
      "addressContact": "Brian May",
      "city": "string",
      "postcode": "SE13UB",
      "country": "England",
      "countryCode": "GB"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.