Skip to content

Zapier HTTP API

Base: https://platform.yareta.ai/api/zapier
Auth: x-api-key: <zapier key>

See Zapier for operators for when to use this versus native CRM connectors.

GET /me

Returns { "user": "<email>", "orgName": "<organisation>" } when the key is valid.

GET /profiles

Lists investment / success profiles you may submit into. Use a profile id on POST /submissions.

POST /submissions

Queues a new person/deal. Required JSON: record_id, profile_id, fields. Optional filters, source.

Success: { "status": "queued", "job_id": "job_…" }.

GET /submissions lists submissions your key can see (pagination as implemented on your tenant).

/resources and /transcripts

Attach files or transcript payloads to a submission after it exists. Follow the in-app Zapier templates or ask support for the current field map for your org (column names vary by mapping).

/webhooks

Register a URL Zapier (or your HTTPS endpoint) should receive when Yareta emits supported events. DELETE removes the subscription.

Errors

  • 401 — missing/invalid key
  • 400 — missing record_id / profile_id / fields

Zapier keys cannot call /api/v1 assessment endpoints.