Skip to main content
GET
/
list
/
{identifier}
Get list by ID
curl --request GET \
  --url https://api.sendx.io/api/v1/rest/list/{identifier} \
  --header 'X-Team-ApiKey: <api-key>'
{
  "id": "list_OcuxJHdiAvujmwQVJfd3ss",
  "name": "Newsletter Subscribers",
  "type": 123,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.sendx.io/llms.txt

Use this file to discover all available pages before exploring further.

🎯 Key Features:
  • Complete list details
  • Subscriber statistics
  • Growth metrics
  • List settings

Authorizations

​
X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

X-Team-ApiKey: your_team_api_key_here

Path Parameters

​
identifier
string
required

List identifier

  • list_OcuxJHdiAvujmwQVJfd3ss
Pattern: ^(list_)?[a-zA-Z0-9]{22}$

Response

✅ List retrieved successfully

​
id
string
Example:

"list_OcuxJHdiAvujmwQVJfd3ss"

​
name
string
Example:

"Newsletter Subscribers"

​
type
integer

List type.

Values:

  • 0 - Regular list (single opt-in)
  • 1 - Double opt-in list (requires email confirmation)
​
created
string<date-time>
​
updated
string<date-time>