What this API provides
Push data into Recotap
Push accounts, deals, sales activities, and custom field definitions so Recotap can score and segment them.
Pull enriched data out
Pull accounts back with Recotap scores, intent signals, journey stages, and segment memberships to enrich your records.
Authentication
All requests require an API key passed in theX-Api-Key header. See the Authentication page for how to generate your key and use it correctly.
Base URL
All External API endpoints are under:v1. Breaking changes will be introduced under a new version path (e.g. /v2/). Existing v1 endpoints will not be modified in a breaking way.
Request format
POST, PUT, and PATCH requests must include:X-Api-Key header. No multipart or other content types are used anywhere in this API.
Response envelope
All responses — success and error — share a consistent top-level structure:data: null and two additional fields:
Pagination
All GET list endpoints supportlimit and cursor query parameters. Most endpoints default to limit=100. Pagination is keyset-based — the cursor value is taken directly from nextCursor in the previous response. Pass nextCursor as cursor on the next request to fetch the next page.
| Parameter | Type | Description |
|---|---|---|
limit | integer | Number of records to return. Defaults to 100. |
cursor | string | Keyset cursor from nextCursor in the previous response. Omit for the first page. |
Delta sync
Every GET list endpoint also supportslastSync, an ISO 8601 timestamp. Pass your last sync time and Recotap returns only records updated after that point. This is a filter, not a pagination control. Use it alongside limit and cursor for large syncs.
lastSync on the next run.
Bulk limits
| Resource | Max records per request |
|---|---|
| Accounts (POST) | 100 |
| Deals (POST) | 100 |
| Sales Activities (POST) | 50 |
| External ID mappings (PATCH) | 100 |