Skip to content

Quickstart

Quickstart: REST API

Markdown version

You need: an API key in RA_API_KEY and any HTTP client.

  1. Get a key. Sign up at https://app.closefinch.com/sign-up (the Free plan, no card). An owner creates a key in Settings → API keys and picks its scopes: crm:read to read, plus crm:write and agents:write to make changes. Keep it in an environment variable, never in a file you commit:

    export RA_API_KEY=ra_live_…
  2. Call it (no key yet? ra sandbox create --host https://api.closefinch.com makes a sandbox and saves its key):

    curl -s https://api.closefinch.com/v1/me -H "Authorization: Bearer $RA_API_KEY"
    curl -s "https://api.closefinch.com/v1/deals?q=Acme&limit=10" -H "Authorization: Bearer $RA_API_KEY"
    curl -s https://api.closefinch.com/v1/tasks -H "Authorization: Bearer $RA_API_KEY" -H "content-type: application/json" \
      -d '{"values":{"title":"Send the pricing sheet"}}'
  3. Check it. /v1/me answers with your organization and scopes. The spec for every route is at https://www.closefinch.com/openapi.json, and the reference lists them by resource.

Errors are { "error": { "code", "message", "details" } }; see limits and errors.

Send feedback

Tell us what's broken, confusing or missing on this page, or an idea. It goes to the team that builds the product.

Please don't include passwords or card numbers.
Only to reply about this. Never added to any mailing list.