Get Addresses

Fetch list of addresses available for a user.

/addresses

GET https://api.terminal.africa/v1/addresses

This endpoint allows you to get a list of all addresses available.

Query Parameters

Name	Type	Description
perPage	Number	Specify how many records will be sent in a single response. Defaults to 100.
page	Number	Specify what page of records will be sent in response. Defaults to 1.

Headers

Name	Type	Description
Authorization*	String	Set value to Bearer SECRET_KEY

200 Addresses retrieved successfully.

{
    "status": true,
    "message": "Addresses retrieved successfully",
    "data": {
        "addresses": [
            {
                "address_id": "AD-00632494667",
                "city": "Lagos",
                "coordinates": {
                    "lat": 6.5969424,
                    "lng": 3.3542992
                },
                "country": "NGA",
                "email": "[email protected]",
                "first_name": "Augustus",
                "id": "d799c2679e644279b59fe661ac8fa488",
                "is_residential": true,
                "last_name": "Obi",
                "line1": "1121 Allen Avenue, Ikeja",
                "line2": "",
                "metadata": {
                    "my_app_customer_id": 11234
                },
                "name": "Augustus Obi",
                "phone": "[phone]",
                "state": "Lagos",
                "zip": "121006",
                "created_at": "2021-07-13T20:25:53.011Z",
                "updated_at": "2021-07-13T20:25:53.011Z"
            }],
        "pagination": {
            "perPage": 100,
            "prevPage": null,
            "nextPage": 2,
            "currentPage": 1,
            "total": 3,
            "pageCount": 3,
            "pagingCounter": 1,
            "hasPrevPage": false,
            "hasNextPage": true	
        }
    }
}