Last updated 16 August 2026
Loading API reference...

Endpoint index

Every operation in version 7.2.0 of the API - 234 of them across 157 paths. Generated from the same OpenAPI document the reference above renders.

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

An API key only works on its own region's host. Yours is shown in Settings > API keys.

Authentication
Authorization: Bearer sk_live_...

Keys are created in Settings > API keys and shown once. Lovelio Connect apps send an OAuth access token instead.

Reading this with an agent

Systemmarkdown

Health and status

  • GET/healthHealth check
  • POST/healthHealth check (POST)

Accountsmarkdown

Account and API key management

  • POST/accounts/signupCreate account
  • POST/accounts/verify-emailVerify account email
  • GET/accounts/meGet current account
  • GET/accounts/{id}Get account
  • PATCH/accounts/{id}Update account
  • GET/accounts/{id}/usersList users
  • POST/accounts/{id}/usersInvite a user
  • GET/accounts/{id}/users/{userId}Get user
  • PATCH/accounts/{id}/users/{userId}Update user
  • DELETE/accounts/{id}/users/{userId}Delete user
  • GET/accounts/{id}/teamsList teams
  • POST/accounts/{id}/teamsCreate team
  • GET/accounts/{id}/teams/{teamId}Get team
  • PATCH/accounts/{id}/teams/{teamId}Update team
  • DELETE/accounts/{id}/teams/{teamId}Delete team
  • GET/accounts/{id}/api-keysList API keys
  • POST/accounts/{id}/api-keysCreate API key
  • DELETE/accounts/{id}/api-keys/{keyId}Revoke API key
  • GET/accounts/{id}/ssoList SSO connections
  • POST/accounts/{id}/ssoCreate SSO connection
  • DELETE/accounts/{id}/sso/{connectionId}Remove SSO connection
  • GET/accounts/{id}/transcription-usageGet video transcription usage
  • POST/accounts/{id}/upgradeActivate account outside Stripe Checkout
  • GET/accounts/{id}/intake-sloGet intake pipeline SLO
  • GET/accounts/{id}/intelligenceGet company intelligence profile
  • POST/accounts/{id}/intelligence/refreshRefresh company intelligence

Jobsmarkdown

Job requisition management with AI enrichment

  • GET/jobsList jobs
  • POST/jobsCreate job (async)
  • POST/jobs/from-descriptionDraft a job from a natural-language description (streaming)
  • POST/jobs/from-description/{review_token}/confirmConfirm a staged draft and create the job (async)
  • GET/jobs/from-description/{review_token}Get the current state of a staged job draft
  • PATCH/jobs/from-description/{review_token}Update a staged job draft (fill gaps)
  • POST/jobs/from-description/{review_token}/reviseApply a free-text revision to a staged draft
  • GET/jobs/{id}/adGet the latest job ad
  • PATCH/jobs/{id}/adUpdate a job ad
  • POST/jobs/{id}/ad/rewriteAI-rewrite a job ad
  • GET/jobs/{id}/social-draftGet a job's LinkedIn + X post drafts
  • PATCH/jobs/{id}/social-draftUpdate a job's social post text
  • GET/jobs/{id}Get job
  • PATCH/jobs/{id}Update job
  • DELETE/jobs/{id}Delete job
  • POST/jobs/{id}/closeClose job
  • POST/jobs/{id}/reopenReopen job
  • GET/jobs/{id}/summaryAI job summary
  • GET/jobs/{id}/rankingStack-ranked interviewed candidates for a job
  • GET/jobs/{id}/share-bundleGet share-ready content bundle for a job

Job Adsmarkdown

Public job postings and career pages

  • GET/job-adsList job ads
  • POST/job-adsCreate job ad
  • GET/job-ads/{id}Get job ad
  • DELETE/job-ads/{id}Delete job ad
  • POST/job-ads/{id}/expireExpire job ad

Candidatesmarkdown

Candidate profiles and talent database

  • GET/candidatesList candidates
  • POST/candidatesCreate candidate
  • GET/candidates/{id}Get candidate
  • PATCH/candidates/{id}Update candidate
  • DELETE/candidates/{id}Delete candidate
  • DELETE/candidates/{id}/gdpr-deleteGDPR delete candidate
  • POST/candidates/searchSearch candidates
  • GET/candidates/duplicatesFind duplicate candidates
  • POST/candidates/mergeMerge candidates
  • POST/candidates/from-cvUpload a CV and stage a candidate draft
  • GET/candidates/from-description/{review_token}Get a staged candidate draft
  • PATCH/candidates/from-description/{review_token}Patch fields on a staged candidate draft
  • POST/candidates/from-description/{review_token}/confirmCreate a candidate from a staged draft

Candidate Importsmarkdown

Bulk CV import - migrate thousands of CVs into the talent bank

  • POST/candidate-importsStart a bulk CV import
  • GET/candidate-imports/{id}Get import report
  • POST/candidate-imports/{id}/filesRequest upload slots
  • POST/candidate-imports/{id}/finalizeConfirm uploads

Applicationsmarkdown

Application pipeline with AI assessment

  • GET/applicationsList applications
  • POST/applicationsCreate application (async)
  • GET/applications/{id}Get application
  • PATCH/applications/{id}Update application
  • POST/applications/bulk-updateBulk update applications
  • POST/phone-screens/from-descriptionStage a phone-screen log
  • GET/phone-screens/from-description/{review_token}Get a staged phone-screen draft
  • PATCH/phone-screens/from-description/{review_token}Patch fields on a staged phone-screen draft
  • POST/phone-screens/from-description/{review_token}/confirmConfirm a phone-screen log
  • POST/applications/{id}/stageTransition application stage

Interviewsmarkdown

Interview scheduling and feedback

  • GET/interviewsList interviews
  • POST/interviewsSchedule interview
  • GET/interviews/{id}Get interview
  • PATCH/interviews/{id}Update interview
  • DELETE/interviews/{id}Delete interview
  • POST/interviews/{id}/cancelCancel interview
  • POST/interviews/{id}/scorecardSubmit interview scorecard
  • POST/interviews/{id}/schedule-linkGenerate candidate self-schedule link
  • POST/interviews/from-descriptionStage an interview draft for an application
  • GET/interviews/from-description/{review_token}Get a staged interview draft
  • PATCH/interviews/from-description/{review_token}Patch fields on a staged interview draft
  • POST/interviews/from-description/{review_token}/confirmBook the drafted interview
  • POST/interviews/{id}/actionStage a reschedule or cancel draft for an existing interview
  • GET/interviews/action-drafts/{review_token}Get a staged reschedule / cancel draft
  • PATCH/interviews/action-drafts/{review_token}Patch fields on a staged reschedule / cancel draft
  • POST/interviews/action-drafts/{review_token}/confirmConfirm a reschedule or cancel draft
  • POST/scorecards/from-descriptionStage a scorecard draft for an interview
  • GET/scorecards/from-description/{review_token}Get a staged scorecard draft
  • PATCH/scorecards/from-description/{review_token}Patch fields on a staged scorecard draft
  • POST/scorecards/from-description/{review_token}/confirmSubmit a staged scorecard draft

Submissionsmarkdown

Client-facing shortlists with a tokenised review link and a live feedback loop

  • GET/submissionsList submissions
  • POST/submissionsCreate and send a submission
  • GET/submissions/{id}Get submission

Placementsmarkdown

The record of the win: fee, start date, guarantee lifecycle

  • GET/placementsList placements
  • POST/placementsLog placement
  • GET/placements/{id}Get placement
  • PATCH/placements/{id}Update placement

Quotasmarkdown

Quota plan, periods and the recognition board: credit-share money against targets for the agency, teams and consultants

  • GET/quotas/planGet quota plan
  • GET/quotas/periodsList quota periods
  • GET/quotas/periods/{id}Get quota period board

Marketplacemarkdown

Cross-agency job and candidate splits: anonymised listings, reveal-on-accept intros, and the deal record both agencies read. Lovelio takes 0% and never touches the money. Needs an active Lovelio plan.

  • GET/marketplace/listingsBrowse marketplace listings
  • POST/marketplace/listingsShare to the marketplace
  • GET/marketplace/listings/{id}Get marketplace listing
  • PATCH/marketplace/listings/{id}Manage marketplace listing
  • GET/marketplace/introsList marketplace intros
  • POST/marketplace/introsMake a marketplace intro
  • GET/marketplace/intros/{id}Get marketplace intro
  • POST/marketplace/intros/{id}/respondRespond to a marketplace intro
  • GET/marketplace/dealsList marketplace deals
  • GET/marketplace/deals/{id}Get marketplace deal
  • PATCH/marketplace/deals/{id}Marketplace deal handshake

Webhooksmarkdown

Event subscriptions with HMAC-SHA256 signing

  • GET/webhooksList webhooks
  • POST/webhooksCreate webhook
  • GET/webhooks/eventsList webhook events
  • GET/webhooks/{id}Get webhook
  • PATCH/webhooks/{id}Update webhook
  • DELETE/webhooks/{id}Delete webhook
  • POST/webhooks/{id}/rotate-secretRotate webhook secret
  • POST/webhooks/{id}/testTest webhook
  • GET/webhooks/{id}/deliveriesList webhook deliveries
  • POST/webhooks/{id}/deliveries/{deliveryId}/replayReplay webhook delivery

Batchmarkdown

Execute multiple canonical actions in a single request with per-op idempotency

  • POST/batchExecute multiple actions in one request

Activitiesmarkdown

Audit log and activity tracking

  • GET/activitiesList activities
  • POST/activitiesAdd a note

Documentsmarkdown

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

  • GET/documentsList documents on a record
  • POST/documentsUpload a document
  • GET/documents/{id}Get a document
  • DELETE/documents/{id}Delete a document
  • GET/documents/{id}/downloadGet a download link

Tasksmarkdown

Async operation polling

  • GET/tasks/{id}Get task status

Outreachmarkdown

AI-powered candidate outreach

  • POST/outreach/generateGenerate AI outreach
  • GET/outreachList outreach records
  • POST/outreachCreate outreach record

Talent Poolsmarkdown

Talent pool membership and candidate rediscovery

  • GET/talent-poolsList talent pools
  • POST/talent-poolsCreate a talent pool
  • GET/talent-pools/{id}Get talent pool
  • PATCH/talent-pools/{id}Update talent pool
  • DELETE/talent-pools/{id}Delete talent pool
  • GET/talent-pools/{id}/membersList pool members
  • POST/talent-pools/{id}/membersAdd candidate to pool
  • DELETE/talent-pools/{id}/members/{memberId}Remove pool member
  • GET/talent-pools/{id}/requestsList join requests
  • POST/talent-pools/{id}/requests/{requestId}/approveApprove join request
  • POST/talent-pools/{id}/requests/{requestId}/declineDecline join request
  • POST/public/talent-pools/{employerSlug}/{poolSlug}/joinAsk to join a talent pool

Review Queuemarkdown

Items Lovelio cannot decide on its own and needs a recruiter to handle

  • GET/review-queueList review queue items
  • PATCH/review-queue/{id}Update a review queue item

Formsmarkdown

Form templates, phone screen execution, and reference check delivery

  • GET/formsList forms
  • POST/formsCreate form
  • GET/forms/{id}Get form with questions
  • PATCH/forms/{id}Update form
  • DELETE/forms/{id}Delete form
  • POST/forms/{id}/questionsAdd question to form
  • PATCH/forms/{id}/questions/{questionId}Update question
  • DELETE/forms/{id}/questions/{questionId}Delete question
  • GET/form-instancesList form instances
  • GET/form-instances/{id}Get form instance
  • POST/form-instances/screeningCreate screening instance
  • POST/form-instances/referenceCreate reference instance
  • POST/form-instances/{id}/sendSend reference form to referee

Refereesmarkdown

Candidate referee management for reference checks

  • GET/candidates/{id}/refereesList referees
  • POST/candidates/{id}/refereesAdd referee
  • PATCH/candidates/{id}/referees/{refereeId}Update referee
  • DELETE/candidates/{id}/referees/{refereeId}Delete referee

Integrationsmarkdown

Third-party integrations (Slack, Calendar)

  • GET/integrations/slackGet Slack integration
  • PATCH/integrations/slackUpdate Slack settings
  • DELETE/integrations/slackDisconnect Slack

Chat Integrationsmarkdown

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

  • GET/integrations/chatList chat integrations
  • POST/integrations/chatConnect chat platform
  • PATCH/integrations/chat/{id}Update chat integration
  • DELETE/integrations/chat/{id}Disconnect chat platform
  • GET/integrations/chat/{id}/usersList user mappings
  • POST/integrations/chat/{id}/usersCreate user mapping
  • DELETE/integrations/chat/{id}/users/{userId}Delete user mapping

Analyticsmarkdown

Hiring dashboard, pipeline funnel analysis, and KPI metrics

  • GET/analytics/dashboardDashboard statistics
  • GET/analytics/pipelinePipeline analysis
  • GET/analytics/metricsHiring metrics

Calendarmarkdown

Shared calendar events for interviews, phone screens, reminders, deadlines, and meetings

  • GET/calendar-eventsList calendar events
  • POST/calendar-eventsCreate calendar event
  • GET/calendar-events/{id}Get calendar event
  • PATCH/calendar-events/{id}Update calendar event
  • DELETE/calendar-events/{id}Delete calendar event

Scheduled Emailsmarkdown

Superhuman-style scheduled candidate email sends. Draft, schedule, edit, cancel, or send-now before delivery.

  • POST/emailsSend candidate email now
  • POST/emails/from-descriptionStage and stream a candidate email draft
  • GET/emails/from-description/{review_token}Get a staged email draft
  • PATCH/emails/from-description/{review_token}Patch fields on a staged email draft
  • POST/emails/from-description/{review_token}/reviseApply a free-text rewrite to a staged email draft
  • POST/emails/from-description/{review_token}/confirmSend or schedule a drafted email
  • GET/scheduled-emailsList scheduled emails
  • POST/scheduled-emailsCreate scheduled email
  • GET/scheduled-emails/{id}Get scheduled email
  • PATCH/scheduled-emails/{id}Update scheduled email
  • DELETE/scheduled-emails/{id}Cancel scheduled email
  • POST/scheduled-emails/{id}/send-nowSend scheduled email now

Workflow Rulesmarkdown

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

  • GET/workflow-rulesGet workflow rules
  • PATCH/workflow-rulesUpdate workflow rules

Email Templatesmarkdown

Canonical transactional email templates and per-company AI instruction overrides

  • GET/email-templatesList email templates
  • PATCH/email-templatesUpdate one or more email templates

Stagesmarkdown

Canonical pipeline stage reference (labels, transitions, terminal flags)

  • GET/stagesList canonical pipeline stages

Distributionmarkdown

Job board catalogue, posting rules, multi-board distribution, and the posting ledger

  • GET/distribution/boardsList job boards
  • GET/distribution/rulesList distribution rules
  • POST/distribution/rulesCreate a distribution rule
  • PATCH/distribution/rules/{id}Update a distribution rule
  • DELETE/distribution/rules/{id}Delete a distribution rule
  • GET/distribution/postingsList job board postings
  • POST/distribution/publishDistribute a job to boards

Clientsmarkdown

  • GET/clientsList clients
  • POST/clientsCreate client
  • GET/clients/{id}Get client
  • PATCH/clients/{id}Update client
  • DELETE/clients/{id}Delete client
  • GET/clients/{id}/contactsList client contacts
  • POST/clients/{id}/contactsAdd client contact
  • PATCH/clients/{id}/contacts/{contactId}Update client contact
  • DELETE/clients/{id}/contacts/{contactId}Delete client contact

Specsmarkdown

  • GET/specsList specs
  • POST/specsCreate and send a spec
  • GET/specs/{id}Get spec

Searchmarkdown

  • POST/searchNatural language search

Business Developmentmarkdown

  • GET/bd/targetsList BD targets
  • GET/bd/targets/{id}Get BD target
  • GET/bd/leadsList BD leads
  • GET/bd/leads/{id}Get BD lead
  • GET/bd/patchGet BD patch