LidmeoDevelopers

Quickstart

A test key, a first call, a simulated acceptance and its event: without sending anything to anyone.

Everything happens on your test account: a fictitious account, filled with sample prospects, where invitations and replies are simulated. Nothing leaves for LinkedIn or by e-mail, and your trials never touch your real account.

Create a test key

In Lidmeo, open Assistant IA et intégrations (AI assistant and integrations, in the Réglages menu), then Pour les développeurs (for developers), section Clés d'API (API keys), and Créer une clé (Create a key). Name it; under Données (Data), choose Le compte de test (fictif, rien ne part vers LinkedIn) (the test account, fictitious, nothing leaves for LinkedIn); keep the proposed scopes, then click Créer la clé (Create the key). The key starts with lid_test_: copy it right away, it will never be shown again.

export LIDMEO_API_KEY="lid_test_…"

Your first call

curl https://api.lidmeo.com/v1/me \
  -H "Authorization: Bearer $LIDMEO_API_KEY"

The response says who is calling, on which account, with which scopes. livemode: false: you are in test mode.

{
  "object": "me",
  "livemode": false,
  "credential": { "type": "api_key", "id": "key_1Q2w3E4r5T6y" },
  "account": "acct_1J4kQ8sLr2Xw",
  "organization": null,
  "scopes": ["account:read", "prospects:read", "contacts:read", "conversations:read", "prospects:write", "enrichment:write", "campaigns:write", "webhooks:manage"],
  "api_version": "2026-10-01",
  "plan": "pro"
}

Read an invited prospect

curl "https://api.lidmeo.com/v1/prospects?pipeline_stage=invited&limit=1" \
  -H "Authorization: Bearer $LIDMEO_API_KEY"

Keep its id (pros_…). A list always answers { "object": "list", "data": [...], "has_more": ..., "next_cursor": ... }: see pagination.

Simulate its acceptance

Sample prospects stay at their stage; only what you send moves on its own. So force the acceptance:

curl https://api.lidmeo.com/v1/test/simulate \
  -H "Authorization: Bearer $LIDMEO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "prospect": "pros_…", "event": "invitation_accepted" }'

Read the event

Your account's facts (invitation, acceptance, message, reply, stage set…) become events, readable through the API and delivered to your webhooks. Most are recorded within a minute; those of an action taken through the API, like this simulation, usually right after it.

curl "https://api.lidmeo.com/v1/events?type=invitation.accepted" \
  -H "Authorization: Bearer $LIDMEO_API_KEY"

The event carries in data.object the prospect as it was when the event was recorded. To receive it on your server, create a webhook endpoint with this same test key: the test account's endpoints are created through the API, the "Assistant IA et intégrations" page only shows those of the real account.

Go live

In Lidmeo (Assistant IA et intégrations, Pour les développeurs), create a key with Votre compte (réel) (your account, live) under Données (Data): it starts with lid_live_. Give it only the scopes your program needs. The right to send (sends:write) is not given by default: tick it only if your program approves invitations or sends messages. The same code runs identically: only the key changes.

Reset the test account

POST /v1/test/reset, or the Remettre le compte de test à zéro (reset the test account) button in Lidmeo (Assistant IA et intégrations, Pour les développeurs), erases what you did in test and puts the samples back. See test mode.

On this page