Get started

Public API

Read and write people, companies, leads, opportunities, tasks and notes.

The REST API reads and writes the workspace's people, companies, leads, opportunities, custom objects, tasks and notes. It is included on Pro and Enterprise.

#Create a key

  1. Open Settings → API. Only owners and admins manage keys.
  2. Create a key and choose its scopes, such as reading or writing people.
  3. Copy it straight away. Keys start with sk_live_, and the full key is shown only once; we keep a hash, not the key.

#Your first request

Send the key as a bearer token. This lists people, most recently updated first.

bash
curl https://synconone.com/api/v1/people \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

Every response has a data field: one item, or a list. A missing or wrong key returns 401.

#Pages, writes and limits

  • Lists take limit (up to 100) and cursor. Pass the previous page's pagination.nextCursor to get the next one.
  • Creates accept an Idempotency-Key header, so a retried request does not create a second record.
  • DELETE archives a record; it can be restored in the app.
  • Each key has a per-minute request limit. Past it the API answers 429 with when to retry.
bash
curl -X POST https://synconone.com/api/v1/people \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 6f1c2b0e-signup-form" \
  -d '{"first_name": "Priya", "last_name": "Nandakumar", "email": "[email protected]"}'

#Reference

The full reference, with every endpoint, field and filter, is an OpenAPI document at /api/v1/openapi.json. The workspace also shows it in Settings → API.