# 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: Workflow Rules.

### Workflow Rules

Per-company configuration for AI thresholds, HM deadlines, and follow-up cadences

- `GET /workflow-rules` - Get workflow rules
- `PATCH /workflow-rules` - Update workflow rules

---

## Workflow Rules

Per-company configuration for AI thresholds, HM deadlines, and follow-up cadences

### GET /workflow-rules

**Get workflow rules**

Returns the current workflow rules for the company. A default row is auto-created on first read.

Operation ID: `getWorkflowRules`

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Current workflow rules | { success, data: WorkflowRules } |

### PATCH /workflow-rules

**Update workflow rules**

Update any subset of the workflow rules fields. Each reject threshold must stay strictly below its matching yes threshold.

Operation ID: `updateWorkflowRules`

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

Schema: [`WorkflowRules`](#workflowrules)

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Updated workflow rules | { success, data: WorkflowRules } |
| `422` | Validation error |  |

## Schemas

Objects referenced by the operations above.

### WorkflowRules

Per-company configuration for how Lovelio scores, triages, and follows up on applications.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ai_assessment_job_fit_advance` | integer, 0-100 | no | Job Fit score at or above which a new application receives the AI verdict "yes" (UI label: Yes). Default 75. Both the Job Fit and Client Fit advance bars must be cleared for a verdict of yes. The AI never moves state - humans action verdicts from the inbox. |
| `ai_assessment_job_fit_reject` | integer, 0-100 | no | Job Fit score at or below which a new application receives the AI verdict "no" (default 50). Lovelio does not auto-reject; a human must confirm. |
| `ai_assessment_hm_fit_advance` | integer, 0-100 | no | Client Fit score (alignment with the client's DNA; the field name is historical) at or above which a new application receives the AI verdict "yes". Default 60. Both the Job Fit and Client Fit advance bars must be cleared for a verdict of yes. |
| `ai_assessment_hm_fit_reject` | integer, 0-100 | no | Client Fit score at or below which a new application receives the AI verdict "no" (default 50). |
| `screen_advance_threshold` | integer, 0-100 | no | Phone screen score at or above which Lovelio recommends submitting the candidate to the client. Recommendations never move a candidate automatically. |
| `screen_reject_threshold` | integer, 0-100 | no | Phone screen score at or below which Lovelio recommends parking the candidate. |
| `submission_chase_days` | integer, 1-14 | no | Days of client silence on a submission before the consultant gets a follow-up prompt. The follow-up email is always reviewed and sent by a person, never automatically. |
| `hm_interview_feedback_deadline_hours` | integer, 1-720 | no | Hours after a scheduled interview before the interviewer gets a feedback nudge. |
| `referee_details_chase_days` | integer, 0-60 | no |  |
| `referee_details_escalate_days` | integer, 0-60 | no |  |
| `referee_form_chase_days` | integer, 1-14 | no | Days between follow-up emails to referees who have not completed their reference. Two follow-ups, then the referee is flagged unresponsive. |
| `default_expected_reference_count` | integer, 1-5 | no | Default number of referees requested per candidate. Adjustable per request. |
| `hot_candidate_job_fit_threshold` | integer, 50-100 | no | Job-fit score at or above which a candidate qualifies as hot. Combined with company-fit threshold via AND. Default 80. |
| `hot_candidate_company_fit_threshold` | integer, 50-100 | no | Company-fit score at or above which a candidate qualifies as hot. Combined with job-fit threshold via AND. Default 80. |
| `auto_reject_no_enabled` | boolean | no | When true (default), applications sitting in the "no" stage past auto_reject_no_days surface a rejection prompt on the dashboard. The drafted rejection email is always reviewed and sent by a person, never automatically. |
| `auto_reject_no_days` | integer, 1-14 | no | Days an application sits in the "no" stage before the rejection prompt appears. Default 3, so a candidate is never rejected the same day they apply. |
| `created_at` | string (date-time) | no |  |
| `updated_at` | string (date-time) | no |  |