Getting started

What you can do

The API enables you to programmatically manage:

• Applications — create, update, and track candidate applications
• Candidates — add profiles, update details, enrich records
• Vacancies — publish and maintain open roles
• Clients — manage client organizations and contacts
• Leads — capture and progress sales/recruitment leads

See the References tab for complete endpoint details, parameters, and schemas.

---

Base URL

https://api.jaicob.ai

---

Authentication

All requests must include a valid API key.

• Header: x-api-key: <YOUR_API_KEY>
• Find your key: https://app.jaicob.ai/settings/integration/api-keys

Keep keys secret

Never embed long-lived keys in client-side code or mobile apps. Rotate keys regularly.

---

Common rules

• JSON only
  • Send Content-Type: application/json
  • Expect JSON responses
• Permissions & scopes
  • Keys can be scoped (e.g., read vs. write). Use least privilege.
• Errors
  • Standard HTTP statuses (4xx client errors, 5xx server errors)
  • On 429 Too Many Requests, respect Retry-After if present
• Pagination & filtering
  • Supported on list endpoints. See References for parameters and response shape.
• Idempotency & duplicates
  • De-duplicate on your side when running background jobs/queues to avoid duplicates.
• Timestamps
  • Dates/times are ISO-8601 in UTC unless stated otherwise.
• CORS & browser calls
  • Server-to-server is recommended. If calling from the browser, your origin must be allowed and you must supply a valid API key.
• Rate limits
  • The API enforces rate limits. Implement backoff and jitter in your client.

---

Next steps

• Retrieve your API key and make an authenticated request.
• Explore the References tab for resource-specific operations.