---
url: /api.md
---

# Recruitly Nova API

Recruitly is a recruitment CRM platform built for recruiting agencies. The Nova API gives you programmatic access to your entire recruitment workflow — candidates, jobs, companies, contacts, leads, opportunities, pipelines, placements, and more.

## Base URL

```
https://api.recruitly.io/api/nova
```

All endpoints are relative to this base URL.

## Quick Start

1. [Get your API key](/api/authentication) from your Recruitly account
2. Pass the key as a `?apiKey=` query parameter with every request
3. Explore the [interactive API reference](/api/reference) to try endpoints directly

## Response Format

**Record**

```json
{ "success": true, "data": { ... } }
```

**List**

```json
{ "success": true, "data": [...], "page": 0, "size": 20, "total": 142 }
```

**Save**

```json
{ "success": true, "id": "record-id" }
```

**Error**

```json
{ "error": true, "code": "NOT_FOUND", "message": "..." }
```

## Pagination

| Parameter | Default | Description |
|-----------|---------|-------------|
| `page` | `0` | Zero-based page number |
| `size` | `20` | Results per page (max 100) |

## Error Codes

| Code | Status | Description |
|------|--------|-------------|
| `UNAUTHORIZED` | 401 | Invalid or missing API key |
| `NOT_FOUND` | 404 | Record not found |
| `BAD_REQUEST` | 400 | Invalid request |
| `RATE_LIMITED` | 429 | Rate limit exceeded |
| `INTERNAL_ERROR` | 500 | Server error |
