Contacts

List contacts

Get a paginated list of contacts with cursor-based pagination.

get/contacts

Query parameters

limitinteger

Maximum items per page. Values above 100 are clamped to 100.

cursorstring

Pagination cursor. Pass the cursor returned by the previous page.

searchstring

Case-insensitive substring match on email.

subscribedboolean

Filter by subscription state. Omit to return both subscribed and unsubscribed contacts.

sort'email' | 'createdAt'

Column to sort by. Unrecognised values fall back to createdAt.

dir'asc' | 'desc'

Sort direction. Unrecognised values fall back to the default.

List of contacts

cursorstring nullable

Cursor for the next page. Pass this back as the cursor query parameter to fetch the next page.

hasMoreboolean

totalinteger

Total count. Only populated on the first page (when no cursor is supplied); subsequent pages return 0 to avoid the recount cost.