Skip to main content
GET
Get all lists
🎯 Key Features:
  • View all lists
  • Check 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:

Query Parameters

offset
integer
default:0

Number of records to skip for pagination

Required range: x >= 0
limit
integer
default:10

Maximum number of lists to return (max: 500)

Required range: 1 <= x <= 100

Search lists by name

Required string length: 2 - 100

Response

✅ Lists 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>