Skip to content

List Contacts

GET
/contacts

List contacts with optional filtering and pagination.

Authorizations

Parameters

Query Parameters

page

Page number (1-indexed)

integer
default: 1 >= 1

Page number (1-indexed)

limit

Items per page (max 200)

integer
default: 50 >= 1 <= 200

Items per page (max 200)

email
Any of:
string

Filter by work email (exact match)

list_id
Any of:
integer

Filter by list ID

name
Any of:
string

Filter by first or last name (partial match)

job_title
Any of:
string

Filter by job title (partial match)

seniority_level
Any of:
string

Filter by seniority level (exact match)

company_name
Any of:
string

Filter by company name (partial match)

company_id
Any of:
integer

Filter by company ID

country
Any of:
string

Filter by country (exact match)

state
Any of:
string

Filter by state (exact match)

city
Any of:
string

Filter by city (partial match)

job_department
Any of:
string

Filter by job department (partial match)

industry
Any of:
string

Filter by company industry (partial match)

include_custom_fields

When true, each contact includes a custom_fields object of custom column values keyed by column slug. Default false keeps the legacy response shape and adds no extra query.

boolean

When true, each contact includes a custom_fields object of custom column values keyed by column slug. Default false keeps the legacy response shape and adds no extra query.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
Array<object>

Lighter contact representation for list endpoints.

object
city
Any of:
string
company_id
Any of:
integer
country
Any of:
string
custom_fields
Any of:
object
key
additional properties
Any of:
string
direct_phone
Any of:
string
first_name
Any of:
string
id
Any of:
integer
job_department
Any of:
string
job_title
Any of:
string
last_name
Any of:
string
linkedin_url
Any of:
string
mobile_phone
Any of:
string
owner_id
Any of:
string
owner_name
Any of:
string
seniority_level
Any of:
string
state
Any of:
string
work_email
Any of:
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string