Fetch User list subscriptions

GET

user

{distinct_id}

subscribed_to

list

Fetch User list subscriptions

curl --request GET \
  --url https://hub.suprsend.com/v1/user/{distinct_id}/subscribed_to/list/ \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "count": 8,
    "limit": 10,
    "has_prev": false,
    "before": null,
    "has_next": false,
    "after": "01HPMFF5V2CFCF5882QX9FQXYB"
  },
  "results": [
    {
      "list": {
        "list_description": "List of users to send newsletter to (Qualified leads + Product Users)",
        "list_id": "product_update",
        "list_name": "",
        "list_type": "static_list",
        "source": "csv_upload",
        "subscribers_count": 2,
        "updated_at": "2024-09-26T10:20:33.636698+00:00"
      },
      "created_at": "2024-08-04T13:16:12.825+00:00"
    }
  ]
}

Authorizations

Authorization

string

header

required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Path Parameters

distinct_id

string

required

Unique identifier of the user in your system

Query Parameters

limit

integer<int32>

number of results to be returned in API response

Response

200 - OK

meta

object

Metadata related to pagination.

Show child attributes

meta.count

integer

Total number of records returned.

Example:

8

meta.limit

integer

Maximum number of records per page.

Example:

10

meta.has_prev

boolean

Indicates if there is a previous page.

Example:

false

meta.before

string | null

Cursor for the previous page.

Example:

"01HPMFF5V2CFCF5882QX9FQXYB"

meta.has_next

boolean

Indicates if there is a next page.

Example:

false

meta.after

string | null

Cursor for the next page.

Example:

"01HPMFF5V2CFCFti5882QX9FQXYB"

results

object[]

List of user lists.

Show child attributes

results.list

object

Show child attributes

results.list.list_id

string

Unique identifier for the list.

Example:

"product_update"

results.list.list_name

string

Name of the list.

Example:

"Newsletter subscriber users"

results.list.description

string

Brief description of the list.

Example:

"List of users to send newsletter to"

results.list.list_type

string

Type of list (static_list, query_based)

Example:

"static_list"

results.list.source

string | null

Source from which the list was created (csv_upload, database_sync, mixpanel)

Example:

"csv_upload"

results.list.subscribers_count

integer

Number of subscribers in the list.

Example:

2

results.list.updated_at

string<date-time>

Timestamp when the list was last updated.

Example:

"2024-09-26T10:20:33.636698+00:00"

results.created_at

string<date-time>

Timestamp when the user was added to the list.

Example:

"2024-09-26T10:20:33.636698+00:00"

List UsersAPI to list cursor-based paginated list of users in your workspace.

⌘I

Fetch User list subscriptions

curl --request GET \
  --url https://hub.suprsend.com/v1/user/{distinct_id}/subscribed_to/list/ \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "count": 8,
    "limit": 10,
    "has_prev": false,
    "before": null,
    "has_next": false,
    "after": "01HPMFF5V2CFCF5882QX9FQXYB"
  },
  "results": [
    {
      "list": {
        "list_description": "List of users to send newsletter to (Qualified leads + Product Users)",
        "list_id": "product_update",
        "list_name": "",
        "list_type": "static_list",
        "source": "csv_upload",
        "subscribers_count": 2,
        "updated_at": "2024-09-26T10:20:33.636698+00:00"
      },
      "created_at": "2024-08-04T13:16:12.825+00:00"
    }
  ]
}

API Reference

USERS

TRIGGER WORKFLOWS

EVENTS

OBJECTS

TEMPLATES

TENANTS

PREFERENCE

LISTS

BROADCAST

Authorizations

Path Parameters

Query Parameters

Response