Get List Configuration

GET

subscriber_list

{list_id}

Get List configuration

curl --request GET \
  --url https://hub.suprsend.com/v1/subscriber_list/{list_id}/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://hub.suprsend.com/v1/subscriber_list/{list_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://hub.suprsend.com/v1/subscriber_list/{list_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://hub.suprsend.com/v1/subscriber_list/{list_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://hub.suprsend.com/v1/subscriber_list/{list_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "list_id": "product_updates",
  "list_name": "Product Update",
  "list_description": "Users subscribed to the newsletter",
  "list_type": "static_list",
  "subscribers_count": 3,
  "source": "database_sync",
  "is_readonly": false,
  "status": "active",
  "track_user_entry": false,
  "track_user_exit": false,
  "requested_for_delete": false,
  "created_at": "2024-02-21T19:10:01.906000Z",
  "updated_at": "2025-04-04T07:25:43.186475Z",
  "drafts": null
}

Authorizations

Authorization

string

header

required

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

Path Parameters

list_id

string

default:_list_id_

required

Unique string identifier of the list.

Pattern: ^[a-z0-9_-]+$

Response

200

list_id

string

Unique identifier of the list.

Example:

"product_updates"

list_name

string

Name of the list.

Example:

"Product Update"

list_description

string

Brief description of the list.

Example:

"Users subscribed to the newsletter"

list_type

enum<string>

Type of the list.

Available options:

static_list,

dynamic_list

subscribers_count

integer

number of users in the list

source

string

source info on how the list is updated

Example:

"database_sync"

is_readonly

boolean

Indicates whether the list is read-only.

Example:

false

is_enabled

boolean

For dynamic_list only. Whether the segment is actively refreshing.

Example:

true

query

string

For dynamic_list only. The committed SQL query that defines the segment.

Example:

"SELECT distinct_id FROM users WHERE CAST(user_properties ->> 'lifetime_value' AS DOUBLE PRECISION) >= 2500"

status

string

Current status of the list (active or draft).

Example:

"active"

track_user_entry

boolean

Event $USER_ENTERED_LIST - <list_id> is generated when user is added this list. Use this to trigger workflow on user entry.

track_user_exit

boolean

Event $USER_EXITED_LIST - <list_id> is generated when user is removed from this list. Use this to trigger workflow on user exit.

requested_for_delete

boolean

Indicates whether the list has been requested for deletion.

Example:

false

created_at

string<date-time>

Timestamp when the list was created.

Example:

"2024-02-21T19:10:01.906000Z"

updated_at

string<date-time>

Timestamp when the list was last updated.

Example:

"2025-04-04T07:25:43.186475Z"

drafts

string | null

would show the draft list created to replace list users.

sync_task

object | null

For dynamic_list only. Metadata about the sync task that runs the segment query, including the currently active version and any uncommitted draft.

Show child attributes

⌘I

Get List configuration

curl --request GET \
  --url https://hub.suprsend.com/v1/subscriber_list/{list_id}/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://hub.suprsend.com/v1/subscriber_list/{list_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://hub.suprsend.com/v1/subscriber_list/{list_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://hub.suprsend.com/v1/subscriber_list/{list_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://hub.suprsend.com/v1/subscriber_list/{list_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "list_id": "product_updates",
  "list_name": "Product Update",
  "list_description": "Users subscribed to the newsletter",
  "list_type": "static_list",
  "subscribers_count": 3,
  "source": "database_sync",
  "is_readonly": false,
  "status": "active",
  "track_user_entry": false,
  "track_user_exit": false,
  "requested_for_delete": false,
  "created_at": "2024-02-21T19:10:01.906000Z",
  "updated_at": "2025-04-04T07:25:43.186475Z",
  "drafts": null
}

API Reference

USERS

TRIGGER WORKFLOWS

EVENTS

MESSAGES

OBJECTS

TEMPLATES

TENANTS

PREFERENCE

LISTS

BROADCAST

Authorizations

Path Parameters

Response