Getting Started

Sections

Theme switcher

Contacts Search

Header Parameters

api-keystring Required

Body Parameters

domainarray

Company domain(s) to include in results

Nullable:
True

Show child attributes

domain_notarray

Company domain(s) to exclude from results

Nullable:
True

Show child attributes

domain_containsstring

Partial domain match filter

Nullable:
True
company_namearray

Exact company name(s) to include in results

Nullable:
True

Show child attributes

company_name_notarray

Company name(s) to exclude from results

Nullable:
True

Show child attributes

company_name_containsstring

Partial company name match filter

Nullable:
True
company_hq_countryarray

Company headquarters country/countries (two-letter country codes)

Nullable:
True

Show child attributes

company_hq_country_notarray

Company headquarters country/countries to exclude

Nullable:
True

Show child attributes

job_titlearray

Exact job title(s) to include in results

Nullable:
True

Show child attributes

job_title_notarray

Job title(s) to exclude from results

Nullable:
True

Show child attributes

job_title_containsstring

Partial job title match filter

Nullable:
True
seniorityarray

Seniority level(s)

Nullable:
True

Show child attributes

seniority_notarray

Seniority level(s) to exclude

Nullable:
True

Show child attributes

departmentarray

Department(s)

Nullable:
True

Show child attributes

department_notarray

Department(s) to exclude

Nullable:
True

Show child attributes

countryarray

Contact country/countries (two-letter country codes)

Nullable:
True

Show child attributes

country_notarray

Contact country/countries to exclude from results

Nullable:
True

Show child attributes

has_emailboolean

Filter by email availability

Nullable:
True
has_office_phoneboolean

Filter by office/direct phone availability

Nullable:
True
has_mobile_phoneboolean

Filter by mobile phone availability

Nullable:
True
output_fieldsarray

Contacts fields returned in result

Nullable:
True

Show child attributes

limitinteger

Maximum number of results

offsetinteger

Pagination offset

ascboolean

Sort order direction

Nullable:
True
sortstring

Field to sort by

Nullable:
True
contacts_per_companyinteger

Limit numer of contacts per company in result

Nullable:
True
formatstring

Format in which the reply should be returned

Enum values:
jsonxml
granularitystring

Time granularity for the returned values

Enum values:
daily
start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format

Nullable:
True
end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format

Nullable:
True

Response

200
Object
Success

Response Attributes

metaobject

Show child attributes

dataarray
Nullable:
True

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

POST

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in Claude

Code with AI