List of Addresses
GET {{baseUrl}}/addresses?offset={{offset}}&limit={{limit}}
Returns the list of all addresses for a firm
Query Parameters
| Form Parameter | type | Mandatory | Description |
|---|---|---|---|
| offset | number | Required | Example = 0 |
| limit | number | Required | Example = 500 |
Response Body
Body
Returns a list containing objects as described below
| Key | Datatype | Mandatory | Comments/ Constraints |
|---|---|---|---|
| block | string | No | Singapore only |
| buildingEstate | strings | No | Singapore only |
| careOf | string | No | |
| country | String | Yes | ISO 3166 country code/name |
| id | Number | Yes | |
| levelFloor | string | No | Singapore only |
| postCode | string | Yes | |
| state | String | Yes | If country is Australia the value must be one of 'ACT'/'NSW'/'VIC'/'QLD'/'SA'/'WA'/'TAS'/'NT'. Can also be 'Foreign' if country is not 'Australia' |
| unitFlat | String | No | Singapore only |
Additional keys
| Key | Datatype | Mandatory | Constraints |
|---|---|---|---|
| offset | Number | Yes | |
| limit | Number | Yes | |
| total | Number | Yes |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
offset | string | number | |
limit | string | number |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"addresses":[{"block":null,"buildingEstate":null,"careOf":"","country":"AUSTRALIA","id":929212,"levelFloor":null,"postcode":"3187","state":"VIC","streetLine1":"606 Hawthorn Road","streetLine2":"","suburb":"BRIGHTON EAST","unitFlat":null},{"block":null,"buildingEstate":null,"careOf":null,"country":"AUSTRALIA","id":1274612,"levelFloor":null,"postcode":"3000","state":"VIC","streetLine1":"78 Test Road","streetLine2":"","suburb":"MELBOURNE","unitFlat":null}],"limit":2,"offset":0,"total":2}