# Lovelio API reference

Recruitment automation API. Create jobs, manage candidates, run ad-hoc actions, integrate with your tools.

Generated from the OpenAPI 3.1 document at https://lovelio.ai/api/v1/openapi.json.
API version 7.2.0. 157 paths, 234 operations.

This is the plain-markdown copy of the reference rendered at https://lovelio.ai/docs/api.

## Fetch less than all of this

| URL | What you get |
| --- | --- |
| `https://lovelio.ai/docs/api.md` | Everything: this header plus every operation in full. |
| `https://lovelio.ai/docs/api.md?index=1` | This header plus the endpoint index. No per-operation detail. |
| `https://lovelio.ai/docs/api.md?tag=Jobs` | This header plus one section in full. Comma-separate for several: `?tag=Jobs,Applications`. |
| `https://lovelio.ai/api/v1/openapi.json` | The machine-readable source this file is generated from. |

Tags: System, Accounts, Jobs, Job Ads, Candidates, Candidate Imports, Applications, Interviews, Submissions, Placements, Quotas, Marketplace, Webhooks, Batch, Activities, Documents, Tasks, Outreach, Talent Pools, Review Queue, Forms, Referees, Integrations, Chat Integrations, Analytics, Calendar, Scheduled Emails, Workflow Rules, Email Templates, Stages, Distribution, Clients, Specs, Search, Business Development.

## Base URL

Docs live on lovelio.ai. The API does not. Every workspace belongs to a region and an API key only works on its own region's host. Calling `lovelio.ai/api/v1/...` returns a JSON error naming all three hosts rather than data.

| Region | Base URL |
| --- | --- |
| Production (US (N. California)) | `https://us.lovelio.ai/api/v1` |
| Production (EU (London)) | `https://eu.lovelio.ai/api/v1` |
| Production (ANZ (Sydney)) | `https://anz.lovelio.ai/api/v1` |

A workspace's exact host is shown in Settings > API keys.

## Authentication

```http
Authorization: Bearer sk_live_...
```

API key, sent as Authorization: Bearer <key>. Three key types: sk_live_ (production), sk_test_ (development - same workspace, same data, marked as a test key; use a separate workspace if you need isolated test data), and sk_trial_ (issued at signup, expires 7 days later - swap to a live key from Settings > API keys). Keys are server-generated, shown once at creation, and scoped per permission (or admin for everything). Lovelio Connect apps authenticate with the OAuth access token from the connect flow instead (Authorization: Bearer lc_at_...) - it carries exactly the scopes the agency approved, enforced on every request. Money is gated at FIELD level, not route level: the three scopes placements:financials:read, clients:financials:read and marketplace:financials:read unlock salary, fee, contract rates, expected GP, commission percents, the client fee schedule and split-fee deal amounts. Without them those fields return null and everything else on the record still comes through - a read never 403s for want of a money scope. admin satisfies all three. Requesting any of them puts a Connect app in the elevated review tier. See /docs/agents/build-an-integration.

## Pagination and shared parameters

Every list endpoint takes these. Cursor-based: read `meta.next_cursor` from a response and pass it back as `after`.

| Name | In | Type | Description |
| --- | --- | --- | --- |
| `limit` | query | integer, 1-100, default 25 | Rows per page. Clamped to the 1-100 range rather than rejected, so asking for 500 returns 100 - read meta.has_more and page with the cursor. Unparseable values fall back to 25. |
| `after` | query | string | Cursor for forward pagination |
| `before` | query | string | Cursor for backward pagination |
| `created_after` | query | string (date-time) | Only rows created at or after this ISO 8601 date or datetime (inclusive). Malformed values are a 422, never silently ignored. |
| `created_before` | query | string (date-time) | Only rows created at or before this ISO 8601 date or datetime (inclusive). Malformed values are a 422, never silently ignored. |

## Rate limit headers

| Header | Type | Description |
| --- | --- | --- |
| `X-RateLimit-Limit` | integer | Requests allowed per minute |
| `X-RateLimit-Remaining` | integer | Requests remaining in window |
| `X-RateLimit-Reset` | integer | Unix timestamp when window resets |

## Guides

- https://lovelio.ai/docs/agents - what an agent can drive end to end
- https://lovelio.ai/docs/agents/top-10-tasks - runnable examples for the ten most common calls
- https://lovelio.ai/docs/agents/build-an-integration - sandbox agency, test API key, live webhook testing
- https://lovelio.ai/docs/agents/error-handling - error envelope, request IDs, retries, idempotency keys
- https://lovelio.ai/docs/agents/webhooks - subscribing and verifying HMAC signatures
- https://lovelio.ai/docs/agents/sdks - single-file TypeScript and Python clients
- https://lovelio.ai/docs/api/changelog - every version, including breaking changes
- https://lovelio.ai/llms-full.txt - all of the above inlined in one fetch

## Endpoint index

Filtered to: Documents.

### Documents

Files attached to any record - CVs, contracts, briefs, right-to-work scans

- `GET /documents` - List documents on a record
- `POST /documents` - Upload a document
- `GET /documents/{id}` - Get a document
- `DELETE /documents/{id}` - Delete a document
- `GET /documents/{id}/download` - Get a download link

---

## Documents

Files attached to any record - CVs, contracts, briefs, right-to-work scans

### GET /documents

**List documents on a record**

Every document filed against one record, newest first. Imported documents sort by the date they had in the previous ATS.

Operation ID: `listDocuments`

**Query parameters**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `record_type` | string (`candidate`, `client`, `client_contact`, `job`, `job_ad`, `application`, `interview`, `placement`, `submission`, `spec`, `bd_target`, `talent_pool`, `team`, `hiring_manager`) | yes | The kind of record to list documents for. |
| `record_id` | string | yes | External ID of the record (cnd_..., cli_..., job_...). |

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Documents on the record | { success, data: array of Document, meta } |
| `404` | Record not found |  |

### POST /documents

**Upload a document**

Attach a file to any record. Send multipart/form-data - not JSON - so large files do not have to be base64 encoded. Accepts PDF, Word, Excel, PowerPoint, text, RTF, HTML and images, up to 25MB.

Operation ID: `createDocument`

**Request body** (`multipart/form-data`, required)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `file` | string (binary) | yes |  |
| `record_type` | string (`candidate`, `client`, `client_contact`, `job`, `job_ad`, `application`, `interview`, `placement`, `submission`, `spec`, `bd_target`, `talent_pool`, `team`, `hiring_manager`) | yes |  |
| `record_id` | string | yes | External ID of the record. |
| `is_cv` | string (`true`, `false`) | no | Candidates only: make this the candidate's current CV. |

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `201` | Document stored | { success, data: Document } |
| `400` | Unsupported file type, empty file, or over 25MB |  |
| `404` | Record not found |  |

### GET /documents/{id}

**Get a document**

The document record. Use /documents/{id}/download for the file itself.

Operation ID: `getDocument`

**Path parameters**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes |  |

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Document | { success, data: Document } |
| `404` | Document not found |  |

### DELETE /documents/{id}

**Delete a document**

Deletes the record AND the stored file. There is no soft delete and no undo. Deleting a candidate's current CV also clears their CV pointer.

Operation ID: `deleteDocument`

**Path parameters**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes |  |

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Deleted | { success, data: object } |
| `404` | Document not found |  |

### GET /documents/{id}/download

**Get a download link**

Returns a short-lived signed URL for the file rather than the bytes, so the file streams straight from storage. The link expires after 5 minutes.

Operation ID: `downloadDocument`

**Path parameters**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes |  |

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Signed download link | { success, data: object } |
| `404` | Document not found |  |

## Schemas

Objects referenced by the operations above.

### Document

A file attached to any record. Documents are polymorphic: the same endpoints serve candidates, clients, contacts, jobs, placements, talent pools and more.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | no |  |
| `account_id` | string | no |  |
| `record_type` | string (`candidate`, `client`, `client_contact`, `job`, `job_ad`, `application`, `interview`, `placement`, `submission`, `spec`, `spec_submission`, `bd_target`, `talent_pool`, `team`, `hiring_manager`) | no | The kind of record this document is filed against. |
| `record_id` | string | no | External ID of the record it belongs to. |
| `file_name` | string | no |  |
| `content_type` | string | no |  |
| `size_bytes` | integer \| null | no |  |
| `source` | string (`upload`, `migration`, `cv`) | no | How it got here: 'upload' a person added it, 'migration' it came from a previous ATS, 'cv' it is the file the candidate's CV pointer resolves to. |
| `is_cv` | boolean | no | Candidates only: this is the current CV, the file the resume parser and cv_url read. |
| `uploaded_by_email` | string \| null | no |  |
| `source_created_at` | string (date-time) \| null | no | The date the document had in the system it came from, when known. Imported documents sort by this, not by the day the import ran. |
| `created_at` | string (date-time) | no |  |

### Meta

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `request_id` | string | no |  |
| `count` | integer | no |  |
| `has_more` | boolean | no |  |
| `next_cursor` | string \| null | no |  |
| `prev_cursor` | string \| null | no |  |