Skip to main content
GET
Search contacts

Authorizations

Authorization
string
header
required

Send the full Business API key from Settings -> API Keys, for example Authorization: Bearer sk_your_api_key.

Query Parameters

company_name
string
required

Required company-name search term that scopes the contact search. Length: 1–200 characters.

Required string length: 1 - 200
role
string

Optional job-role or title term used to narrow people within the company. Blank values are ignored.

Maximum string length: 200
person_name
string

Optional person-name term used to narrow people within the company. Blank values are ignored.

Maximum string length: 200
page
integer
default:1

One-based page number. Use 1 for the first page and increment it while hasMore is true.

Required range: x >= 1
pageSize
integer
default:20

Maximum number of records requested per page. The shared default is 20 and the shared upper limit is 100; individual endpoints can document a lower maximum.

Required range: 1 <= x <= 100

Response

Paginated matching contacts. A valid search with no matches returns the same envelope with an empty items array and zero totals.

Standard paginated collection of contact records.

items
object[]
required

Contact records returned on the current page.

total
integer
required

Total matching contacts across all pages.

Example:

1

page
integer
required

One-based page number returned.

Example:

1

pageSize
integer
required

Requested maximum number of contacts per page.

Example:

20

totalPages
integer
required

Total number of pages for the current search.

Example:

1

hasMore
boolean
required

Whether another page is available after the current page.

Example:

false