Address Book

This method is used to fetch your organisation's saved addresses and system addresses

Endpoint

Method URI Headers
GET address-book/from default
GET address-book/to default

Response

Field Type Description
success Boolean true or false
message String Message
data Array An array container for address records

Response Examples

Successful

{
    "success": true,
    "data": [
        {
            "id": 23423423423,
            "name": "Dovie O'Connell",
            "company_name": "Jacobs and Sons",
            "street_1": "Aufderhar Isle",
            "street_2": "5960 Rutherford Brook",
            "street_3": null,
            "city": "South Fletaton",
            "state": "NJ",
            "country": "DJ",
            "is_residential": 0,
            "telephone": "+15209171340",
            "email": "john@acme.com"
        },
        {
            "id": 123123123,
            "name": "Dovie O'Connell",
            "company_name": "Jacobs and Sons",
            "street_1": "Aufderhar Isle",
            "street_2": "5960 Rutherford Brook",
            "street_3": null,
            "city": "South Fletaton",
            "state": "NJ",
            "country": "DJ",
            "is_residential": 0,
            "telephone": "+15209171340",
            "email": "jane@acme.com"
        }
    ]
}

Failed

{
    "success": false,
    "message": "There was some internal error. If the issue persists, please contact our support"
}