# 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: Chat Integrations.

### Chat Integrations

AI chatbot platform connections (Slack, Teams, WhatsApp, Google Chat) and user identity mappings

- `GET /integrations/chat` - List chat integrations
- `POST /integrations/chat` - Connect chat platform
- `PATCH /integrations/chat/{id}` - Update chat integration
- `DELETE /integrations/chat/{id}` - Disconnect chat platform
- `GET /integrations/chat/{id}/users` - List user mappings
- `POST /integrations/chat/{id}/users` - Create user mapping
- `DELETE /integrations/chat/{id}/users/{userId}` - Delete user mapping

---

## Chat Integrations

AI chatbot platform connections (Slack, Teams, WhatsApp, Google Chat) and user identity mappings

### GET /integrations/chat

**List chat integrations**

List all connected chat platforms (Slack, Teams, WhatsApp, Google Chat) for the company.

Operation ID: `listChatIntegrations`

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Array of connected platforms with chatbot status | { success, data: array of object } |

### POST /integrations/chat

**Connect chat platform**

Programmatically connect a chat platform for the AI chatbot. Requires platform credentials.

Operation ID: `connectChatPlatform`

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `platform` | string (`slack`, `teams`, `whatsapp`, `google_chat`, `discord`, `telegram`, `github`, `linear`) | yes |  |
| `workspace_id` | string | yes | Platform workspace/team ID |
| `workspace_name` | string | yes | Human-readable workspace name |
| `credentials` | object | no | Platform-specific credentials (bot_token for Slack, etc.) |

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `201` | Integration created | { success, data: object } |

### PATCH /integrations/chat/{id}

**Update chat integration**

Enable/disable the chatbot or update settings for a connected platform.

Operation ID: `updateChatIntegration`

**Path parameters**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes | Integration ID (slk_ or cin_ prefix) |

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `chatbot_enabled` | boolean | no |  |
| `settings` | object | no |  |

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Updated integration | { success, data: object } |

### DELETE /integrations/chat/{id}

**Disconnect chat platform**

Operation ID: `disconnectChatPlatform`

**Path parameters**

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

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Disconnected | { success } |

### GET /integrations/chat/{id}/users

**List user mappings**

List all platform user to Lovelio user mappings for an integration. Users are auto-mapped by email on first interaction, but can also be managed via API.

Operation ID: `listChatUserMappings`

**Path parameters**

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

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Array of user mappings | { success, data: array of object } |

### POST /integrations/chat/{id}/users

**Create user mapping**

Manually map a platform user to a Lovelio user. Useful for bulk provisioning or when auto-mapping by email is not possible.

Operation ID: `createChatUserMapping`

**Path parameters**

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

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

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `platform_user_id` | string | yes | Platform-specific user ID (e.g. Slack user ID) |
| `platform_workspace_id` | string | yes | Platform workspace ID |
| `user_id` | string | yes | Lovelio user ID (usr_ prefix) |
| `display_name` | string | no |  |
| `role` | string | no |  |

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `201` | Mapping created | { success, data: object } |

### DELETE /integrations/chat/{id}/users/{userId}

**Delete user mapping**

Operation ID: `deleteChatUserMapping`

**Path parameters**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes |  |
| `userId` | string | yes | User mapping ID (cum_ prefix) |

**Responses**

| Code | Description | Body |
| --- | --- | --- |
| `200` | Mapping deleted | { success } |