# 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: Specs.

### Specs

- `GET /specs` - List specs
- `POST /specs` - Create and send a spec
- `GET /specs/{id}` - Get spec

---

## Specs

### GET /specs

**List specs**

Specs (Floats in AU/NZ): speculative submissions - one anonymous candidate profile sent to one client contact with no job. Requires submissions:read.

Operation ID: `listSpecs`

**Query parameters**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer, 1-100, default 25 | no | 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` | string | no | Cursor for forward pagination |
| `candidate_id` | string | no | Filter to one candidate (cnd_ id). |
| `client_id` | string | no | Filter to one client (cli_ id). |
| `status` | string (`sent`, `viewed`, `interested`, `passed`, `converted`, `expired`, `revoked`) | no |  |

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Paginated list of specs, newest first | { success, data: array of Spec, meta } |

### POST /specs

**Create and send a spec**

Sends a spec: a short personal email to the client contact with the pitch inline, a no-login link to the anonymous profile page, and the agency terms of business attached (when uploaded in Settings > Company). The candidate's name and current employer are scrubbed server-side from every client-facing field, and a candidate can never be specced to their own employer (422). Same write path as the in-product guided modal. Requires submissions:write.

Operation ID: `createSpec`

**Request body** (`application/json`, required)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `candidate_id` | string | yes |  |
| `client_id` | string | yes |  |
| `client_contact_id` | string | yes | Must belong to the client. |
| `headline` | string | yes | Anonymous profile title, e.g. "Senior Quantity Surveyor - Tier 1 commercial". |
| `pitch` | string | yes | Why this person is worth meeting. Employers generalised, never named. |
| `chips` | array of string | no | Up to 6 short facts (years, sector, location). |
| `why_client` | string | no | Why this candidate fits THIS client - shown on their private page. |
| `email_subject` | string | yes |  |
| `email_greeting` | string | no | Opening line of the email, no trailing comma (e.g. "Hi Brett"). Defaults to "Hi {first name}". |
| `email_body` | string | yes | Short personal note. The profile button and signature are added automatically. |
| `attach_terms` | boolean, default true | no |  |
| `candidate_aware` | boolean, default false | no | The honest record: does the candidate know? |

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `201` | Created spec. email_sent false means the profile link works but the email failed - share it directly. | { success, data: Spec } |

### GET /specs/{id}

**Get spec**

Operation ID: `getSpec`

**Path parameters**

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

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Spec with its response state and conversion links | { success, data: Spec } |
| `404` | Spec not found |  |

## Schemas

Objects referenced by the operations above.

### 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 |  |

### Spec

A spec (Float in AU/NZ): a speculative submission - one FULLY ANONYMOUS candidate profile sent to one client contact with no job, with the agency's terms of business attached as a PDF. The contact opens a no-login profile page and responds one-click (interested / question / not right now). Interest converts to a real job + application via the convert_spec batch op. The candidate's name and current employer are scrubbed server-side from every client-facing field.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | no |  |
| `candidate_id` | string | no |  |
| `client_id` | string | no |  |
| `client_contact_id` | string | no |  |
| `status` | string (`sent`, `viewed`, `interested`, `passed`, `converted`, `expired`, `revoked`) | no |  |
| `anonymous_profile` | object | no | The client-facing profile, exactly as approved by the consultant (and scrubbed of identifying details). |
| `anonymous_profile.headline` | string | no |  |
| `anonymous_profile.chips` | array of string | no |  |
| `anonymous_profile.pitch` | string | no |  |
| `anonymous_profile.why_client` | string \| null | no |  |
| `email_subject` | string | no |  |
| `terms_attached` | boolean | no | Whether the agency terms of business PDF rode along - the introduction record. |
| `candidate_aware` | boolean | no | The honest record: does the candidate know they were specced? |
| `url` | string | no | The client-facing profile link. No login - anyone with the link can respond. Expires with the spec (30 days). |
| `sent_at` | string (date-time) | no |  |
| `expires_at` | string (date-time) | no |  |
| `first_viewed_at` | string (date-time) \| null | no |  |
| `responded_at` | string (date-time) \| null | no |  |
| `response` | string (`interested`, `passed`, null) \| null | no |  |
| `response_note` | string \| null | no |  |
| `response_rating` | integer, 1-5 \| null | no | The client's 1-5 rating, captured when they mark interest. Null if not rated. |
| `converted_job_id` | string \| null | no |  |
| `converted_application_id` | string \| null | no |  |
| `created_at` | string (date-time) | no |  |