Sign in

v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

Fetch User list subscriptions

API to retrieve all lists that a user is part of.

get/v1/user/{distinct_id}/subscribed_to/list/

Path parameters

distinct_idstring required

Unique identifier of the user in your system

Query parameters

limitinteger

number of results to be returned in API response

Response

200 - OK

Example response

{
  "meta": {
    "count": 8,
    "limit": 10,
    "before": "01HPMFF5V2CFCF5882QX9FQXYB",
    "after": "01HPMFF5V2CFCFti5882QX9FQXYB"
  },
  "results": [
    {
      "list": {
        "list_id": "product_update",
        "list_name": "Newsletter subscriber users",
        "description": "List of users to send newsletter to",
        "list_type": "static_list",
        "source": "csv_upload",
        "subscribers_count": 2,
        "updated_at": "2024-09-26T10:20:33.636698+00:00"
      },
      "created_at": "2024-09-26T10:20:33.636698+00:00"
    }
  ]
}