Structure
Our API is designed to be as simple to use as possible. We always use the same basic structure:
datacontains the data you requested.metaprovides information regarding your request.errorsshows 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.
idis a stable error identifier (for exampleinvalid_input).codeis the HTTP status code for the failure (for example400).detailsexplains what went wrong and how to fix the request.
Contacts
Returns contacts filtered by contact and company attributes.
Request Fields
| Field | Type | Description |
|---|---|---|
job_titles | array[string] | Case-insensitive partial contact job title matches (for example manager matches Finance Manager). |
departments | array[string] | Exact contact department matches. |
seniorities | array[string] | Exact contact seniority matches. |
has_personal_emails | boolean | When true, only contacts with a personal email are returned. |
has_linkedin_profile | boolean | When true, only contacts with a LinkedIn profile are returned. |
is_decision_maker | boolean | When true, only contacts marked as decision makers are returned. |
added_after | string (UTC ISO8601) | Only contacts whose company was created at or after this timestamp. |
added_before | string (UTC ISO8601) | Only contacts whose company was created at or before this timestamp. |
locations |
array[string] |
Company location filter. Examples:
|
functions | array[string] | Company function filter. |
industries | array[string] | Company industry filter. |
tlds | array[string] | Company top-level domain filter. |
technologies | array[string] | Company technology overlap filter. |
page | integer | Page number, default 1. |
per_page | integer | Page size, default 25, max 100. |
Companies
Returns companies filtered by company attributes and creation timestamp.
Request Fields
| Field | Type | Description |
|---|---|---|
added_after | string (UTC ISO8601) | Only companies created at or after this timestamp. |
added_before | string (UTC ISO8601) | Only companies created at or before this timestamp. |
locations |
array[string] |
Company location filter. Examples:
|
functions | array[string] | Company function filter. |
industries | array[string] | Company industry filter. |
tlds | array[string] | Company top-level domain filter. |
technologies | array[string] | Company technology overlap filter. |
page | integer | Page number, default 1. |
per_page | integer | Page size, default 25, max 100. |