contacts

List Contact Exclusions

Changed on

List the contact-level exclusions in the workspace.

Requires the contact_exclusions:read scope on the API key.

get/v1/contact-exclusions

Request

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

Query parameters

pageinteger

Page number.

sizeinteger

Number of items per page.

sort_by'created_at' | 'updated_at' | 'email' | 'reason'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

emailstring nullable

Filter by excluded email (exact match).

linkedin_urlstring nullable

Filter by excluded LinkedIn URL (exact match).

reason'BAD_TIMING' | 'BOUNCED' | 'COMPETITOR' | 'CONTACT_REFUSED' | 'INTERESTED' | 'MEETING' | 'NOT_INTERESTED' | 'OTHER' | 'OUT_OF_OFFICE' | 'UNKNOWN' | 'UNSUBSCRIBED' | 'WRONG_PERSON' | 'EXCLUDE_FROM_SEARCH' | 'EXCLUDE_FROM_CRM' | 'REFERRAL' | 'LEFT_COMPANY'

Filter by reason.

created_at_beforestring date-time nullable

Return exclusions created strictly before this timestamp.

created_at_afterstring date-time nullable

Return exclusions 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

  • 4c947c3f2e11Revision changes
    • warning

      added the new NOT_INTERESTED enum value to the // response property for the response status

    • info

      added the enum value NOT_INTERESTED to the property anyOf[subschema #1: ExclusionReason]/ of the query request parameter reason