v1

latestOpenAPI 3.1.02026-07-26620219.6 KB

Get Lists

Get a list of all existing Yotpo SMS & Email Lists

get/core/v3/stores/{store_id}/lists

Path parameters

store_idstring required

The store ID (app_key)

Query parameters

pagestring

The number of pages to return

page_sizestring

The number of results shown per page

Response

200

Example response

{
  "data": {
    "paging_info": {
      "current_results": 100,
      "current_page": 1,
      "results_per_page": 100,
      "total_results": 3,
      "total_pages": 1
    },
    "results": [
      {
        "id": "4001234",
        "name": "Default Marketing List",
        "created": "2022-09-01T15:43:55",
        "last_updated": "2023-12-27T15:27:14",
        "total_contacts": 61,
        "total_sms_subscribers": 44,
        "total_email_subscribers": 38
      }
    ]
  }
}