List Addresses

{
    "data": [
        {
            "id": 1,
            "name": "Kohler Group",
            "email": "parisian.kristoffer@yahoo.com",
            "phone": "+12069536978",
            "line_1": "193 Dach Shores Suite 632",
            "line_2": "Apt. 300",
            "city": "Moenburgh",
            "region": "Colorado",
            "post_code": "72099",
            "country": 1,
            "created_at": "2024-12-09 22:49:57",
            "updated_at": "2024-12-09 22:49:57"
        },
        // Additional addresses...
    ],
    "links": {
        "first": "https://app.artport.co/api/v1/addresses?page=1",
        "last": null,
        "prev": null,
        "next": "https://app.artport.co/api/v1/addresses?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://app.artport.co/api/v1/addresses",
        "per_page": 20,
        "to": 20
    }
}

Overview

This endpoint can be used to retrieve a list of addresses. Endpoint: /api/v1/addresses/ Method: GET

This endpoint returns a paginated response.

Response

If the addresses are successfully retrieved, the API will return a 200 OK status code. The response will contain the following content:

array

required

An array of Address objects.If no addresses are found, the data field will be an empty array.

array

required

URLs for the first, last, previous, and next pages.Explained in further detail in the pagination guide.

array

required

Metadata about the current page.Explained in further detail in the pagination guide.

{
    "data": [
        {
            "id": 1,
            "name": "Kohler Group",
            "email": "parisian.kristoffer@yahoo.com",
            "phone": "+12069536978",
            "line_1": "193 Dach Shores Suite 632",
            "line_2": "Apt. 300",
            "city": "Moenburgh",
            "region": "Colorado",
            "post_code": "72099",
            "country": 1,
            "created_at": "2024-12-09 22:49:57",
            "updated_at": "2024-12-09 22:49:57"
        },
        // Additional addresses...
    ],
    "links": {
        "first": "https://app.artport.co/api/v1/addresses?page=1",
        "last": null,
        "prev": null,
        "next": "https://app.artport.co/api/v1/addresses?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "path": "https://app.artport.co/api/v1/addresses",
        "per_page": 20,
        "to": 20
    }
}

Get Started

Concepts

API Endpoints

Schemas

Enums

Overview

Response

​Overview

​Response

Overview

Response