Skip to main content

Prerequisites

  • API access enabled: This is not self-serve. Contact your Recotap account manager to have it enabled for your workspace.
  • Your API key: Generate it from Settings → Workspace → Tech Settings → API Access Key. See Authentication if you haven’t done this yet.

Step 1: Verify your key

Fetch your accounts to confirm authentication is working:
A successful response returns the full response envelope:
All API responses share this envelope: statusCode, timestamp, path, and data. Subsequent steps in this guide show only the data field for brevity. See Introduction for the full structure.
If you receive 401 Unauthorized, check that the X-Api-Key header value is correct and that API access has been enabled for your workspace.

Step 2: Push your first account

domain is required and used for deduplication — if an account with the same domain already exists, the item is returned as failed. Once created, store the rtp_aid returned in the response to update the account via PUT /accounts/:rtp_aid.
data field of the response:
Store the rtp_aid from the response — you will need it to update this account via PUT /accounts/:rtp_aid.

Step 3: Pull accounts with Recotap scores

Pull accounts back with enriched rtp_ score fields:
All rtp_ score fields default to 0 on a newly pushed account. Scores are updated on a schedule — not in real-time.
data field of the response (showing one account):
Map these rtp_ fields back into your system records:

Step 4: Set up delta sync

On subsequent syncs, combine lastSync (a filter) with limit and cursor (pagination) to fetch only changed records efficiently:
Store the syncTimestamp from each completed response and pass it as lastSync on the next run. Only records updated after that point are returned.

What’s next

Accounts

Full account push, update, and pull reference

Deals

Push deals with stage history for revenue attribution

Sales Activities

Push call and email activities with contact data

Custom Fields

View and define custom field schemas for accounts

Segments

Pull Recotap segment memberships into your system

Errors

Complete error reference and handling guide