contacts

List Contact Entries

Changed on

List entries inside a contact list.

Requires the contact_lists:read scope on the API key.

get/v1/contact-entries

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/contact-entries
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number.

sizeinteger

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.

emailstring nullable

Filter by email (exact match).

company_domainstring nullable

Filter by company domain (exact match).

external_contact_idstring nullable

Filter by external CRM contact identifier (exact match).

enrichedboolean nullable

Filter by enrichment state.

created_at_beforestring date-time nullable

Return entries created strictly before this timestamp.

created_at_afterstring date-time nullable

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.

Changes

  • b390cd1c4e2aRevision changes
    • info

      added the new optional query request parameter external_contact_id

    • info

      added the required property // to the response with the status