The Lidmeo API
A REST API for your prospects, conversations, campaigns and CRM: conventions, resources, OpenAPI contract.
https://api.lidmeo.com/v1The API does what the Lidmeo screen does, and everything the AI assistant connected to Lidmeo does, through the same functions: read your CRM, organize it, find and add prospects, create, set up and launch campaigns, approve invitations, send messages, follow what happens. Sending limits, hours and "Do not contact" apply identically.
What stays in Lidmeo, as for the assistant: connecting LinkedIn, a mailbox or WhatsApp (the API gives their state and the link of the page, GET /v1/settings/connections), the subscription and buying credits, the Team plan, referrals and the inbox's reply suggestions.
Conventions
- JSON in UTF-8, field names in English
snake_case. - Dates in ISO 8601, in UTC (
2026-10-01T08:30:00Z). A day alone (2026-10-02), likereminder_on, is a Paris day; inupdated_since, it starts at midnight, Paris time. - Ids are opaque and prefixed:
acct_(account),org_(agency),pros_(prospect),cmp_(campaign),conv_(conversation),msg_(message),stg_(stage),lst_(list),note_,imp_(import),job_(contact lookup),sup_("do not contact"),evt_(event),whe_(webhook endpoint),whd_(delivery),key_(API key),app_(application),grt_(OAuth connection); for Copilote,rep_(agent reply),gol_(goal),res_(resource),kno_(knowledge source),mtg_(meeting),cnv_(conversion). Don't build them, don't split them: reuse them as they are. - Every object carries
object(its type); account objects (prospects, conversations, messages, campaigns, notes, events, webhook endpoints…) also carrylivemode(falsein test mode). - Every response carries the
Request-Idheader: give it to support if something surprises you. You can also send your own: it is reused if it is 8 to 64 characters long (letters, digits,.,_and-), otherwise Lidmeo creates one. - An unknown parameter is never ignored: it answers
400 invalid_request, with the codeunknown_parameterand the fieldquery.<name>inerrors. - Errors are RFC 9457 problems with a stable
code: see errors. - Lists are read in pages, with a cursor: see pagination.
- Writes accept an
Idempotency-Key: see idempotency.
Sends say what really happened
An action that sends something (approve an invitation, a first message, reply, follow up) answers 202 and says what really happened:
status | What it means |
|---|---|
sent | It left. |
scheduled | It will leave at scheduled_at at the earliest; cause says why: window (outside your hours), cap (daily limit reached), paused (sends paused to protect the account). The queue sends one at a time, within your limits: with several scheduled sends, most leave later. Read the prospect again to know when it left. |
already_sent | It had already left. |
already_connected | No invitation needed: the person is already a connection. |
Otherwise, a refusal that says why: suppressed ("do not contact"), daily_cap_reached, linkedin_disconnected, not_approvable… Nothing is ever presented as sent if it is not.
- One send at a time per account: a second one, meanwhile, answers
409 send_in_progress; retry in a moment. - The text is yours, and final: empty, or if it still holds a template variable (
{{first_name}},[Prénom]…), it answers400 invalid_request. A follow-up holds 2000 characters at most; the other texts, 4000. - A reply (
kind: "reply") only leaves to a contact who replied (theirreplied_at, or a reply already visible in the conversation), otherwise409 not_replied. Withkind: "auto", it is a reply when Lidmeo sees that the contact replied, a follow-up otherwise. Never to "Do not contact", and at most 100 per account and per day through the API: beyond that,409 daily_cap_reached, withcapandnext_slot_at. - Files with a reply:
attachments, up to 5 files (filenameandcontent_base64, the file base64-encoded without adata:prefix), 3 MB at most in total once decoded. JPG, PNG or GIF images, PDF, Word, Excel, PowerPoint, TXT, CSV. The type is read from the content, never from the name alone: a refused file answers400 invalid_request, anderrorsnames it (attachments[0]…). A reply only: with a follow-up,400 invalid_request, theattachmentsfield error carrying thereply_onlycode. Nothing leaves while a file is refused; the202answer lists the files that left.
Two-step actions
What launches a campaign, puts people in it, spends credits, sends a prepared message or deletes is done in two steps, as in the AI assistant. The route that prepares does nothing and answers a preview (step: "preview", preview_id, expires_at); POST /v1/previews/{id}/confirm does exactly what the preview showed.
| Prepare | What is confirmed |
|---|---|
POST /v1/campaigns/{id}/launch | the launch of a campaign that never ran |
POST /v1/campaigns/{id}/add_prospects | people put in a campaign's sequence |
POST /v1/people/add | people found by the search, added (credits) |
POST /v1/agents/{agent}/add_people | people spotted by Lidmeo Agent, put in a campaign |
POST /v1/closer/replies/{id}/send | a reply of the Copilote agent, sent to the prospect |
POST /v1/closer/meetings/{id}/cancel | cancelling a meeting (the connected calendar notifies the person) |
POST /v1/sequence_steps/approve | follow-ups and e-mails of sequences approved or declined |
POST /v1/prospects/{id}/drafts | a message: a follow-up written by the AI, a reply on LinkedIn, by e-mail or on WhatsApp, a first message |
DELETE /v1/campaigns/{id} | the deletion of a campaign |
- A preview is used once, within 15 minutes, from the key or connection that prepared it, in the same mode. Expired:
409 preview_expired; already confirmed:409 preview_already_used; prepared by another key:404 not_found. - Nothing else happens at confirmation: its body is empty. A campaign changed since the preview is not launched (
409 action_refused,reasoniscampaign_changed). - The scopes are those of the route that prepared it (
sends:writeto launch or send), and the confirmation counts in the key's daily limit of send actions (409 connection_cap_reached). - A refusal of these routes that has no code of its own is
409 action_refused: the exact reason is inreason, what to do indetail.
A LinkedIn follow-up or reply whose final text you wrote also leaves in a single call: POST /v1/prospects/{id}/messages.
Resources
| Resource | What it carries |
|---|---|
| Identity | GET /v1/me (who is calling), GET /v1/accounts (the accounts covered) |
| Account | GET /v1/overview (the day), GET /v1/activity, GET /v1/credits |
| Onboarding | the setup of the first campaign of an account that has not activated its trial yet, one question at a time, like Lidmeo's onboarding screens (/v1/onboarding) |
| Prospects | the list and its views, search, adding prospects, stage, reminders, lists, notes, timeline, setting aside ("Écarter"), the link with your tools, the Excel export |
| Conversations | one per person, LinkedIn, e-mail and WhatsApp together, their messages, searching the messages, reminder, temperature, read state |
| Campaigns | create, target, write the sequence or start it from a Lidmeo template (the "Voir les modèles" gallery, GET /v1/sequence_templates, and "Utiliser ce modèle", POST /v1/campaigns/{id}/sequence/apply_template), set up, launch, put people in or take them out, pause, resume, read the website again, delete, funnel |
| Search | Lidmeo's database of contacts ("Recherche"): find new people, add them |
| Lidmeo Agent | the three agents, their settings, the people they spotted |
| Copilote | the agent that answers your prospects (its settings, "Tester l'agent", its knowledge), its replies waiting for approval, each conversation's mode, your goals and their results, the calendar; with the Copilote plan (/v1/closer/…) |
| CRM | your stages, your lists, "do not contact" |
| Imports | prospects in bulk, through Lidmeo's import rule ("Importer des prospects") |
| Sends | approve an invitation or a first message, send a reply or a follow-up, prepare a message, approve sequence follow-ups and e-mails, cancel a follow-up |
| Previews | confirm a two-step action |
| Settings | connected accounts, sending settings, Lidmeo's e-mails, prospecting and the split of new prospects |
| Support | your exchanges with the Lidmeo team |
| Help | Lidmeo's help articles |
| Contact details | look up the e-mail or phone, with your credits (never for a "Do not contact" person) |
| Events and webhooks | what happened, and the endpoints that receive it |
| Test mode | reset, simulate an acceptance or a reply |
Every operation, its parameters and its responses: the full reference, with a live trial (use a test key).
The contract
The API is described by an OpenAPI 3.1 document, generated from the code that validates requests: the contract and the behavior cannot diverge. For each operation, it declares every status it can answer.
https://api.lidmeo.com/v1/openapi.jsonhttps://developers.lidmeo.com/openapi.json
Import it into Postman, Insomnia or your client generator, or use our SDKs.