Skip to main content
GET
Get list by ID
🎯 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:

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>