GET
/
api
/
v2
/
platform
/
addresses
Return a list of Addresses
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/addresses \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "1",
      "type": "address",
      "attributes": {
        "firstname": "John",
        "lastname": "Doe",
        "address1": "1 Lovely Street",
        "address2": "Northwest",
        "city": "Herndon",
        "zipcode": "35005",
        "phone": "555-555-0199",
        "state_name": null,
        "alternative_phone": "555-555-0199",
        "company": "Company",
        "created_at": "2022-11-08T19:33:50.821Z",
        "updated_at": "2022-11-08T19:33:50.821Z",
        "deleted_at": null,
        "label": null,
        "public_metadata": {},
        "private_metadata": {}
      },
      "relationships": {
        "country": {
          "data": {
            "id": "1",
            "type": "country"
          }
        },
        "state": {
          "data": {
            "id": "1",
            "type": "state"
          }
        },
        "user": {
          "data": null
        }
      }
    },
    {
      "id": "2",
      "type": "address",
      "attributes": {
        "firstname": "John",
        "lastname": "Doe",
        "address1": "2 Lovely Street",
        "address2": "Northwest",
        "city": "Herndon",
        "zipcode": "35005",
        "phone": "555-555-0199",
        "state_name": null,
        "alternative_phone": "555-555-0199",
        "company": "Company",
        "created_at": "2022-11-08T19:33:50.825Z",
        "updated_at": "2022-11-08T19:33:50.825Z",
        "deleted_at": null,
        "label": null,
        "public_metadata": {},
        "private_metadata": {}
      },
      "relationships": {
        "country": {
          "data": {
            "id": "1",
            "type": "country"
          }
        },
        "state": {
          "data": {
            "id": "2",
            "type": "state"
          }
        },
        "user": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/addresses?page=1&per_page=&include=&filter[user_id_eq]=&filter[firstname_cont]=",
    "next": "http://www.example.com/api/v2/platform/addresses?filter%5Bfirstname_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/addresses?filter%5Bfirstname_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/addresses?filter%5Bfirstname_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/addresses?filter%5Bfirstname_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page="
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
​
per_page
integer
​
include
string

Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>

​
filter[user_id_eq]
string
​
filter[firstname_cont]
string

Response

200
application/vnd.api+json

Records returned

The response is of type object.