Skip to content
Arcane CRMArcane CRMHelp

Atlas

Answers from this help and cites its sources. 20 questions a day.

API keys

The external API lets your other tools (website, form, ERP, automation tool…) read and write CRM records. Each key belongs to the organization: it acts on behalf of an organization service account, which doesn’t use a seat, and only on the objects you open to it.

Depending on your plan Settings › Integrations › API keys The Owner and Admins
1234
  1. 1New key
  2. 2API address
  3. 3A key and its objects
  4. 4Revoke
Hover a number to locate the area. Click the screenshot to enlarge it.
The API keys page: the New key button, the API address, and a website sync key, active, with its allowed objects, creation date, last use and the Revoke button.

Create a key

Section titled “Create a key”
The New API key window: the name, the expiration, the objects allowed for read or write, and the Run workflows box.
  1. Click New key and give it a name that says which tool uses it.
  2. Choose the expiration: 30 days, 90 days, 1 year or no expiration.
  3. Under Allowed objects, tick Read or Write for each object. Write includes read and lets the key create, edit, archive and restore records. All objects also covers objects created later.
  4. Tick Run workflows if the tool must trigger your active workflows that start with an “API call” (see Triggers). This box is never included in “All objects”.
  5. Click Create key, copy it, then click I copied the key.

An organization has at most 25 active keys.

Use the API

Section titled “Use the API”

The API address is shown at the top of the page. Each request sends the key in the Authorization: Bearer <key> header. The API lets you list objects and their fields, search, read, create, edit, archive and restore records, and create or update up to 100 records in one request by matching them on a field (an e-mail, for example).

For example, to create a contact:

Fenêtre de terminal
curl -X POST https://api.arcane-crm.com/v1/records/crm_contacts \
  -H "Authorization: Bearer crm_sk_…" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Jeanne","last_name":"Roux","email":"[email protected]"}'

The API answers 201 with the created record in data.

  • Records created without an owner get the service account as owner.
  • Every change is written to the audit log with the key’s name.
  • Requests per minute per key depend on your plan. Beyond that, the API asks you to wait.
  • A key outlives the departure of the person who created it.

Revoke a key

Section titled “Revoke a key”

Revoke refuses the key from the next request on, for good: the tools that use it stop working. The key stays listed as Revoked; a key past its date shows as Expired.