Skip to main content
GET
List members

Authorizations

Authorization
string
header
required

Workspace API key, e.g. Authorization: Bearer tented_.... Create keys in Workspace Settings → API Keys.

Path Parameters

listId
string<uuid>
required

Contact list ID.

Query Parameters

page
integer
default:1

1-based page number.

Required range: x >= 1
limit
integer
default:25

Page size (1-100).

Required range: 1 <= x <= 100

Case-insensitive name/email search.

sort
enum<string>
default:updated_at

Sort key. member_added_at sorts by when the contact joined this list.

Available options:
member_added_at,
created_at,
updated_at,
last_activity_at,
display_name,
first_name,
last_name,
normalized_email,
original_source
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
exclude_unsubscribed
enum<string>

When set, omit contacts unsubscribed from marketing email.

Available options:
1,
true
only_unsubscribed
enum<string>

When set, return only contacts unsubscribed from marketing email. exclude_unsubscribed wins if both are set.

Available options:
1,
true

Response

One page of list members.

contacts
object[]
required
pagination
object
required

Offset pagination metadata.