REST API
Build on Your CRM. With Keys You Control.A CRM REST API with keys that never reach further than your team’s own permissions.
Read and write your CRM records from your own apps and scripts. Each API key carries a role and a permission profile, the same as a person on your team, so it can never reach further than they could. Keys are shown once, rotated when needed, and every change is on the record.
- One versioned path
- Role-scoped keys
- Every key change audited
How it works
- Create a keyNamed, shown once, stored hashed
- It gets a roleThe same reach a person would have
- Your app calls the APIReads and writes records on one versioned path
- Key changes loggedCreated, rotated, revoked: who and when
Integrations You Can Trust and Account For.
Everything sits on one versioned path, so code written against it keeps working while the product changes behind it.
Each key carries a role and a permission profile, checked the same way as for a signed-in person.
A key is shown once and stored hashed. Lose it, and you rotate it rather than recover it.
Creating, rotating and revoking a key are each logged with who did it and when.
Start Building in Three Steps.
Create a Key
Name it on the API keys screen and copy the value. It is shown only once.
Call the API
Send the key with each request to the versioned path. Lists come back 50 rows at a time, up to 100.
Rotate When Needed
Replace a key whenever you need to. Every create, rotate and revoke is logged.
Two Ways to Connect, One for Each Direction.
Your app asks Adoptiv for records, or writes to them, with a key held to a role and permission profile.
What Is a CRM REST API, and How Are Keys Kept Safe?
A CRM REST API lets your own apps and scripts read and write CRM records over the web. Adoptiv’s API sits on one versioned path, so code written against it keeps working while the product changes behind it.
Access is by CRM API key. You create one on the keys screen with a name, and the value is shown once, then stored hashed. API key permissions follow the same chain a signed-in person does: the key belongs to a workspace, then a role, then a permission profile. So a key can never reach further than a person with that profile would.
To rotate an API key, replace it: keys are rotated, not recovered. Creating, rotating and revoking each leave an audit entry with who did it and when, so a key that stops working always has a record saying why.
API pagination returns 50 rows by default and up to 100, by page or by offset. API rate limits are counted per key over a rolling minute, and a refused request tells you how long to wait. As for REST API vs webhooks: use the API to read and update records, and inbound webhooks, on the same versioned API path, when another tool should push events in. Inside the CRM, workflow actions can call out to your systems.
An API Built to Stay in Line.
One version in the path, so your integration keeps working.
Named at creation, shown once and stored hashed.
Created, rotated and revoked, with who and when.
Counted per key per rolling minute, with the wait time returned.
50 rows by default, 100 at most, by page or by offset.
For Teams That Connect the CRM to Everything Else.
Scoped API Keys vs One Master Key.
| What | A single all-access key | With Adoptiv |
|---|---|---|
| What a key can reach | A single all-access key: Everything in the account | With Adoptiv: Only what its role and profile allow |
| Seeing the key again | A single all-access key: Shown in settings any time | With Adoptiv: Shown once, then stored hashed |
| A leaked key | A single all-access key: Hard to tell who changed what | With Adoptiv: Rotate it; the change is logged with who and when |
| Product updates | A single all-access key: Can break your integration | With Adoptiv: One versioned path keeps your code working |
| Too many requests | A single all-access key: Refused with no guidance | With Adoptiv: Told how long to wait before retrying |
REST API Questions, Answered.
Does Adoptiv have a REST API?
Yes. Your apps and scripts can read and write CRM records with an API key, on a single versioned path.
How do I get an API key?
Create one on the API keys screen and give it a name. The key is shown once, so copy it somewhere safe.
What can an API key access?
Only what its role and permission profile allow inside your workspace, the same as a person on your team with that profile.
What are the API rate limits?
Requests are counted per key over a rolling minute. If you go over, the response tells you in a header how long to wait.
What if a key is lost or leaked?
Rotate it. Keys are stored hashed and can’t be recovered, so a new key replaces the old one, and the change is logged.
Is the API versioned?
Yes. Everything sits under one version in the path, so a client written against it keeps working while the product changes.
How does pagination work?
50 rows per page by default, up to 100. Ask for a page number or an offset.
Can I see an API key again after creating it?
No. It is shown once and stored hashed. If you lose it, rotate it.
Should I use the API or webhooks?
Use the API when your app needs to read or update records. Use inbound webhooks when another tool should send events to Adoptiv as they happen.
Still have a question? A real person replies in under 60 seconds in US business hours. Talk to our team →
14-day free trial
Connect Adoptiv to the Rest of Your Stack.
Create an API key in the free trial. Free for 14 days, no credit card.
14-day trial · no card · migration included