🏨Get All Addresses

Retrieve all the Address records on your unique Gathr database.

Get All Addresses

GET {{baseUrl}}/addresses

Get all of the Address records that have been created on your tenant. You may choose to filter this search by customer to lookup only the addresses for that specific customer.

Path Parameters

Name	Type	Description
tenantId*	String	This is the tenantId that was assigned to you when your tenant was created. You will have received this information via message from a member of the Finch Technologies team. If you can't find it, please email [e-mail].
environmentUrl*	String	https://uat.apply.fincheck.co.za This is the environment URL for uat. Once you change over to prod, you would have to use: https://apply.fincheck.co.za. *Please note that you need to be set up in each environment by a member of the Finch Technologies team, who will share your bearer token with you for the specific environment in a protected link.

Query Parameters

Name	Type	Description
customer_id	String	The UUID for a specific Customer that gets generated and returned in the POST Create New Customer response.

200: OK Get All Addresses - Tenant Collection

```json
{
    "data": [
        {
            "id": "{{addressId}}",
            "address_line_1": "10 Highlands Avenue",
            "address_line_2": "Anmar Mansions",
            "suburb": "Vredehoek",
            "city": null,
            "province": null,
            "postal_code": "8001"
        },
        {
            "id": "{{addressId}}",
            "address_line_1": "10 Highlands Avenue",
            "address_line_2": "Anmar Mansions",
            "suburb": "Vredehoek",
            "city": "Cape Town",
            "province": "Western Cape",
            "postal_code": "8001"
        },
        {
            "id": "{{addressId}}",
            "address_line_1": "27 Lanner Street",
            "address_line_2": "Parkdene",
            "suburb": "Boksburg",
            "city": "Johannesburg",
            "province": "Gauteng",
            "postal_code": "1459"
        }
    ],
    "meta": {
        "total": 3,
        "count": 3,
        "per_page": 15,
        "current_page": 1,
        "total_pages": 1
    }
}
```

200: OK Get All Addresses - Single Customer

```json
{
    "data": [
        {
            "id": "{{addressId}}",
            "address_line_1": "27 Lanner Street",
            "address_line_2": "Parkdene",
            "suburb": "Boksburg",
            "city": "Johannesburg",
            "province": "Gauteng",
            "postal_code": "1459"
        }
    ],
    "meta": {
        "total": 1,
        "count": 1,
        "per_page": 15,
        "current_page": 1,
        "total_pages": 1
    }
}
```