contacts

List Contacts

Changed on

List contacts attached to the authenticated organization.

Requires the contacts:read scope on the API key.

get/v1/contacts

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/contacts
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number.

sizeinteger

Number of items per page.

sort_by'first_seen_at' | 'last_seen_at' | 'email'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

emailstring nullable

Filter by email (case-insensitive exact match).

linkedin_urlstring nullable

Filter by LinkedIn profile URL. Matched against all known canonical variants (trailing slash, www. prefix, etc.).

contact_idstring uuid nullable

Filter by contact ID.

company_domainstring nullable

Filter by the contact's linked account domain.

first_seen_afterstring date-time nullable

Return contacts first seen strictly after this timestamp.

last_seen_afterstring date-time nullable

Return contacts last seen 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