The Content Snare API lets your own software work with requests, clients, team members and templates instead of doing everything by hand in the app. First we switch access on for your account. Then your software connects in one of two ways:
- An application. An Administrator creates one to get OAuth credentials. The steps are below.
- A personal access token. Use one for a private MCP server, script or automated workflow, for example to connect Claude. It acts as the person who generated it. An Administrator can generate one, and so can an Editor if an Administrator allows it. The steps are in Personal access tokens.
What you can do with the API
The API covers clients, team members, folders, request templates, communication templates, and requests down to their pages and sections. It also manages webhooks.
A few things fall outside it. It does not export a request, post comments, send emails or SMS, add or delete fields (you can review answers, not change the fields), manage integrations, sign documents, or access billing and company settings. For any of those, use a webhook or a Zapier automation instead.
One thing is only possible through the API: publishing a request in one call, without building it in the app first, then checking its build status until the request is ready. There is no button for that. If you are building that call, API: create a request with fields walks through the fields.
The API can also share a request template, which you can do in the app too. See how to share templates between two Content Snare accounts.
Turn on API access
API access is switched off until you ask us to turn it on.
- Click your avatar in the top right.
- Choose Settings, then Integrations, then API.
- Use the button that asks for access.
It starts a chat with our team, and we switch it on for your account.
Create an application
With access on, create an application to get the credentials your software signs in with. Do this while you are signed in as an Administrator, because only an Administrator can create an application and finish the OAuth sign-in. Content Snare refuses the sign-in from anyone in another role. If the Administrator who authorized an application later changes role or is archived, its token stops working.
The Create A New Application button stays disabled until both your company email address and the account owner's email address are confirmed, so confirm them first if you have not. Give the application a name and the redirect URL where your app handles the OAuth response, and an optional description. Then choose its scopes. An account can have up to five applications at once, so if you hit that limit, delete one you no longer use.
Save your secret key
Tick I have recorded the secret key to confirm you have saved it.
Choose the smallest scopes
Scopes decide what a token is allowed to do, so give each application only the ones its job needs.
- Read clients and Manage clients
- Read team members and Manage team members
- Read requests, Manage requests and supported templates and Review request answers
- Read templates
- Manage webhooks
A Manage scope doesn't include the matching Read scope. If your software reads clients and also changes them, give it both Read clients and Manage clients. Add Manage webhooks only if your software lists or manages webhooks over the API.
When you generate a personal access token, you pick from the same nine under Permissions. An Editor can't give a token Manage team members or Manage webhooks.
How authentication works
An application authenticates with OAuth 2.0. The API uses the authorization-code grant and issues a refresh token alongside every access token. Each access token expires after a set time. The token response gives that time in expires_in, so read it from there instead of hard-coding it. When an access token expires, exchange the refresh token for a new one instead of sending the user through sign-in again. The authorization and token endpoints are /oauth/authorization and /oauth/token.
A personal access token skips the OAuth sign-in. Your tool sends it as a Bearer token in the Authorization header of every call. It stops working on a fixed expiry date.
Rate limits
Every API response carries three rate-limit headers, X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. They appear on every response, not only after you have been throttled, so you can pace your calls without counting them yourself.
Reads and writes are counted separately, per access token or per IP address:
| What you are doing | How many | Over what |
|---|---|---|
| Reading | 50 requests | 10 seconds |
| Writing | 20 requests | 10 seconds |
Scroll sideways to see the whole table
On top of those, each IP address is limited to 600 requests a minute, whichever token the requests use. Your organization also has a limit of 3,000 requests a minute, shared by all its applications and personal access tokens.
Exceed a limit and you get an HTTP 429 response, with a Retry-After header telling you how long to hold off. A 429 can also come from brief server contention. That is not a throttle, and it clears on its own quickly.
API versions
The API has a single version, v1, and it is in the URL path. A new version would get its own path, so your existing calls keep working unchanged. If you are sending a parameter name we have deprecated, the response carries Deprecation, Sunset and Link headers showing the date that name stops working and where to read about it. The old names keep working until then.
The full API reference
The complete reference, with every endpoint and its fields, is the API documentation. It is public, so you can read it before access is switched on, and there is a link to it on the API settings screen.