Skip to content

Authentication

All API requests require authentication via an API key. Each key is tied to a specific user and tenant — all actions are performed in the context of that user's permissions.

Obtaining an API Key

  1. Log in to your Recruitly account
  2. Navigate to My Profile → API Keys
  3. Click "Generate New Key"
  4. Copy the key immediately — it is only shown once

API Key Generation

WARNING

Keep your API keys private. Do not share them publicly or commit them to source control. If a key is compromised, disable it immediately and generate a new one.

Usage

Pass your API key as a query parameter with every request:

GET https://api.recruitly.io/api/nova/candidates/search?apiKey=YOUR_API_KEY

Error Responses

StatusMeaning
401 UnauthorizedAPI key is missing, invalid, or disabled
403 ForbiddenAPI key does not have permission for this action
404 Not FoundThe requested record does not exist
429 Too Many RequestsRate limit or usage limit exceeded

Recruitly — Recruitment CRM for Agencies