GET /v1/products/lists — retrieve your product lists

Use GET /v1/products/lists to retrieve all product lists associated with your API key. You can optionally filter the results by one or more metadata key:value pairs. The response includes list summaries — name, products_count, and metadata — but not the individual product details.

This endpoint returns list summaries only. It does not return the products inside each list. To retrieve full product data for a specific list, use GET /v1/products/lists/.

Request

Endpoint: GET /v1/products/lists

Headers

string

required

Your API key as a Bearer token: Bearer {your_api_key}.

Query parameters

integer

default:"1"

Page number for paginating through results.

integer

default:"100"

Number of lists to return per page.

string

Filter lists by a metadata key:value pair. Repeat for multiple filters. Only lists that match all specified pairs are returned.

?metadata[category]=tech_products&metadata[campaign]=summer

Example requests

curl --request GET \
  --url 'https://api.affiliate.com/v1/products/lists' \
  --header 'Authorization: Bearer {your_api_key}'

curl --request GET \
  --url 'https://api.affiliate.com/v1/products/lists?metadata[category]=tech_products&metadata[campaign]=summer' \
  --header 'Authorization: Bearer {your_api_key}'

Response

A 200 OK response contains a paginated data array of list summary objects and a meta object with pagination details.

{
  "meta": {
    "total": 3,
    "from": 1,
    "to": 3,
    "current_page": 1,
    "last_page": 1,
    "per_page": 100,
    "fields": [],
    "trace_id": "019643ea-b78c-704e-b616-d67cfdbcbc2f"
  },
  "data": [
    {
      "id": "9ea4894b-8491-4a79-9419-902b69f70bed",
      "name": "listnamehere",
      "metadata": {
        "key1": "metavalueiwantreturned"
      },
      "products_count": 2,
      "product_ids": [
        "8099982740095203709",
        "8099987467386791069"
      ],
      "products": [
        {
          "id": "8099982740095203709",
          "name": "Acrylic Bubblegum Tupac by N Perez Print",
          "image_url": "https://assets.wfcdn.com/im/96908466/resize-h400-w400%5Ecompr-r85/7745/77458008/.jpg"
        },
        {
          "id": "8099987467386791069",
          "name": "Bubblegum Tupac by N Perez - Round Photograph",
          "image_url": "https://assets.wfcdn.com/im/08259379/resize-h400-w400%5Ecompr-r85/7745/77458009/.jpg"
        }
      ]
    }
  ]
}

Response fields

object

Pagination and request metadata.

Show meta properties

integer

Total number of lists matching the query.

integer

Index of the first result on this page.

integer

Index of the last result on this page.

integer

Current page number.

integer

Last available page number.

integer

Number of results per page.

array

Fields included in the response. Empty array means all fields are returned.

string

Unique request identifier. Include this when contacting support.

array

Array of list summary objects.

Show data item properties

string

Unique list identifier.

string

List display name.

object

Key:value metadata pairs associated with this list.

integer

Number of products in the list.

string[]

Array of product ID strings stored in the list.

array

Lightweight product previews — each contains id, name, and image_url only. To get full product details, use GET /v1/products/lists/.

Account

Networks

Merchants

Products

Tools

Watches

Product Lists

Pools

Reports

GET /v1/products/lists — retrieve your product lists

Request

Headers

Query parameters

Example requests

Response

Response fields

​Request

​Headers

​Query parameters

​Example requests

​Response

​Response fields

Request

Headers

Query parameters

Example requests

Response

Response fields