GET
/
api
/
v2
/
platform
/
wishlists
Return a list of Wishlists
curl --request GET \
  --url http://{defaultHost}/api/v2/platform/wishlists \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "22",
      "type": "wishlist",
      "attributes": {
        "name": "Black Friday",
        "is_private": true,
        "is_default": false,
        "created_at": "2022-11-08T19:36:06.256Z",
        "updated_at": "2022-11-08T19:36:06.256Z",
        "token": "PunEhftsfcoHddCoVyqQLTYq",
        "variant_included": false
      },
      "relationships": {
        "wished_items": {
          "data": [
            {
              "id": "17",
              "type": "wished_item"
            },
            {
              "id": "18",
              "type": "wished_item"
            }
          ]
        }
      }
    },
    {
      "id": "23",
      "type": "wishlist",
      "attributes": {
        "name": "Birthday",
        "is_private": true,
        "is_default": false,
        "created_at": "2022-11-08T19:36:06.257Z",
        "updated_at": "2022-11-08T19:36:06.257Z",
        "token": "FYKHQXSsnSwAVEaci7RgbPXq",
        "variant_included": false
      },
      "relationships": {
        "wished_items": {
          "data": [
            {
              "id": "19",
              "type": "wished_item"
            },
            {
              "id": "20",
              "type": "wished_item"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "count": 2,
    "total_count": 2,
    "total_pages": 1
  },
  "links": {
    "self": "http://www.example.com/api/v2/platform/wishlists?page=1&per_page=&include=&filter[name_cont]=",
    "next": "http://www.example.com/api/v2/platform/wishlists?filter%5Bname_cont%5D=&include=&page=1&per_page=",
    "prev": "http://www.example.com/api/v2/platform/wishlists?filter%5Bname_cont%5D=&include=&page=1&per_page=",
    "last": "http://www.example.com/api/v2/platform/wishlists?filter%5Bname_cont%5D=&include=&page=1&per_page=",
    "first": "http://www.example.com/api/v2/platform/wishlists?filter%5Bname_cont%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[name_cont]
string

Response

200
application/vnd.api+json

Records returned

The response is of type object.