Introduction

You can integrate our service's data with our simple JSON API:

  • Contacts returns emails and profiles matching input criteria.
  • Companies returns companies matching input criteria.

Structure

Our API is designed to be as simple to use as possible. We always use the same basic structure:

  • data contains the data you requested.
  • meta provides information regarding your request.
  • errors shows errors with insights regarding what made the request fail.

Authentication

Every request to our API requires authentication with a key. Include the key via the Authorization header in your request:

  • Header format: Authorization: Bearer YOUR_API_KEY.
  • Missing/invalid key returns 401 Unauthorized.
  • Tokens are managed in user settings under API tokens.

Errors

When a request fails, the API returns an errors array. Each item includes an identifier, HTTP code, and a human-readable description.

  • id is a stable error identifier (for example invalid_input).
  • code is the HTTP status code for the failure (for example 400).
  • details explains what went wrong and how to fix the request.

Contacts

Returns contacts filtered by contact and company attributes.

Request Fields

Field Type Description
job_titlesarray[string]Case-insensitive partial contact job title matches (for example manager matches Finance Manager).
departmentsarray[string]Exact contact department matches.
senioritiesarray[string]Exact contact seniority matches.
has_personal_emailsbooleanWhen true, only contacts with a personal email are returned.
has_linkedin_profilebooleanWhen true, only contacts with a LinkedIn profile are returned.
is_decision_makerbooleanWhen true, only contacts marked as decision makers are returned.
added_afterstring (UTC ISO8601)Only contacts whose company was created at or after this timestamp.
added_beforestring (UTC ISO8601)Only contacts whose company was created at or before this timestamp.
locations array[string] Company location filter. Examples:
  • city:San Francisco||California||United States
  • state:California||United States
  • city:London||||United Kingdom
  • country:Brazil
functionsarray[string]Company function filter.
industriesarray[string]Company industry filter.
tldsarray[string]Company top-level domain filter.
technologiesarray[string]Company technology overlap filter.
pageintegerPage number, default 1.
per_pageintegerPage size, default 25, max 100.

Companies

Returns companies filtered by company attributes and creation timestamp.

Request Fields

Field Type Description
added_afterstring (UTC ISO8601)Only companies created at or after this timestamp.
added_beforestring (UTC ISO8601)Only companies created at or before this timestamp.
locations array[string] Company location filter. Examples:
  • city:San Francisco||California||United States
  • state:California||United States
  • city:London||||United Kingdom
  • country:Brazil
functionsarray[string]Company function filter.
industriesarray[string]Company industry filter.
tldsarray[string]Company top-level domain filter.
technologiesarray[string]Company technology overlap filter.
pageintegerPage number, default 1.
per_pageintegerPage size, default 25, max 100.