v4

latestOpenAPI 3.1.02026-08-0461143156.1 KB
contacts

List Contact Entries

List entries inside a contact list.

Requires the contact_lists:read scope on the API key.

get/v1/contact-entries

Query parameters

pageinteger

Page number.

Page number.

sizeinteger

Number of items per page.

Number of items per page.

sort_by'created_at' | 'updated_at' | 'email' | 'last_name'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

contact_list_idstring uuid required

ID of the contact list to scope the result to.

ID of the contact list to scope the result to.

emailstring nullable

Filter by email (exact match).

Filter by email (exact match).

company_domainstring nullable

Filter by company domain (exact match).

Filter by company domain (exact match).

enrichedboolean nullable

Filter by enrichment state.

Filter by enrichment state.

created_at_beforestring date-time nullable

Return entries created strictly before this timestamp.

Return entries created strictly before this timestamp.

created_at_afterstring date-time nullable

Return entries created strictly after this timestamp.

Return entries created strictly after this timestamp.

Response

Successful Response

total_countinteger required

Total number of records matching the query.

total_pagesinteger required

Total number of pages.

has_moreboolean required

Whether more pages remain after the current one.