Skip to main content
GET
List users in user list

Authorizations

Authorization
string
header
required

Link access token for one Sandbox, Test, or Live authorization.

x-linked-account-id
string
header
required

Selects one of the authorization's linked accounts via the x-linked-account-id header.

Headers

x-linked-account-id
string
required

The linked account to use. The user must have shared it with your app. A missing account returns linked_account_required; an account outside your access returns linked_account_not_granted.

Example:

"conn_example123"

Path Parameters

listId
required
Pattern: ^\d+$

Query Parameters

limit
integer
default:10

Number of items to return (1-100, default: 10)

Required range: 1 <= x <= 100
cursor
string | null

Cursor from the previous response. Send it to get the next page.

field
enum<string>

Field to include or sort by

Available options:
expire_date,
last_activity,
subscribe_date
order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
query
string

Text to search for

Maximum string length: 100

Response

Successful response

items
object[]
required
page
object
required