GET
/
v1
/
subscriber_list
curl --request GET \
  --url https://hub.suprsend.com/v1/subscriber_list/ \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "count": 53,
    "limit": 2,
    "offset": 0
  },
  "results": [
    {
      "drafts": null,
      "source": null,
      "status": "active",
      "list_id": "list_01",
      "list_name": "sample list 01",
      "list_type": "static_list",
      "created_at": "2025-04-04T07:33:06.943+00:00",
      "updated_at": "2025-04-04T07:33:06.943+00:00",
      "version_id": null,
      "is_readonly": false,
      "track_user_exit": false,
      "list_description": "_some sample description_",
      "track_user_entry": false,
      "subscribers_count": 0,
      "requested_for_delete": false
    },
    {
      "drafts": null,
      "source": "database_sync",
      "status": "active",
      "list_id": "list_02",
      "list_name": "sample list 02",
      "list_type": "static_list",
      "created_at": "2024-12-20T12:09:28.727+00:00",
      "updated_at": "2025-04-04T07:32:32.127275+00:00",
      "version_id": null,
      "is_readonly": false,
      "track_user_exit": true,
      "list_description": "_some sample description_",
      "track_user_entry": true,
      "subscribers_count": 31,
      "requested_for_delete": false
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
string
default:20

number of results to be returned in API response

offset
string
default:0

starting position of tenant list

Response

200
application/json
200
meta
object
results
object[]

List object similar to list upsert function.