Appearance
API Access
Who is this for? HR managers and team leads evaluating integrations, and the technical contacts who will set them up.
The Tailed API lets you connect Tailed to your existing tools — no manual data exports needed.
What is the API?
The Tailed API is a way for other software to talk to Tailed automatically. Instead of a person logging in and clicking around, another application (like your ATS, your internal tools, or a custom report) can request data or perform actions on your behalf.
Think of it like a private door into Tailed that only your authorized tools can open.
Common use cases:
- Pull candidate and application data into your internal reporting system
- Sync Tailed with your ATS (keep status in sync without manual updates)
- Trigger Tailed actions from external events (e.g. automatically move a candidate when an interview is booked)
- Build a custom integration with a tool Tailed doesn't natively support yet
Who can use the API?
API access is available on the Professional and Enterprise plans. If you're on the Starter or Trial plan, you'll see an upgrade prompt when trying to generate an API key.
Technical setup is typically done by a developer or IT administrator, but you (the HR manager or Owner) control who gets access and what permissions they have.
Generating an API key
An API key is a long secret code that identifies your organization when another tool connects to Tailed.
- Go to Settings → API Access.
- Click Generate new API key.
- Give it a descriptive name (e.g. Jira Integration or Internal BI Tool).
- Copy the key immediately — Tailed will never show it again after this screen for security reasons.
- Store it securely (e.g. in your company's password manager or secrets vault).
⚠️ Keep your API key private. Anyone with this key can access your organization's data. Do not paste it into emails, Slack messages, or code repositories.
Permissions and scopes
Each API key can be restricted to specific actions:
| Scope | What it allows |
|---|---|
| Candidates — Read | View candidate profiles and search the database |
| Candidates — Write | Create and update candidate records |
| Applications — Read | View applications and their current stage |
| Applications — Write | Update application status and advance pipeline stages |
| Jobs — Read | View job postings |
| Analytics — Read | Pull analytics snapshots and reports |
Assign only the scopes your integration actually needs. For example, a read-only reporting tool should only have Read scopes.
Revoking an API key
If a key is compromised, or if an integration is no longer needed:
- Go to Settings → API Access.
- Find the key and click Revoke.
- The key is immediately disabled — any tool using it will lose access.
Rate limits
To keep Tailed fast and fair for everyone, the API limits how many requests can be sent per minute. If an integration hits the limit, it will receive an error and should wait before retrying.
| Plan | Requests per minute |
|---|---|
| Professional | 100 |
| Enterprise | 500 (custom limits available) |
Your technical team can monitor API usage in Settings → API Access → Usage logs.
Available integrations (no coding required)
If you don't have a developer available, check whether your tool already has a built-in Tailed integration:
- Jira — sync application stages with Jira issue statuses
- More coming soon — we're actively expanding the integration library
To set up a pre-built integration, go to Settings → Integrations and follow the on-screen guide for your tool.
Getting technical help
For developers setting up the API, the full reference documentation (endpoints, request/response formats, and code examples) is available at:
📖 docs.tailed.ca/api-reference
The base URL for all API calls is:
https://api.tailed.caFrequently asked questions
Does Tailed have a sandbox or test environment?
Yes. A staging environment is available for testing integrations before going live. Contact support@tailed.ca to get staging credentials.
Can I have multiple API keys?
Yes. You can create a separate key for each integration. This makes it easy to revoke access for just one tool without affecting others.
Can I see what actions were performed via the API?
Yes. Go to Settings → API Access → Activity log to see a timestamped record of all API actions.
Last updated: March 2026