API Reference
Technical documentation for integrating Cumino into your systems. REST API with OAuth2 authentication and real-time webhooks.
Base URL
Endpoint Categories
Authentication
- OAuth2 flow
- API Keys
- JWT tokens
- Scopes and permissions
Candidates
- GET /candidates
- POST /candidates
- PUT /candidates/:id
- DELETE /candidates/:id
Campaigns
- GET /campaigns
- POST /campaigns
- GET /campaigns/:id/leads
- PUT /campaigns/:id/status
Rate Limiting
- 1000 req/min (standard)
- 5000 req/min (enterprise)
- Response headers
- Retry-After support
Quick Start
Get API Key
Register your application in the Cumino dashboard and generate API credentials.
Authentication
Use your credentials to obtain a JWT token via the /auth/token endpoint.
First call
Test the connection with GET /health and start using the endpoints.
Configure Webhooks
Register your endpoints to receive real-time notifications about events.
Webhook Events
candidate.createdNew candidate registered
candidate.prescreenedCandidate has completed pre-screening
candidate.qualifiedCandidate qualified by recruiter
meeting.scheduledInterview scheduled
meeting.completedInterview completed
Code Example
// Example: Get candidate list
const response = await fetch('https://api.cumino.com/v1/candidates', {
headers: {
'Authorization': 'Bearer YOUR_JWT_TOKEN',
'Content-Type': 'application/json'
}
});
const { data: candidates } = await response.json();
console.log(candidates);Full Documentation
The complete API documentation with interactive examples will be available at the official Cumino launch. In the meantime, contact support for early access to the sandbox.
Need support?
Our technical team can help you with the integration.