The Lyane public API

Read and write your clients, contacts, opportunities and tasks from an ERP, a script or an automation tool. Available on the Enterprise plan.

Base URL
https://api.lyane.app/public/v1
Version
v1
Contents

Introduction

The public API opens your Lyane workspace’s data to your own tools: an ERP, a sync script, an automation tool. It reads and writes clients, contacts, opportunities and tasks, and reads quotes, invoices and documents.

It is included in the Enterprise plan. Every URL starts with https://api.lyane.app/public/v1; bodies are JSON and instants follow ISO 8601, in UTC.

To get a key, a workspace administrator opens the app, then Settings → API. They give it a name and choose the domains it can access. Copy the key as soon as it is created and keep it in a secrets manager: the API never returns it in clear text, and only its prefix (lyk_ab12cd) identifies it afterwards.

What the API creates or updates appears in the app under the workspace’s “API” service account (field createdBy). A member assigned a task through the API is notified just as in the app.

The OpenAPI 3.1 specification describes every route: import it into your HTTP client (Postman, Insomnia, Bruno…) or a code generator. openapi.json

Authentication

Every request presents the key in the Authorization header, using the Bearer scheme. A missing, unknown, revoked or expired key gets a 401 response with the code invalid_api_key.

HTTP
Authorization: Bearer lyk_…

GET /me checks a key: it returns its workspace, name, prefix, permissions and expiry date.

curl
curl "https://api.lyane.app/public/v1/me" \
  -H "Authorization: Bearer $LYANE_API_KEY"

Permissions per domain

A key only opens the domains chosen when it was created, each at one of three levels:

  • None NONE — the domain stays closed to the key.
  • Read READ — list and retrieve.
  • Read and write WRITE — list and retrieve, and also create, update and delete.
DomainWhat it opens
clientsClients and prospects, companies and individuals.
contactsContact records shared with the team.
opportunitiesOpportunities, sales pipelines and their stages.
tasksTasks and follow-ups.
salesQuotes and invoices, read-only.
documentsFiles stored on client records, read-only.

A call outside the key’s permissions gets 403 insufficient_scope, with the missing domain (domain) and the level required (required). Deleting a client also deletes its opportunities and its draft quotes and invoices: write access to opportunities and sales is then required.

Expiry and revocation

A key can have an expiry date (expiresAt in GET /me, null if it never expires). After that date, it is rejected with 401 invalid_api_key.

An administrator can revoke a key at any time in Settings → API: it is then rejected the same way. To rotate keys without downtime, create the new one, deploy it, then revoke the old one.

The workspace can also restrict the API to a list of IP addresses (403 ip_not_allowed outside it), and a plan without the API gets 403 feature_not_included.

Rate limits

Each key has 600 requests per minute and 50,000 requests per day (UTC day). Every response tells you where the per-minute limit stands:

HeaderMeaning
RateLimit-LimitThe requests allowed per minute for this key.
RateLimit-RemainingThe requests left in the current minute.
RateLimit-ResetThe seconds until the window is full again.
HTTP
HTTP/1.1 200 OK
Content-Type: application/json
RateLimit-Limit: 600
RateLimit-Remaining: 598
RateLimit-Reset: 42

Beyond that, the API responds 429 with a Retry-After header, in seconds, and the code rate_limited (per-minute limit) or quota_exceeded (daily quota). Wait for the given delay before retrying instead of retrying straight away.

HTTP
HTTP/1.1 429 Too Many Requests
Content-Type: application/problem+json
Retry-After: 18
RateLimit-Limit: 600
RateLimit-Remaining: 0
RateLimit-Reset: 18

{
  "type": "about:blank",
  "title": "Too Many Requests",
  "status": 429,
  "detail": "Trop de requêtes pour cette clé : réessayez dans 18 secondes.",
  "code": "rate_limited",
  "retryAfter": 18
}

Pagination

Lists use cursor pagination and are sorted by last update (updatedAt), then by identifier: the order stays stable even when items change between two pages.

ParameterPurpose
limitThe number of items per page, from 1 to 200 (50 by default).
cursorThe nextCursor of the previous page, as is. An unreadable cursor gets 400 invalid_cursor.
updatedSinceAn ISO 8601 instant in UTC: only what was created or updated since then, inclusive.
curl
curl "https://api.lyane.app/public/v1/clients?limit=100&updatedSince=2026-11-01T00:00:00Z" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response
{
  "data": [
    { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "Atelier Lumen", … }
  ],
  "nextCursor": "MjAyNi0xMS0xMlQwOToxNTowMC4xMjM0NTZafDNmYTg1ZjY0LTU3MTctNDU2Mi1iM2ZjLTJjOTYzZjY2YWZhNg"
}

The response holds the page (data) and the next cursor (nextCursor); null means it was the last page. To sync, record the instant each run starts and pass it as updatedSince on the next one: only items created or updated in between come back.

curl
curl "https://api.lyane.app/public/v1/clients?limit=100&updatedSince=2026-11-01T00:00:00Z&cursor=MjAyNi0xMS0xMlQwOToxNTowMC4xMjM0NTZafDNmYTg1ZjY0LTU3MTctNDU2Mi1iM2ZjLTJjOTYzZjY2YWZhNg" \
  -H "Authorization: Bearer $LYANE_API_KEY"

Idempotency

A creation (POST) can carry an Idempotency-Key header: a value unique to that creation, 1 to 255 characters long, a UUID for example. Replayed with the same key within 24 hours, after a network failure for example, the request gets the original response, with the header Idempotent-Replayed: true, and nothing is created twice.

curl
curl -X POST "https://api.lyane.app/public/v1/clients" \
  -H "Authorization: Bearer $LYANE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f0c6b1e-2d4a-4c8e-9b7f-1a2b3c4d5e6f" \
  -d '{
  "type": "company",
  "status": "prospect",
  "companyName": "Atelier Lumen",
  "siren": "552100554",
  "siret": "55210055400013",
  "vatNumber": "FR40552100554",
  "website": "https://atelier-lumen.fr",
  "industry": "Architecture",
  "address": {
    "line": "12 rue des Lilas",
    "line2": "Bâtiment B",
    "postalCode": "69003",
    "city": "Lyon",
    "country": "France"
  },
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}'
Response
HTTP/1.1 201 Created
Content-Type: application/json
Location: https://api.lyane.app/public/v1/clients/3fa85f64-5717-4562-b3fc-2c963f66afa6
Idempotent-Replayed: true

The same key with a different body gets 409 idempotency_key_reused. If the first request is still running, 409 idempotency_key_in_progress: try again a little later.

Errors

Errors follow RFC 9457 (application/problem+json). The code field is stable: it is what your integration should read. detail explains the error in French, for a human, and may change.

HTTP
HTTP/1.1 403 Forbidden
Content-Type: application/problem+json

{
  "type": "about:blank",
  "title": "Forbidden",
  "status": 403,
  "detail": "Cette clé n’a pas le droit WRITE sur le domaine opportunities.",
  "code": "insufficient_scope",
  "domain": "opportunities",
  "required": "WRITE"
}
CodeStatusMeaning
validation_failed400A field is rejected: errors lists each field (field) and the reason (message).
invalid_cursor400The cursor is not a nextCursor returned by the API.
malformed_request400The request is malformed: an unreadable JSON body, for example.
custom_field_invalid400A custom field is rejected: fields gives each one’s key, label and reason (reason: required, invalid_type, unknown_option…).
invalid_filter400A cf.<key> filter targets an unknown or archived field, or its value is unreadable.
invalid_api_key401The key is missing, unknown, revoked or expired.
insufficient_scope403The key lacks the permission: domain gives the domain, required the level.
feature_not_included403The workspace’s plan does not include the API (or, for /custom-fields, custom fields).
ip_not_allowed403The caller’s IP address is not in the list allowed by the workspace.
not_found404The resource does not exist, or belongs to another workspace.
idempotency_key_reused409This Idempotency-Key was already used with a different body.
idempotency_key_in_progress409The first request with this Idempotency-Key is still running.
plan_limit_reached409The plan’s limit is reached (the number of clients, for example).
conflict409Another write changed the resource at the same time: read it again, then retry.
workspace_suspended423The workspace is blocked: it can still be read, but nothing can be written.
rate_limited429The per-minute limit is reached: wait Retry-After seconds.
quota_exceeded429The daily quota (UTC) is reached.
pdf_not_ready503The PDF is still being generated: try again in a few seconds.

Example: create a client, then an opportunity

With a key that has write access to clients and opportunities, stored in the LYANE_API_KEY environment variable:

  1. Check the key and its permissions.

    curl
    curl "https://api.lyane.app/public/v1/me" \
      -H "Authorization: Bearer $LYANE_API_KEY"
  2. Create the client. The 201 response contains its identifier (id), and its address is in the Location header.

    curl
    curl -X POST "https://api.lyane.app/public/v1/clients" \
      -H "Authorization: Bearer $LYANE_API_KEY" \
      -H "Content-Type: application/json" \
      -H "Idempotency-Key: 5f0c6b1e-2d4a-4c8e-9b7f-1a2b3c4d5e6f" \
      -d '{
      "type": "company",
      "status": "prospect",
      "companyName": "Atelier Lumen",
      "siren": "552100554",
      "siret": "55210055400013",
      "vatNumber": "FR40552100554",
      "website": "https://atelier-lumen.fr",
      "industry": "Architecture",
      "address": {
        "line": "12 rue des Lilas",
        "line2": "Bâtiment B",
        "postalCode": "69003",
        "city": "Lyon",
        "country": "France"
      },
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    }'
    Response
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "company",
      "status": "prospect",
      "name": "Atelier Lumen",
      "companyName": "Atelier Lumen",
      "siren": "552100554",
      "siret": "55210055400013",
      "vatNumber": "FR40552100554",
      "website": "https://atelier-lumen.fr",
      "industry": "Architecture",
      "firstName": null,
      "lastName": null,
      "address": {
        "line": "12 rue des Lilas",
        "line2": "Bâtiment B",
        "postalCode": "69003",
        "city": "Lyon",
        "country": "France"
      },
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "originId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "convertedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    }
  3. Create the opportunity for this client. Without a pipeline or stage, it lands on the first open stage of the default pipeline.

    curl
    curl -X POST "https://api.lyane.app/public/v1/opportunities" \
      -H "Authorization: Bearer $LYANE_API_KEY" \
      -H "Content-Type: application/json" \
      -H "Idempotency-Key: b2e7d9a4-3c1f-4e8a-a6b5-9d0c1e2f3a4b" \
      -d '{
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "Rénovation du showroom",
      "amount": 12500,
      "expectedCloseDate": "2026-12-15",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    }'
    Response
    {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "title": "Rénovation du showroom",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "pipelineId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "stageId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "status": "open",
      "amount": 12500,
      "currency": "EUR",
      "expectedCloseDate": "2026-12-15",
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "closedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    }

The same in JavaScript, server-side (Node.js 18 or later, in an ES module). Never put an API key in the code of a web page.

JavaScript
const API = 'https://api.lyane.app/public/v1';

async function create(path, body, idempotencyKey = crypto.randomUUID()) {
  const response = await fetch(`${API}${path}`, {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.LYANE_API_KEY}`,
      'Content-Type': 'application/json',
      'Idempotency-Key': idempotencyKey,
    },
    body: JSON.stringify(body),
  });
  if (!response.ok) {
    const problem = await response.json();
    throw new Error(`${problem.status} ${problem.code}: ${problem.detail}`);
  }
  return response.json();
}

const client = await create('/clients', {
  type: 'company',
  status: 'prospect',
  companyName: 'Atelier Lumen',
  siren: '552100554',
  siret: '55210055400013',
  vatNumber: 'FR40552100554',
  website: 'https://atelier-lumen.fr',
  industry: 'Architecture',
  address: {
    line: '12 rue des Lilas',
    line2: 'Bâtiment B',
    postalCode: '69003',
    city: 'Lyon',
    country: 'France',
  },
  customFields: {
    numero_client_erp: 'C-00042',
    segment: 'grand_compte',
    date_signature_cadre: '2026-09-30',
  },
});

const opportunity = await create('/opportunities', {
  clientId: client.id,
  title: 'Rénovation du showroom',
  amount: 12500,
  expectedCloseDate: '2026-12-15',
  customFields: {
    numero_client_erp: 'C-00042',
    segment: 'grand_compte',
    date_signature_cadre: '2026-09-30',
  },
});

console.log(opportunity.id, opportunity.status);

Reference

Every route, grouped by domain, with its parameters, a request and response example, and the permission it requires. This reference is generated from the OpenAPI specification.

Key

The key in use and its workspace. No domain required.

The key and its workspace

GET/me

The workspace the key belongs to, and the key’s name, prefix, domains and expiry date. Never the key itself.

PermissionNo domain: the key is enough.

Request example
curl
curl "https://api.lyane.app/public/v1/me" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200Me

OK — The key’s workspace, and the key itself (never in clear text).

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "organization": {
    "id": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
    "name": "Atelier Lumen"
  },
  "key": {
    "id": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
    "name": "ERP Sage",
    "prefix": "lyk_ab12cd",
    "scopes": {
      "clients": "WRITE",
      "contacts": "WRITE",
      "opportunities": "WRITE",
      "tasks": "READ",
      "sales": "READ",
      "documents": "NONE"
    },
    "expiresAt": "2026-11-12T09:15:00Z"
  }
}
Response fields
  • organizationobject
  • organization.idstring (uuid)
  • organization.namestring
  • keyobject
  • key.idstring (uuid)
  • key.namestring
  • key.prefixstring
  • key.scopesobject

    The key’s level per domain: NONE, READ (list, retrieve) or WRITE (also create, update, delete). A missing domain means NONE.

  • key.scopes.clientsNONE | READ | WRITE
  • key.scopes.contactsNONE | READ | WRITE
  • key.scopes.opportunitiesNONE | READ | WRITE
  • key.scopes.tasksNONE | READ | WRITE
  • key.scopes.salesNONE | READ | WRITE

    Quotes and invoices (read-only in v1: WRITE grants nothing more).

  • key.scopes.documentsNONE | READ | WRITE

    Files on records (read-only in v1).

  • key.expiresAtstring (date-time) | null
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Clients

Companies and individuals, prospects and clients. Domain clients.

List clients

GET/clients

Sorted by last update, then by identifier. Cursor pagination: pass nextCursor as cursor to get the next page (null: that was the last one). updatedSince keeps only what changed since that instant, inclusive. Custom fields: cf.<key>=value (text: contains; select, member: equals, comma-separated values: any of them; multi-select: contains any; checkbox: true|false), cf.<key>.min and cf.<key>.max (number, amount, date YYYY-MM-DD, inclusive), cf.<key>.empty=true|false; 400 invalid_filter for an unknown key or an unreadable value.

Permissionclientsread

Parameters
  • limitintegerquery

    Items per page, from 1 to 200 (50 by default).

  • cursorstringquery

    The nextCursor of a previous response, as is (opaque). Unreadable: 400 invalid_cursor.

  • updatedSincestringquery

    ISO 8601 instant in UTC (2026-11-01T00:00:00Z): only what was created or updated since then, inclusive.

Request example
curl
curl "https://api.lyane.app/public/v1/clients?limit=50" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200ClientList

OK — A page, sorted by updatedAt then id (stable order).

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "company",
      "status": "prospect",
      "name": "Atelier Lumen",
      "companyName": "Atelier Lumen",
      "siren": "552100554",
      "siret": "55210055400013",
      "vatNumber": "FR40552100554",
      "website": "https://atelier-lumen.fr",
      "industry": "Architecture",
      "firstName": null,
      "lastName": null,
      "address": {
        "line": "12 rue des Lilas",
        "line2": "Bâtiment B",
        "postalCode": "69003",
        "city": "Lyon",
        "country": "France"
      },
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "originId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "convertedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    }
  ],
  "nextCursor": "MjAyNi0xMS0xMlQwOToxNTowMC4xMjM0NTZafDNmYTg1ZjY0LTU3MTctNDU2Mi1iM2ZjLTJjOTYzZjY2YWZhNg"
}
Response fields
  • dataClient[]

    The items of the page, at most limit.

  • nextCursorstring | null

    Pass it as cursor to get the next page; null: that was the last one.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Create a client

POST/clients

A company (companyName required) or an individual (lastName required), a prospect by default. 409 plan_limit_reached beyond the number of clients included in the plan. customFields: the workspace’s custom fields, by key (GET /custom-fields); every required field needs a value (400 custom_field_invalid, fields: key, label, reason). With an Idempotency-Key header, the same request replayed within 24 hours returns the same response (header Idempotent-Replayed: true) without creating anything again; the same key with a different body: 409 idempotency_key_reused; while the first one is still running: 409 idempotency_key_in_progress.

Permissionclientswrite

Parameters
  • Idempotency-Keystringheader

    Optional, 1 to 255 characters (a UUID, for example), unique to each creation; kept for 24 hours per API key.

Request body ClientInput

A company: companyName required (siren, siret and vatNumber are checked). An individual: lastName required.

  • typecompany | individualrequired
  • statusprospect | client
  • companyNamestring
  • sirenstring
  • siretstring
  • vatNumberstring
  • websitestring
  • industrystring
  • firstNamestring
  • lastNamestring
  • addressobject

    Postal address. An empty field means null.

  • address.linestring

    The street address.

  • address.line2string

    Additional line: building, locality, PO box.

  • address.postalCodestring
  • address.citystring
  • address.countrystring
  • ownerIdstring (uuid)

    The member in charge: the account of an active member of the workspace; absent: nobody.

  • originIdstring (uuid)

    One of the workspace’s origins; absent: not specified.

  • customFieldsCustomFieldValues

    Custom fields, by key (GET /custom-fields). Only the keys present change, null clears; on creation, every required field needs a value (400 custom_field_invalid).

Request example
curl
curl -X POST "https://api.lyane.app/public/v1/clients" \
  -H "Authorization: Bearer $LYANE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f0c6b1e-2d4a-4c8e-9b7f-1a2b3c4d5e6f" \
  -d '{
  "type": "company",
  "status": "prospect",
  "companyName": "Atelier Lumen",
  "siren": "552100554",
  "siret": "55210055400013",
  "vatNumber": "FR40552100554",
  "website": "https://atelier-lumen.fr",
  "industry": "Architecture",
  "address": {
    "line": "12 rue des Lilas",
    "line2": "Bâtiment B",
    "postalCode": "69003",
    "city": "Lyon",
    "country": "France"
  },
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}'
Response 201Client

Created: the resource, and its address in Location. — A client: a company (companyName) or an individual (lastName).

Headers:LocationIdempotent-ReplayedRateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "company",
  "status": "prospect",
  "name": "Atelier Lumen",
  "companyName": "Atelier Lumen",
  "siren": "552100554",
  "siret": "55210055400013",
  "vatNumber": "FR40552100554",
  "website": "https://atelier-lumen.fr",
  "industry": "Architecture",
  "firstName": null,
  "lastName": null,
  "address": {
    "line": "12 rue des Lilas",
    "line2": "Bâtiment B",
    "postalCode": "69003",
    "city": "Lyon",
    "country": "France"
  },
  "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "originId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "convertedAt": "2026-11-12T09:15:00Z",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z",
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}
Response fields
  • idstring (uuid)
  • typecompany | individual
  • statusprospect | client
  • namestring

    The company name, or the individual’s first and last name.

  • companyNamestring
  • sirenstring
  • siretstring
  • vatNumberstring
  • websitestring
  • industrystring
  • firstNamestring

    Individual: their first name.

  • lastNamestring

    Individual: their last name.

  • addressobject

    Postal address. An empty field means null.

  • address.linestring

    The street address.

  • address.line2string

    Additional line: building, locality, PO box.

  • address.postalCodestring
  • address.citystring
  • address.countrystring
  • ownerIdstring (uuid)

    The member in charge (their account), null: nobody.

  • originIdstring (uuid)

    The client’s origin (one of the workspace’s origins), null: not specified.

  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • convertedAtstring (date-time)

    When the prospect became a client.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • customFieldsCustomFieldValues

    The active custom fields that have a value, by key (GET /custom-fields). Absent if the plan does not include custom fields.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Retrieve a client

GET/clients/{id}

Permissionclientsread

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl "https://api.lyane.app/public/v1/clients/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200Client

OK — A client: a company (companyName) or an individual (lastName).

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "company",
  "status": "prospect",
  "name": "Atelier Lumen",
  "companyName": "Atelier Lumen",
  "siren": "552100554",
  "siret": "55210055400013",
  "vatNumber": "FR40552100554",
  "website": "https://atelier-lumen.fr",
  "industry": "Architecture",
  "firstName": null,
  "lastName": null,
  "address": {
    "line": "12 rue des Lilas",
    "line2": "Bâtiment B",
    "postalCode": "69003",
    "city": "Lyon",
    "country": "France"
  },
  "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "originId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "convertedAt": "2026-11-12T09:15:00Z",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z",
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}
Response fields
  • idstring (uuid)
  • typecompany | individual
  • statusprospect | client
  • namestring

    The company name, or the individual’s first and last name.

  • companyNamestring
  • sirenstring
  • siretstring
  • vatNumberstring
  • websitestring
  • industrystring
  • firstNamestring

    Individual: their first name.

  • lastNamestring

    Individual: their last name.

  • addressobject

    Postal address. An empty field means null.

  • address.linestring

    The street address.

  • address.line2string

    Additional line: building, locality, PO box.

  • address.postalCodestring
  • address.citystring
  • address.countrystring
  • ownerIdstring (uuid)

    The member in charge (their account), null: nobody.

  • originIdstring (uuid)

    The client’s origin (one of the workspace’s origins), null: not specified.

  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • convertedAtstring (date-time)

    When the prospect became a client.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • customFieldsCustomFieldValues

    The active custom fields that have a value, by key (GET /custom-fields). Absent if the plan does not include custom fields.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Update a client

PATCH/clients/{id}

Only the fields present change; null clears a field (address is replaced as a whole). type never changes; status goes from prospect to client, never the other way round. customFields: only the keys present change, null clears (a required field cannot be cleared).

Permissionclientswrite

Parameters
  • idstring (uuid)pathrequired
Request body ClientInput

A company: companyName required (siren, siret and vatNumber are checked). An individual: lastName required.

  • typecompany | individualrequired
  • statusprospect | client
  • companyNamestring
  • sirenstring
  • siretstring
  • vatNumberstring
  • websitestring
  • industrystring
  • firstNamestring
  • lastNamestring
  • addressobject

    Postal address. An empty field means null.

  • address.linestring

    The street address.

  • address.line2string

    Additional line: building, locality, PO box.

  • address.postalCodestring
  • address.citystring
  • address.countrystring
  • ownerIdstring (uuid)

    The member in charge: the account of an active member of the workspace; absent: nobody.

  • originIdstring (uuid)

    One of the workspace’s origins; absent: not specified.

  • customFieldsCustomFieldValues

    Custom fields, by key (GET /custom-fields). Only the keys present change, null clears; on creation, every required field needs a value (400 custom_field_invalid).

Request example
curl
curl -X PATCH "https://api.lyane.app/public/v1/clients/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $LYANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "companyName": "Atelier Lumen",
  "siren": "552100554"
}'
Response 200Client

OK — A client: a company (companyName) or an individual (lastName).

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "company",
  "status": "prospect",
  "name": "Atelier Lumen",
  "companyName": "Atelier Lumen",
  "siren": "552100554",
  "siret": "55210055400013",
  "vatNumber": "FR40552100554",
  "website": "https://atelier-lumen.fr",
  "industry": "Architecture",
  "firstName": null,
  "lastName": null,
  "address": {
    "line": "12 rue des Lilas",
    "line2": "Bâtiment B",
    "postalCode": "69003",
    "city": "Lyon",
    "country": "France"
  },
  "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "originId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "convertedAt": "2026-11-12T09:15:00Z",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z",
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}
Response fields
  • idstring (uuid)
  • typecompany | individual
  • statusprospect | client
  • namestring

    The company name, or the individual’s first and last name.

  • companyNamestring
  • sirenstring
  • siretstring
  • vatNumberstring
  • websitestring
  • industrystring
  • firstNamestring

    Individual: their first name.

  • lastNamestring

    Individual: their last name.

  • addressobject

    Postal address. An empty field means null.

  • address.linestring

    The street address.

  • address.line2string

    Additional line: building, locality, PO box.

  • address.postalCodestring
  • address.citystring
  • address.countrystring
  • ownerIdstring (uuid)

    The member in charge (their account), null: nobody.

  • originIdstring (uuid)

    The client’s origin (one of the workspace’s origins), null: not specified.

  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • convertedAtstring (date-time)

    When the prospect became a client.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • customFieldsCustomFieldValues

    The active custom fields that have a value, by key (GET /custom-fields). Absent if the plan does not include custom fields.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Delete a client

DELETE/clients/{id}

Its opportunities are deleted with it (WRITE on opportunities is then required), and so are its draft quotes and invoices (WRITE on sales). deleteContacts=true: its contacts are deleted with it; otherwise they remain, without a client.

Permissionclientswrite

Parameters
  • idstring (uuid)pathrequired
  • deleteContactsbooleanquerydefault: false
Request example
curl
curl -X DELETE "https://api.lyane.app/public/v1/clients/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 204

No Content

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

No response body.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Contacts

Contact records shared with the team. Domain contacts.

List contacts

GET/contacts

clientId keeps only that client’s contacts. Cursor pagination: pass nextCursor as cursor to get the next page (null: that was the last one). updatedSince keeps only what changed since that instant, inclusive. Custom fields: cf.<key>=value (text: contains; select, member: equals, comma-separated values: any of them; multi-select: contains any; checkbox: true|false), cf.<key>.min and cf.<key>.max (number, amount, date YYYY-MM-DD, inclusive), cf.<key>.empty=true|false; 400 invalid_filter for an unknown key or an unreadable value.

Permissioncontactsread

Parameters
  • clientIdstring (uuid)query
  • limitintegerquery

    Items per page, from 1 to 200 (50 by default).

  • cursorstringquery

    The nextCursor of a previous response, as is (opaque). Unreadable: 400 invalid_cursor.

  • updatedSincestringquery

    ISO 8601 instant in UTC (2026-11-01T00:00:00Z): only what was created or updated since then, inclusive.

Request example
curl
curl "https://api.lyane.app/public/v1/contacts?limit=50" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200ContactList

OK — A page, sorted by updatedAt then id (stable order).

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "data": [
    {
      "id": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "firstName": "Camille",
      "lastName": "Martin",
      "email": "camille.martin@atelier-lumen.fr",
      "phone": "+33 4 72 00 00 00",
      "jobTitle": "Directrice administrative",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    }
  ],
  "nextCursor": "MjAyNi0xMS0xMlQwOToxNTowMC4xMjM0NTZafDNmYTg1ZjY0LTU3MTctNDU2Mi1iM2ZjLTJjOTYzZjY2YWZhNg"
}
Response fields
  • dataContact[]

    The items of the page, at most limit.

  • nextCursorstring | null

    Pass it as cursor to get the next page; null: that was the last one.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Create a contact

POST/contacts

A record shared with the team; clientId links it to a client of the workspace. customFields: the workspace’s custom fields, by key (GET /custom-fields); every required field needs a value (400 custom_field_invalid, fields: key, label, reason). With an Idempotency-Key header, the same request replayed within 24 hours returns the same response (header Idempotent-Replayed: true) without creating anything again; the same key with a different body: 409 idempotency_key_reused; while the first one is still running: 409 idempotency_key_in_progress.

Permissioncontactswrite

Parameters
  • Idempotency-Keystringheader

    Optional, 1 to 255 characters (a UUID, for example), unique to each creation; kept for 24 hours per API key.

Request body ContactInput

A contact record, always shared with the team.

  • firstNamestring
  • lastNamestringrequired
  • emailstring (email)
  • phonestring
  • jobTitlestring
  • clientIdstring (uuid)

    A client of the workspace to link it to; absent: none.

  • customFieldsCustomFieldValues

    Custom fields, by key (GET /custom-fields). Only the keys present change, null clears; on creation, every required field needs a value (400 custom_field_invalid).

Request example
curl
curl -X POST "https://api.lyane.app/public/v1/contacts" \
  -H "Authorization: Bearer $LYANE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f0c6b1e-2d4a-4c8e-9b7f-1a2b3c4d5e6f" \
  -d '{
  "firstName": "Camille",
  "lastName": "Martin",
  "email": "camille.martin@atelier-lumen.fr",
  "phone": "+33 4 72 00 00 00",
  "jobTitle": "Directrice administrative",
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}'
Response 201Contact

Created: the resource, and its address in Location. — A contact record shared with the team.

Headers:LocationIdempotent-ReplayedRateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
  "firstName": "Camille",
  "lastName": "Martin",
  "email": "camille.martin@atelier-lumen.fr",
  "phone": "+33 4 72 00 00 00",
  "jobTitle": "Directrice administrative",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z",
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}
Response fields
  • idstring (uuid)
  • firstNamestring
  • lastNamestring
  • emailstring
  • phonestring
  • jobTitlestring
  • clientIdstring (uuid)

    The client the contact is linked to, null: none.

  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • customFieldsCustomFieldValues

    The active custom fields that have a value, by key (GET /custom-fields). Absent if the plan does not include custom fields.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Retrieve a contact

GET/contacts/{id}

Permissioncontactsread

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl "https://api.lyane.app/public/v1/contacts/6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200Contact

OK — A contact record shared with the team.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
  "firstName": "Camille",
  "lastName": "Martin",
  "email": "camille.martin@atelier-lumen.fr",
  "phone": "+33 4 72 00 00 00",
  "jobTitle": "Directrice administrative",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z",
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}
Response fields
  • idstring (uuid)
  • firstNamestring
  • lastNamestring
  • emailstring
  • phonestring
  • jobTitlestring
  • clientIdstring (uuid)

    The client the contact is linked to, null: none.

  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • customFieldsCustomFieldValues

    The active custom fields that have a value, by key (GET /custom-fields). Absent if the plan does not include custom fields.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Update a contact

PATCH/contacts/{id}

Only the fields present change; null clears a field (clientId: the contact is no longer linked to any client). customFields: only the keys present change, null clears (a required field cannot be cleared).

Permissioncontactswrite

Parameters
  • idstring (uuid)pathrequired
Request body ContactInput

A contact record, always shared with the team.

  • firstNamestring
  • lastNamestringrequired
  • emailstring (email)
  • phonestring
  • jobTitlestring
  • clientIdstring (uuid)

    A client of the workspace to link it to; absent: none.

  • customFieldsCustomFieldValues

    Custom fields, by key (GET /custom-fields). Only the keys present change, null clears; on creation, every required field needs a value (400 custom_field_invalid).

Request example
curl
curl -X PATCH "https://api.lyane.app/public/v1/contacts/6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10" \
  -H "Authorization: Bearer $LYANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "firstName": "Camille",
  "lastName": "Martin"
}'
Response 200Contact

OK — A contact record shared with the team.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
  "firstName": "Camille",
  "lastName": "Martin",
  "email": "camille.martin@atelier-lumen.fr",
  "phone": "+33 4 72 00 00 00",
  "jobTitle": "Directrice administrative",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z",
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}
Response fields
  • idstring (uuid)
  • firstNamestring
  • lastNamestring
  • emailstring
  • phonestring
  • jobTitlestring
  • clientIdstring (uuid)

    The client the contact is linked to, null: none.

  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • customFieldsCustomFieldValues

    The active custom fields that have a value, by key (GET /custom-fields). Absent if the plan does not include custom fields.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Delete a contact

DELETE/contacts/{id}

Permissioncontactswrite

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl -X DELETE "https://api.lyane.app/public/v1/contacts/6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 204

No Content

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

No response body.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Opportunities

Deals in progress, won or lost, and sales pipelines. Domain opportunities.

List opportunities

GET/opportunities

clientId and stageId filter. Cursor pagination: pass nextCursor as cursor to get the next page (null: that was the last one). updatedSince keeps only what changed since that instant, inclusive. Custom fields: cf.<key>=value (text: contains; select, member: equals, comma-separated values: any of them; multi-select: contains any; checkbox: true|false), cf.<key>.min and cf.<key>.max (number, amount, date YYYY-MM-DD, inclusive), cf.<key>.empty=true|false; 400 invalid_filter for an unknown key or an unreadable value.

Permissionopportunitiesread

Parameters
  • clientIdstring (uuid)query
  • stageIdstring (uuid)query
  • limitintegerquery

    Items per page, from 1 to 200 (50 by default).

  • cursorstringquery

    The nextCursor of a previous response, as is (opaque). Unreadable: 400 invalid_cursor.

  • updatedSincestringquery

    ISO 8601 instant in UTC (2026-11-01T00:00:00Z): only what was created or updated since then, inclusive.

Request example
curl
curl "https://api.lyane.app/public/v1/opportunities?limit=50" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200OpportunityList

OK — A page, sorted by updatedAt then id (stable order).

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "data": [
    {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "title": "Rénovation du showroom",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "pipelineId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "stageId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "status": "open",
      "amount": 12500,
      "currency": "EUR",
      "expectedCloseDate": "2026-12-15",
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "closedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    }
  ],
  "nextCursor": "MjAyNi0xMS0xMlQwOToxNTowMC4xMjM0NTZafDNmYTg1ZjY0LTU3MTctNDU2Mi1iM2ZjLTJjOTYzZjY2YWZhNg"
}
Response fields
  • dataOpportunity[]

    The items of the page, at most limit.

  • nextCursorstring | null

    Pass it as cursor to get the next page; null: that was the last one.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Create an opportunity

POST/opportunities

Without stageId or pipelineId: the first open stage of the default pipeline. customFields: the workspace’s custom fields, by key (GET /custom-fields); every required field needs a value (400 custom_field_invalid, fields: key, label, reason). With an Idempotency-Key header, the same request replayed within 24 hours returns the same response (header Idempotent-Replayed: true) without creating anything again; the same key with a different body: 409 idempotency_key_reused; while the first one is still running: 409 idempotency_key_in_progress.

Permissionopportunitieswrite

Parameters
  • Idempotency-Keystringheader

    Optional, 1 to 255 characters (a UUID, for example), unique to each creation; kept for 24 hours per API key.

Request body OpportunityInput

Without stageId or pipelineId: the first open stage of the default pipeline. With pipelineId alone: the first open stage of that pipeline.

  • clientIdstring (uuid)required

    A client of the workspace, prospect or client.

  • contactIdstring (uuid)

    A shared contact of the workspace.

  • titlestringrequired
  • amountnumber
  • pipelineIdstring (uuid)

    A pipeline of the workspace (GET /pipelines).

  • stageIdstring (uuid)

    A stage of the workspace (GET /pipelines); won or lost, the deal is closed.

  • expectedCloseDatestring (date)
  • ownerIdstring (uuid)

    The member in charge: the account of an active member of the workspace; absent: nobody.

  • customFieldsCustomFieldValues

    Custom fields, by key (GET /custom-fields). Only the keys present change, null clears; on creation, every required field needs a value (400 custom_field_invalid).

Request example
curl
curl -X POST "https://api.lyane.app/public/v1/opportunities" \
  -H "Authorization: Bearer $LYANE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f0c6b1e-2d4a-4c8e-9b7f-1a2b3c4d5e6f" \
  -d '{
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "title": "Rénovation du showroom",
  "amount": 12500,
  "expectedCloseDate": "2026-12-15",
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}'
Response 201Opportunity

Created: the resource, and its address in Location. — A deal, at a stage of a sales pipeline.

Headers:LocationIdempotent-ReplayedRateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
  "title": "Rénovation du showroom",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
  "pipelineId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "stageId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "status": "open",
  "amount": 12500,
  "currency": "EUR",
  "expectedCloseDate": "2026-12-15",
  "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "closedAt": "2026-11-12T09:15:00Z",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z",
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}
Response fields
  • idstring (uuid)
  • titlestring
  • clientIdstring (uuid)
  • contactIdstring (uuid)

    The point of contact: a shared contact of the workspace, null: none.

  • pipelineIdstring (uuid)
  • stageIdstring (uuid)
  • statusopen | won | lost

    The status of its stage.

  • amountnumber

    The amount, in the workspace’s currency.

  • currencystring

    The workspace’s currency (ISO 4217).

  • expectedCloseDatestring (date)
  • ownerIdstring (uuid)

    The member in charge (their account), null: nobody.

  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • closedAtstring (date-time)

    When it was won or lost.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • customFieldsCustomFieldValues

    The active custom fields that have a value, by key (GET /custom-fields). Absent if the plan does not include custom fields.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Retrieve an opportunity

GET/opportunities/{id}

Permissionopportunitiesread

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl "https://api.lyane.app/public/v1/opportunities/9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200Opportunity

OK — A deal, at a stage of a sales pipeline.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
  "title": "Rénovation du showroom",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
  "pipelineId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "stageId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "status": "open",
  "amount": 12500,
  "currency": "EUR",
  "expectedCloseDate": "2026-12-15",
  "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "closedAt": "2026-11-12T09:15:00Z",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z",
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}
Response fields
  • idstring (uuid)
  • titlestring
  • clientIdstring (uuid)
  • contactIdstring (uuid)

    The point of contact: a shared contact of the workspace, null: none.

  • pipelineIdstring (uuid)
  • stageIdstring (uuid)
  • statusopen | won | lost

    The status of its stage.

  • amountnumber

    The amount, in the workspace’s currency.

  • currencystring

    The workspace’s currency (ISO 4217).

  • expectedCloseDatestring (date)
  • ownerIdstring (uuid)

    The member in charge (their account), null: nobody.

  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • closedAtstring (date-time)

    When it was won or lost.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • customFieldsCustomFieldValues

    The active custom fields that have a value, by key (GET /custom-fields). Absent if the plan does not include custom fields.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Update an opportunity

PATCH/opportunities/{id}

Only the fields present change; null clears a field. stageId moves it (won or lost: closed; won: its prospect becomes a client); pipelineId alone: the first open stage of that pipeline.

Permissionopportunitieswrite

Parameters
  • idstring (uuid)pathrequired
Request body OpportunityInput

Without stageId or pipelineId: the first open stage of the default pipeline. With pipelineId alone: the first open stage of that pipeline.

  • clientIdstring (uuid)required

    A client of the workspace, prospect or client.

  • contactIdstring (uuid)

    A shared contact of the workspace.

  • titlestringrequired
  • amountnumber
  • pipelineIdstring (uuid)

    A pipeline of the workspace (GET /pipelines).

  • stageIdstring (uuid)

    A stage of the workspace (GET /pipelines); won or lost, the deal is closed.

  • expectedCloseDatestring (date)
  • ownerIdstring (uuid)

    The member in charge: the account of an active member of the workspace; absent: nobody.

  • customFieldsCustomFieldValues

    Custom fields, by key (GET /custom-fields). Only the keys present change, null clears; on creation, every required field needs a value (400 custom_field_invalid).

Request example
curl
curl -X PATCH "https://api.lyane.app/public/v1/opportunities/9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d" \
  -H "Authorization: Bearer $LYANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Rénovation du showroom",
  "amount": 12500
}'
Response 200Opportunity

OK — A deal, at a stage of a sales pipeline.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
  "title": "Rénovation du showroom",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
  "pipelineId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "stageId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "status": "open",
  "amount": 12500,
  "currency": "EUR",
  "expectedCloseDate": "2026-12-15",
  "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "closedAt": "2026-11-12T09:15:00Z",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z",
  "customFields": {
    "numero_client_erp": "C-00042",
    "segment": "grand_compte",
    "date_signature_cadre": "2026-09-30"
  }
}
Response fields
  • idstring (uuid)
  • titlestring
  • clientIdstring (uuid)
  • contactIdstring (uuid)

    The point of contact: a shared contact of the workspace, null: none.

  • pipelineIdstring (uuid)
  • stageIdstring (uuid)
  • statusopen | won | lost

    The status of its stage.

  • amountnumber

    The amount, in the workspace’s currency.

  • currencystring

    The workspace’s currency (ISO 4217).

  • expectedCloseDatestring (date)
  • ownerIdstring (uuid)

    The member in charge (their account), null: nobody.

  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • closedAtstring (date-time)

    When it was won or lost.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • customFieldsCustomFieldValues

    The active custom fields that have a value, by key (GET /custom-fields). Absent if the plan does not include custom fields.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Delete an opportunity

DELETE/opportunities/{id}

Permissionopportunitieswrite

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl -X DELETE "https://api.lyane.app/public/v1/opportunities/0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 204

No Content

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

No response body.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

List pipelines and their stages

GET/pipelines

The workspace’s sales pipelines, in order, with their stages: what you need to choose stageId and pipelineId.

Permissionopportunitiesread

Request example
curl
curl "https://api.lyane.app/public/v1/pipelines" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200PipelineList

OK

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "data": [
    {
      "id": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "name": "Ventes",
      "isDefault": false,
      "stages": [
        {
          "id": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
          "name": "Proposition envoyée",
          "status": "open",
          "position": 0
        }
      ]
    }
  ]
}
Response fields
  • dataPipeline[]
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Tasks

Tasks and follow-ups. Domain tasks.

List tasks

GET/tasks

opportunityId, clientId and done filter. Cursor pagination: pass nextCursor as cursor to get the next page (null: that was the last one). updatedSince keeps only what changed since that instant, inclusive.

Permissiontasksread

Parameters
  • opportunityIdstring (uuid)query
  • clientIdstring (uuid)query
  • donebooleanquery

    true: completed tasks; false: tasks still to do; absent: all of them.

  • limitintegerquery

    Items per page, from 1 to 200 (50 by default).

  • cursorstringquery

    The nextCursor of a previous response, as is (opaque). Unreadable: 400 invalid_cursor.

  • updatedSincestringquery

    ISO 8601 instant in UTC (2026-11-01T00:00:00Z): only what was created or updated since then, inclusive.

Request example
curl
curl "https://api.lyane.app/public/v1/tasks?limit=50" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200TaskList

OK — A page, sorted by updatedAt then id (stable order).

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "data": [
    {
      "id": "1d2c3b4a-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "title": "Rappeler pour le devis",
      "description": null,
      "dueDate": "2026-11-20",
      "done": false,
      "completedAt": "2026-11-12T09:15:00Z",
      "assigneeId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "assigneeGroupId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "recurrence": "none",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z"
    }
  ],
  "nextCursor": "MjAyNi0xMS0xMlQwOToxNTowMC4xMjM0NTZafDNmYTg1ZjY0LTU3MTctNDU2Mi1iM2ZjLTJjOTYzZjY2YWZhNg"
}
Response fields
  • dataTask[]

    The items of the page, at most limit.

  • nextCursorstring | null

    Pass it as cursor to get the next page; null: that was the last one.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Create a task

POST/tasks

With an opportunity and no client: the opportunity’s client. The assignee is notified as in the app. With an Idempotency-Key header, the same request replayed within 24 hours returns the same response (header Idempotent-Replayed: true) without creating anything again; the same key with a different body: 409 idempotency_key_reused; while the first one is still running: 409 idempotency_key_in_progress.

Permissiontaskswrite

Parameters
  • Idempotency-Keystringheader

    Optional, 1 to 255 characters (a UUID, for example), unique to each creation; kept for 24 hours per API key.

Request body TaskInput

A task. With an opportunity and no client: the opportunity’s client.

  • titlestringrequired
  • descriptionstring
  • dueDatestring (date)
  • assigneeIdstring (uuid)

    The account of an active member of the workspace.

  • assigneeGroupIdstring (uuid)

    Or a group of the workspace (plan with groups), never together with assigneeId.

  • contactIdstring (uuid)

    A shared contact of the workspace.

  • clientIdstring (uuid)
  • opportunityIdstring (uuid)
  • recurrencenone | daily | weekly | monthly | yearly

    A recurring task needs a due date.

  • doneboolean

    PATCH only: true completes it (a recurring task creates the next one), false reopens it.

Request example
curl
curl -X POST "https://api.lyane.app/public/v1/tasks" \
  -H "Authorization: Bearer $LYANE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f0c6b1e-2d4a-4c8e-9b7f-1a2b3c4d5e6f" \
  -d '{
  "title": "Rappeler pour le devis",
  "dueDate": "2026-11-20"
}'
Response 201Task

Created: the resource, and its address in Location. — A task or a follow-up.

Headers:LocationIdempotent-ReplayedRateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "1d2c3b4a-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "title": "Rappeler pour le devis",
  "description": null,
  "dueDate": "2026-11-20",
  "done": false,
  "completedAt": "2026-11-12T09:15:00Z",
  "assigneeId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "assigneeGroupId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
  "recurrence": "none",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z"
}
Response fields
  • idstring (uuid)
  • titlestring
  • descriptionstring
  • dueDatestring (date)

    The due day, without a time.

  • doneboolean

    Completed.

  • completedAtstring (date-time)
  • assigneeIdstring (uuid)

    The member who has to do it (their account).

  • assigneeGroupIdstring (uuid)

    Or the group of the workspace it is assigned to.

  • contactIdstring (uuid)
  • clientIdstring (uuid)
  • opportunityIdstring (uuid)
  • recurrencenone | daily | weekly | monthly | yearly
  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Retrieve a task

GET/tasks/{id}

Permissiontasksread

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl "https://api.lyane.app/public/v1/tasks/1d2c3b4a-5e6f-4a7b-8c9d-0e1f2a3b4c5d" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200Task

OK — A task or a follow-up.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "1d2c3b4a-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "title": "Rappeler pour le devis",
  "description": null,
  "dueDate": "2026-11-20",
  "done": false,
  "completedAt": "2026-11-12T09:15:00Z",
  "assigneeId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "assigneeGroupId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
  "recurrence": "none",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z"
}
Response fields
  • idstring (uuid)
  • titlestring
  • descriptionstring
  • dueDatestring (date)

    The due day, without a time.

  • doneboolean

    Completed.

  • completedAtstring (date-time)
  • assigneeIdstring (uuid)

    The member who has to do it (their account).

  • assigneeGroupIdstring (uuid)

    Or the group of the workspace it is assigned to.

  • contactIdstring (uuid)
  • clientIdstring (uuid)
  • opportunityIdstring (uuid)
  • recurrencenone | daily | weekly | monthly | yearly
  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Update a task

PATCH/tasks/{id}

Only the fields present change; null clears a field. done: true completes it (a recurring task creates the next one), done: false reopens it.

Permissiontaskswrite

Parameters
  • idstring (uuid)pathrequired
Request body TaskInput

A task. With an opportunity and no client: the opportunity’s client.

  • titlestringrequired
  • descriptionstring
  • dueDatestring (date)
  • assigneeIdstring (uuid)

    The account of an active member of the workspace.

  • assigneeGroupIdstring (uuid)

    Or a group of the workspace (plan with groups), never together with assigneeId.

  • contactIdstring (uuid)

    A shared contact of the workspace.

  • clientIdstring (uuid)
  • opportunityIdstring (uuid)
  • recurrencenone | daily | weekly | monthly | yearly

    A recurring task needs a due date.

  • doneboolean

    PATCH only: true completes it (a recurring task creates the next one), false reopens it.

Request example
curl
curl -X PATCH "https://api.lyane.app/public/v1/tasks/1d2c3b4a-5e6f-4a7b-8c9d-0e1f2a3b4c5d" \
  -H "Authorization: Bearer $LYANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Rappeler pour le devis",
  "dueDate": "2026-11-20"
}'
Response 200Task

OK — A task or a follow-up.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "1d2c3b4a-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "title": "Rappeler pour le devis",
  "description": null,
  "dueDate": "2026-11-20",
  "done": false,
  "completedAt": "2026-11-12T09:15:00Z",
  "assigneeId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "assigneeGroupId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
  "recurrence": "none",
  "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z"
}
Response fields
  • idstring (uuid)
  • titlestring
  • descriptionstring
  • dueDatestring (date)

    The due day, without a time.

  • doneboolean

    Completed.

  • completedAtstring (date-time)
  • assigneeIdstring (uuid)

    The member who has to do it (their account).

  • assigneeGroupIdstring (uuid)

    Or the group of the workspace it is assigned to.

  • contactIdstring (uuid)
  • clientIdstring (uuid)
  • opportunityIdstring (uuid)
  • recurrencenone | daily | weekly | monthly | yearly
  • createdBystring (uuid)

    The account that created it: a member, or the workspace’s “API” service account.

  • createdAtstring (date-time)
  • updatedAtstring (date-time)
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Delete a task

DELETE/tasks/{id}

Permissiontaskswrite

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl -X DELETE "https://api.lyane.app/public/v1/tasks/1d2c3b4a-5e6f-4a7b-8c9d-0e1f2a3b4c5d" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 204

No Content

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

No response body.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 409Conflict: idempotency_key_reused, idempotency_key_in_progress, plan_limit_reached (plan limit), conflict (concurrent write).
  • 423workspace_suspended: the workspace is blocked; it can still be read.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Sales

Quotes and invoices, read-only. Domain sales.

List invoices

GET/invoices

Invoices, deposit invoices and credit notes (type). clientId filters. Cursor pagination: pass nextCursor as cursor to get the next page (null: that was the last one). updatedSince keeps only what changed since that instant, inclusive.

Permissionsalesread

Parameters
  • clientIdstring (uuid)query
  • limitintegerquery

    Items per page, from 1 to 200 (50 by default).

  • cursorstringquery

    The nextCursor of a previous response, as is (opaque). Unreadable: 400 invalid_cursor.

  • updatedSincestringquery

    ISO 8601 instant in UTC (2026-11-01T00:00:00Z): only what was created or updated since then, inclusive.

Request example
curl
curl "https://api.lyane.app/public/v1/invoices?limit=50" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200SalesDocumentList

OK — A page, sorted by updatedAt then id (stable order).

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "data": [
    {
      "id": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "type": "invoice",
      "number": "FA-2026-042",
      "status": "sent",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "clientName": "Atelier Lumen",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "reference": null,
      "issueDate": "2026-11-12",
      "validUntil": "2026-11-12",
      "dueDate": "2026-11-12",
      "currency": "EUR",
      "totalExclTaxCents": 1250000,
      "totalInclTaxCents": 1500000,
      "paidCents": 0,
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z"
    }
  ],
  "nextCursor": "MjAyNi0xMS0xMlQwOToxNTowMC4xMjM0NTZafDNmYTg1ZjY0LTU3MTctNDU2Mi1iM2ZjLTJjOTYzZjY2YWZhNg"
}
Response fields
  • dataSalesDocument[]

    The items of the page, at most limit.

  • nextCursorstring | null

    Pass it as cursor to get the next page; null: that was the last one.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Retrieve an invoice

GET/invoices/{id}

Permissionsalesread

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl "https://api.lyane.app/public/v1/invoices/0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200SalesDocument

OK — A quote (quote) or an invoice (invoice, deposit, credit_note). Amounts in cents.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "type": "invoice",
  "number": "FA-2026-042",
  "status": "sent",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientName": "Atelier Lumen",
  "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
  "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
  "reference": null,
  "issueDate": "2026-11-12",
  "validUntil": "2026-11-12",
  "dueDate": "2026-11-12",
  "currency": "EUR",
  "totalExclTaxCents": 1250000,
  "totalInclTaxCents": 1500000,
  "paidCents": 0,
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z"
}
Response fields
  • idstring (uuid)
  • typequote | invoice | deposit | credit_note
  • numberstring

    The number, null for a draft.

  • statusstring
  • clientIdstring (uuid)
  • clientNamestring
  • contactIdstring (uuid)
  • opportunityIdstring (uuid)
  • referencestring
  • issueDatestring (date)
  • validUntilstring (date)

    Quote: its expiry date.

  • dueDatestring (date)

    Invoice: its payment due date.

  • currencystring
  • totalExclTaxCentsinteger
  • totalInclTaxCentsinteger
  • paidCentsinteger
  • createdAtstring (date-time)
  • updatedAtstring (date-time)
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Invoice PDF

GET/invoices/{id}/pdf

A presigned link, valid for a few minutes, to the PDF: the frozen Factur-X file for an issued invoice, an up-to-date preview (BROUILLON watermark) for a draft. 503 pdf_not_ready while it is still being generated.

Permissionsalesread

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl "https://api.lyane.app/public/v1/invoices/0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b/pdf" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200FileLink

OK — A presigned link, valid for a few minutes: a GET without a key downloads the file. Do not send the Authorization header to it.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "url": "https://s3.lyane.app/…",
  "expiresAt": "2026-11-12T09:15:00Z"
}
Response fields
  • urlstring
  • expiresAtstring (date-time)
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

List quotes

GET/quotes

clientId filters. Cursor pagination: pass nextCursor as cursor to get the next page (null: that was the last one). updatedSince keeps only what changed since that instant, inclusive.

Permissionsalesread

Parameters
  • clientIdstring (uuid)query
  • limitintegerquery

    Items per page, from 1 to 200 (50 by default).

  • cursorstringquery

    The nextCursor of a previous response, as is (opaque). Unreadable: 400 invalid_cursor.

  • updatedSincestringquery

    ISO 8601 instant in UTC (2026-11-01T00:00:00Z): only what was created or updated since then, inclusive.

Request example
curl
curl "https://api.lyane.app/public/v1/quotes?limit=50" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200SalesDocumentList

OK — A page, sorted by updatedAt then id (stable order).

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "data": [
    {
      "id": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "type": "invoice",
      "number": "FA-2026-042",
      "status": "sent",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "clientName": "Atelier Lumen",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "reference": null,
      "issueDate": "2026-11-12",
      "validUntil": "2026-11-12",
      "dueDate": "2026-11-12",
      "currency": "EUR",
      "totalExclTaxCents": 1250000,
      "totalInclTaxCents": 1500000,
      "paidCents": 0,
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z"
    }
  ],
  "nextCursor": "MjAyNi0xMS0xMlQwOToxNTowMC4xMjM0NTZafDNmYTg1ZjY0LTU3MTctNDU2Mi1iM2ZjLTJjOTYzZjY2YWZhNg"
}
Response fields
  • dataSalesDocument[]

    The items of the page, at most limit.

  • nextCursorstring | null

    Pass it as cursor to get the next page; null: that was the last one.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Retrieve a quote

GET/quotes/{id}

Permissionsalesread

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl "https://api.lyane.app/public/v1/quotes/0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200SalesDocument

OK — A quote (quote) or an invoice (invoice, deposit, credit_note). Amounts in cents.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "type": "invoice",
  "number": "FA-2026-042",
  "status": "sent",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientName": "Atelier Lumen",
  "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
  "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
  "reference": null,
  "issueDate": "2026-11-12",
  "validUntil": "2026-11-12",
  "dueDate": "2026-11-12",
  "currency": "EUR",
  "totalExclTaxCents": 1250000,
  "totalInclTaxCents": 1500000,
  "paidCents": 0,
  "createdAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z"
}
Response fields
  • idstring (uuid)
  • typequote | invoice | deposit | credit_note
  • numberstring

    The number, null for a draft.

  • statusstring
  • clientIdstring (uuid)
  • clientNamestring
  • contactIdstring (uuid)
  • opportunityIdstring (uuid)
  • referencestring
  • issueDatestring (date)
  • validUntilstring (date)

    Quote: its expiry date.

  • dueDatestring (date)

    Invoice: its payment due date.

  • currencystring
  • totalExclTaxCentsinteger
  • totalInclTaxCentsinteger
  • paidCentsinteger
  • createdAtstring (date-time)
  • updatedAtstring (date-time)
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Quote PDF

GET/quotes/{id}/pdf

A presigned link, valid for a few minutes, to the PDF: frozen for an issued quote, an up-to-date preview (BROUILLON watermark) for a draft. 503 pdf_not_ready while it is still being generated.

Permissionsalesread

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl "https://api.lyane.app/public/v1/quotes/0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b/pdf" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200FileLink

OK — A presigned link, valid for a few minutes: a GET without a key downloads the file. Do not send the Authorization header to it.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "url": "https://s3.lyane.app/…",
  "expiresAt": "2026-11-12T09:15:00Z"
}
Response fields
  • urlstring
  • expiresAtstring (date-time)
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Documents

Files stored on client records, read-only. Domain documents.

List documents

GET/documents

clientId filters. Cursor pagination: pass nextCursor as cursor to get the next page (null: that was the last one). updatedSince keeps only what changed since that instant, inclusive.

Permissiondocumentsread

Parameters
  • clientIdstring (uuid)query
  • limitintegerquery

    Items per page, from 1 to 200 (50 by default).

  • cursorstringquery

    The nextCursor of a previous response, as is (opaque). Unreadable: 400 invalid_cursor.

  • updatedSincestringquery

    ISO 8601 instant in UTC (2026-11-01T00:00:00Z): only what was created or updated since then, inclusive.

Request example
curl
curl "https://api.lyane.app/public/v1/documents?limit=50" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200DocumentList

OK — A page, sorted by updatedAt then id (stable order).

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "data": [
    {
      "id": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "name": "Contrat signé.pdf",
      "contentType": "application/pdf",
      "sizeBytes": 248311,
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "salesDocumentId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "uploadedBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "uploadedAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z"
    }
  ],
  "nextCursor": "MjAyNi0xMS0xMlQwOToxNTowMC4xMjM0NTZafDNmYTg1ZjY0LTU3MTctNDU2Mi1iM2ZjLTJjOTYzZjY2YWZhNg"
}
Response fields
  • dataDocument[]

    The items of the page, at most limit.

  • nextCursorstring | null

    Pass it as cursor to get the next page; null: that was the last one.

Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Retrieve a document

GET/documents/{id}

Permissiondocumentsread

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl "https://api.lyane.app/public/v1/documents/0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200Document

OK — A file stored on a client record.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "id": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "name": "Contrat signé.pdf",
  "contentType": "application/pdf",
  "sizeBytes": 248311,
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
  "salesDocumentId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "uploadedBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
  "uploadedAt": "2026-11-12T09:15:00Z",
  "updatedAt": "2026-11-12T09:15:00Z"
}
Response fields
  • idstring (uuid)
  • namestring
  • contentTypestring
  • sizeBytesinteger
  • clientIdstring (uuid)
  • opportunityIdstring (uuid)
  • salesDocumentIdstring (uuid)

    The frozen PDF of a quote or an invoice (null for any other file).

  • uploadedBystring (uuid)

    The account that uploaded it.

  • uploadedAtstring (date-time)
  • updatedAtstring (date-time)
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Download a document

GET/documents/{id}/content

A presigned link, valid for a few minutes, to the file, under the document’s name.

Permissiondocumentsread

Parameters
  • idstring (uuid)pathrequired
Request example
curl
curl "https://api.lyane.app/public/v1/documents/0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b/content" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200FileLink

OK — A presigned link, valid for a few minutes: a GET without a key downloads the file. Do not send the Authorization header to it.

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "url": "https://s3.lyane.app/…",
  "expiresAt": "2026-11-12T09:15:00Z"
}
Response fields
  • urlstring
  • expiresAtstring (date-time)
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 404not_found: not found, or belongs to another workspace.
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Custom fields

Custom fields on clients, contacts and opportunities (read access to the domain of each record type).

List custom fields

GET/custom-fields

The active fields, in order, with their active options. objectType (client, contact or opportunity) requires read access to its domain; without it: the record types the key can read. 403 feature_not_included if the plan does not include custom fields.

Permissionclients | contacts | opportunitiesread

Parameters
  • objectTypeclient | contact | opportunityquery
Request example
curl
curl "https://api.lyane.app/public/v1/custom-fields" \
  -H "Authorization: Bearer $LYANE_API_KEY"
Response 200CustomFieldList

OK

Headers:RateLimit-LimitRateLimit-RemainingRateLimit-Reset

Response example
{
  "data": [
    {
      "objectType": "client",
      "key": "numero_client_erp",
      "label": "Numéro client ERP",
      "type": "TEXT",
      "required": false,
      "help": null,
      "options": [
        {
          "key": "grand_compte",
          "label": "Grand compte"
        }
      ]
    }
  ]
}
Response fields
  • dataCustomField[]
Possible errors
  • 400Request rejected: validation_failed (errors: [{field, message}]), invalid_cursor, malformed_request, custom_field_invalid (fields: [{key, label, reason}]), invalid_filter (cf.<key>).
  • 401invalid_api_key: key missing, unknown, revoked or expired (WWW-Authenticate: Bearer).
  • 403insufficient_scope (domain, required), feature_not_included (plan without the API), ip_not_allowed (address outside the workspace’s list).
  • 429rate_limited (minute) or quota_exceeded (UTC day).

Webhooks

Webhooks notify your tools as soon as something happens in Lyane: a client created, an opportunity won, an invoice paid. Instead of polling the API at regular intervals, your server receives a JSON POST request for every event it subscribes to.

They are included in the Enterprise plan, like the public API.

Create a subscription

A workspace administrator opens the app, then Settings → Integrations → Webhooks. They enter the URL that will receive the events and choose which events to send. A workspace can have up to 10 subscriptions.

The URL must use HTTPS and be reachable from the Internet: a private or internal address (local network, localhost, reserved address) is refused. During development, expose your local server through an HTTPS tunnel.

When the subscription is created, the app shows its secret (whsec_…): it is used to verify the signature of every request. Keep it in a secrets manager. The “Send a test” button immediately sends the webhook.test event to the URL.

To change the secret, start a rotation: for 24 hours, every request is signed with both the new and the old secret, giving you time to deploy the new one.

Request body

Every event arrives in the same JSON envelope, whatever its type:

FieldContent
idThe event identifier (evt_…). The same for all its attempts and replays: it is the deduplication key.
typeThe event type: client.created, invoice.paid…
createdAtWhen the event happened, in ISO 8601 (UTC).
organizationIdThe Lyane workspace where it happened.
dataThe content of the event.
data.objectThe resource concerned, in the same representation as the public API (the one of GET /clients/{id} for a client, for example).
data.previousOptional, on an update: the changed fields, with their previous values.
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "opportunity.stage_changed",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "title": "Rénovation du showroom",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "pipelineId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "stageId": "5d0b1a2c-3e4f-4a5b-8c6d-7e8f9a0b1c2d",
      "status": "open",
      "amount": 12500,
      "currency": "EUR",
      "expectedCloseDate": "2026-12-15",
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "closedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    },
    "previous": {
      "stageId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "status": "open"
    }
  }
}

For a deletion (*.deleted), data.object only contains the resource identifier: { "id": "…" }. For webhook.test, data.object describes the subscription being tested: id, url and message.

Headers and signature

Every request carries these headers:

HeaderContent
Content-Typeapplication/json.
User-AgentLyane-Webhooks/1.0.
Lyane-Webhook-IdThe event identifier, equal to the id field of the body: deduplicate on this value.
Lyane-Webhook-TimestampThe time of the attempt, in Unix seconds. It changes with every attempt, and so does the signature.
Lyane-Signaturev1= followed by the signature in hexadecimal; two comma-separated values during a secret rotation.

The signature is a hexadecimal HMAC-SHA256. Its key is the whole subscription secret, whsec_ prefix included; its message is the timestamp, a dot, then the raw request body: <Lyane-Webhook-Timestamp>.<body>.

During the 24 hours of a secret rotation, the header carries two signatures, the new one then the old one: v1=<new>,v1=<old>. Accept the request if either one matches.

A complete delivery of the test event:

HTTP
POST /lyane HTTP/1.1
Host: hooks.exemple.fr
Content-Type: application/json
User-Agent: Lyane-Webhooks/1.0
Lyane-Webhook-Id: evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8
Lyane-Webhook-Timestamp: 1794477602
Lyane-Signature: v1=89c477430acb503d1ce355b341b864bb96fe3e41fcb43ba7c0fc9138014845c9

{"id":"evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8","type":"webhook.test","createdAt":"2026-11-12T10:00:00Z","organizationId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","data":{"object":{"id":"9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d","url":"https://hooks.exemple.fr/lyane","message":"Évènement de test envoyé depuis Lyane."}}}

Verify the signature

Before handling a request, check that it really comes from Lyane: compute the signature with your secret, compare it in constant time with each v1= value of Lyane-Signature, and reject a timestamp more than 5 minutes away from your current time, so that an intercepted request cannot be replayed later.

Compute the signature over the raw body, byte for byte, before any parsing: JSON that is parsed and serialized again may not keep the same whitespace or field order, and the signature no longer matches. With Express, read the body with express.raw({ type: 'application/json' }) rather than express.json(); with Flask, with request.get_data().

Node.js

The verification, without any dependency (Node.js 18 or later, in an ES module):

verify-signature.mjs
import { createHmac, timingSafeEqual } from 'node:crypto';

const TOLERANCE_SECONDS = 5 * 60;

export function verifyLyaneWebhook({ rawBody, timestamp, signature, secret, now = Date.now() }) {
  if (!Buffer.isBuffer(rawBody) && typeof rawBody !== 'string') return false;
  if (!secret || !signature || !/^\d+$/.test(timestamp ?? '')) return false;

  const age = Math.abs(Math.floor(now / 1000) - Number(timestamp));
  if (age > TOLERANCE_SECONDS) return false;

  const expected = createHmac('sha256', secret).update(`${timestamp}.`).update(rawBody).digest();

  // During a secret rotation: "v1=<new>,v1=<old>". One match is enough.
  return signature.split(',').some((value) => {
    const [version, hex] = value.trim().split('=');
    if (version !== 'v1' || !/^[0-9a-f]{64}$/i.test(hex ?? '')) return false;
    return timingSafeEqual(Buffer.from(hex, 'hex'), expected);
  });
}

An Express server receiving the events, with the secret in the LYANE_WEBHOOK_SECRET environment variable:

server.mjs
import express from 'express';
import { verifyLyaneWebhook } from './verify-signature.mjs';

const app = express();
// Use a database table in production: this set is lost on restart.
const processed = new Set();

app.post('/webhooks/lyane', express.raw({ type: 'application/json' }), (req, res) => {
  const valid = verifyLyaneWebhook({
    rawBody: req.body,
    timestamp: req.get('Lyane-Webhook-Timestamp'),
    signature: req.get('Lyane-Signature'),
    secret: process.env.LYANE_WEBHOOK_SECRET,
  });
  if (!valid) return res.sendStatus(401);

  const eventId = req.get('Lyane-Webhook-Id');
  if (processed.has(eventId)) return res.sendStatus(200);
  processed.add(eventId);

  const event = JSON.parse(req.body.toString('utf8'));
  res.sendStatus(200);
  setImmediate(() => handle(event).catch((error) => console.error(eventId, error)));
});

async function handle(event) {
  switch (event.type) {
    case 'opportunity.won':
      console.log('Won:', event.data.object.title);
      break;
    case 'invoice.paid':
      console.log('Paid:', event.data.object.number);
      break;
  }
}

app.listen(3000);

Python

The verification, with the standard library (Python 3.8 or later):

verify_signature.py
import hashlib
import hmac
import time

TOLERANCE_SECONDS = 5 * 60


def verify_lyane_webhook(raw_body, timestamp, signature, secret, now=None):
    if not isinstance(raw_body, bytes) or not secret or not signature:
        return False
    if not timestamp or not (timestamp.isascii() and timestamp.isdigit()):
        return False

    current = time.time() if now is None else now
    if abs(int(current) - int(timestamp)) > TOLERANCE_SECONDS:
        return False

    message = timestamp.encode() + b"." + raw_body
    expected = hmac.new(secret.encode(), message, hashlib.sha256).hexdigest()

    # During a secret rotation: "v1=<new>,v1=<old>". One match is enough.
    for value in signature.split(","):
        version, _, hex_digest = value.strip().partition("=")
        if version == "v1" and hmac.compare_digest(hex_digest.lower().encode(), expected.encode()):
            return True
    return False

A Flask application receiving the events:

app.py
import json
import os
import queue
import threading

from flask import Flask, request

from verify_signature import verify_lyane_webhook

SECRET = os.environ["LYANE_WEBHOOK_SECRET"]

app = Flask(__name__)
events = queue.Queue()
# Use a database table in production: this set is lost on restart.
processed = set()


@app.post("/webhooks/lyane")
def lyane_webhook():
    raw_body = request.get_data()
    valid = verify_lyane_webhook(
        raw_body,
        request.headers.get("Lyane-Webhook-Timestamp", ""),
        request.headers.get("Lyane-Signature", ""),
        SECRET,
    )
    if not valid:
        return "", 401

    event_id = request.headers.get("Lyane-Webhook-Id")
    if event_id not in processed:
        processed.add(event_id)
        events.put(json.loads(raw_body))
    return "", 200


def worker():
    while True:
        event = events.get()
        try:
            if event["type"] == "opportunity.won":
                print("Won:", event["data"]["object"]["title"])
            elif event["type"] == "invoice.paid":
                print("Paid:", event["data"]["object"]["number"])
        except Exception as error:
            print(event["id"], error)


threading.Thread(target=worker, daemon=True).start()

To test your code: with the example secret whsec_exemple4f8a2c9e1b7d3f6a5c0e8b2d, the timestamp 1794477602 and the body of the delivery above, the expected signature is v1=89c477430acb503d1ce355b341b864bb96fe3e41fcb43ba7c0fc9138014845c9. Pass this timestamp as the current time (now, in milliseconds in Node.js, in seconds in Python): otherwise the 5-minute tolerance rejects the request.

Retries and deactivation

A delivery succeeds when your server answers with a 2xx status within 10 seconds. Redirects are not followed: a 3xx status counts as a failure, like any other status or no response at all.

After a failure, Lyane retries the same event, with the same Lyane-Webhook-Id. Each delay runs from the previous attempt, except the last one, set 24 h after the first:

AttemptWhen
1As soon as the event happens
2+1 min
3+5 min
4+30 min
5+2 h
6+5 h
7+10 h
824 h after the first attempt

When the eighth attempt fails, the subscription is deactivated and the workspace administrators are notified by email.

The app keeps the delivery history of each subscription for 30 days. Its “Replay” button sends an event again, with its original identifier.

Best practices

  • Answer quickly, then process: verify the signature, put the event in a queue, answer 200, and do the work afterwards. Long processing goes over the 10 seconds and triggers a new attempt.
  • Deduplicate on Lyane-Webhook-Id: the same event can arrive more than once (a lost response, a replay). Keep the identifiers already handled in a table, not only in memory.
  • Make processing idempotent: applying the same event twice must leave the same result. Write the state you received (“the invoice is paid”) rather than an increment.
  • Do not rely on ordering: two events can arrive out of order, especially after a retry. Compare createdAt, or read the resource again with the public API when in doubt.
  • opportunity.stage_changed is sent on every stage change, including to won or lost, in addition to opportunity.won or opportunity.lost: subscribe to one or the other depending on what you track.
  • Keep the secret server-side, and reject any request whose signature does not match (401).

Event reference

Every event, grouped by domain, with a complete body example. This list is generated from the OpenAPI specification (webhooks section).

Clients

clients

A client is created

client.created

ObjectClient

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "client.created",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "type": "company",
      "status": "prospect",
      "name": "Atelier Lumen",
      "companyName": "Atelier Lumen",
      "siren": "552100554",
      "siret": "55210055400013",
      "vatNumber": "FR40552100554",
      "website": "https://atelier-lumen.fr",
      "industry": "Architecture",
      "firstName": null,
      "lastName": null,
      "address": {
        "line": "12 rue des Lilas",
        "line2": "Bâtiment B",
        "postalCode": "69003",
        "city": "Lyon",
        "country": "France"
      },
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "originId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "convertedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    }
  }
}

A client is updated (or a prospect becomes a client)

client.updated

ObjectClientMay carry data.previous.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "client.updated",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "type": "company",
      "status": "client",
      "name": "Atelier Lumen",
      "companyName": "Atelier Lumen",
      "siren": "552100554",
      "siret": "55210055400013",
      "vatNumber": "FR40552100554",
      "website": "https://atelier-lumen.fr",
      "industry": "Architecture",
      "firstName": null,
      "lastName": null,
      "address": {
        "line": "12 rue des Lilas",
        "line2": "Bâtiment B",
        "postalCode": "69003",
        "city": "Lyon",
        "country": "France"
      },
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "originId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "convertedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    },
    "previous": {
      "status": "prospect"
    }
  }
}

A client is deleted

client.deleted

ObjectIdentifier only: { "id" }.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "client.deleted",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d"
    }
  }
}

Contacts

contacts

A shared contact is created (or a record becomes shared)

contact.created

ObjectContact

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "contact.created",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "firstName": "Camille",
      "lastName": "Martin",
      "email": "camille.martin@atelier-lumen.fr",
      "phone": "+33 4 72 00 00 00",
      "jobTitle": "Directrice administrative",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    }
  }
}

A shared contact is updated

contact.updated

ObjectContactMay carry data.previous.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "contact.updated",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "firstName": "Camille",
      "lastName": "Martin",
      "email": "camille.martin@atelier-lumen.fr",
      "phone": "+33 4 72 00 00 00",
      "jobTitle": "Directrice administrative",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    }
  }
}

A shared contact is deleted (or becomes personal)

contact.deleted

ObjectIdentifier only: { "id" }.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "contact.deleted",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d"
    }
  }
}

Opportunities

opportunities

An opportunity is created

opportunity.created

ObjectOpportunity

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "opportunity.created",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "title": "Rénovation du showroom",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "pipelineId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "stageId": "5d0b1a2c-3e4f-4a5b-8c6d-7e8f9a0b1c2d",
      "status": "open",
      "amount": 12500,
      "currency": "EUR",
      "expectedCloseDate": "2026-12-15",
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "closedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    }
  }
}

An opportunity is updated (stage excluded)

opportunity.updated

ObjectOpportunityMay carry data.previous.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "opportunity.updated",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "title": "Rénovation du showroom",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "pipelineId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "stageId": "5d0b1a2c-3e4f-4a5b-8c6d-7e8f9a0b1c2d",
      "status": "open",
      "amount": 12500,
      "currency": "EUR",
      "expectedCloseDate": "2026-12-15",
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "closedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    },
    "previous": {
      "amount": 10000
    }
  }
}

An opportunity changes stage (won and lost included)

opportunity.stage_changed

ObjectOpportunityMay carry data.previous.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "opportunity.stage_changed",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "title": "Rénovation du showroom",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "pipelineId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "stageId": "5d0b1a2c-3e4f-4a5b-8c6d-7e8f9a0b1c2d",
      "status": "open",
      "amount": 12500,
      "currency": "EUR",
      "expectedCloseDate": "2026-12-15",
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "closedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    },
    "previous": {
      "stageId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "status": "open"
    }
  }
}

An opportunity is won

opportunity.won

ObjectOpportunityMay carry data.previous.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "opportunity.won",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "title": "Rénovation du showroom",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "pipelineId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "stageId": "5d0b1a2c-3e4f-4a5b-8c6d-7e8f9a0b1c2d",
      "status": "won",
      "amount": 12500,
      "currency": "EUR",
      "expectedCloseDate": "2026-12-15",
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "closedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    },
    "previous": {
      "stageId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "status": "open"
    }
  }
}

An opportunity is lost

opportunity.lost

ObjectOpportunityMay carry data.previous.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "opportunity.lost",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "title": "Rénovation du showroom",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "pipelineId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "stageId": "5d0b1a2c-3e4f-4a5b-8c6d-7e8f9a0b1c2d",
      "status": "lost",
      "amount": 12500,
      "currency": "EUR",
      "expectedCloseDate": "2026-12-15",
      "ownerId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "closedAt": "2026-11-12T09:15:00Z",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z",
      "customFields": {
        "numero_client_erp": "C-00042",
        "segment": "grand_compte",
        "date_signature_cadre": "2026-09-30"
      }
    },
    "previous": {
      "stageId": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "status": "open"
    }
  }
}

An opportunity is deleted

opportunity.deleted

ObjectIdentifier only: { "id" }.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "opportunity.deleted",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d"
    }
  }
}

Sales

sales

A quote is issued (sent)

quote.sent

ObjectSalesDocument

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "quote.sent",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "type": "quote",
      "number": "DE-2026-012",
      "status": "sent",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "clientName": "Atelier Lumen",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "reference": null,
      "issueDate": "2026-11-12",
      "validUntil": "2026-11-12",
      "dueDate": "2026-11-12",
      "currency": "EUR",
      "totalExclTaxCents": 1250000,
      "totalInclTaxCents": 1500000,
      "paidCents": 0,
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z"
    }
  }
}

A quote is accepted

quote.accepted

ObjectSalesDocumentMay carry data.previous.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "quote.accepted",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "type": "quote",
      "number": "DE-2026-012",
      "status": "accepted",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "clientName": "Atelier Lumen",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "reference": null,
      "issueDate": "2026-11-12",
      "validUntil": "2026-11-12",
      "dueDate": "2026-11-12",
      "currency": "EUR",
      "totalExclTaxCents": 1250000,
      "totalInclTaxCents": 1500000,
      "paidCents": 0,
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z"
    }
  }
}

A quote is declined

quote.declined

ObjectSalesDocumentMay carry data.previous.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "quote.declined",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "type": "quote",
      "number": "DE-2026-012",
      "status": "refused",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "clientName": "Atelier Lumen",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "reference": null,
      "issueDate": "2026-11-12",
      "validUntil": "2026-11-12",
      "dueDate": "2026-11-12",
      "currency": "EUR",
      "totalExclTaxCents": 1250000,
      "totalInclTaxCents": 1500000,
      "paidCents": 0,
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z"
    }
  }
}

An invoice (or a deposit, a credit note) is issued

invoice.issued

ObjectSalesDocument

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "invoice.issued",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "type": "invoice",
      "number": "FA-2026-042",
      "status": "issued",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "clientName": "Atelier Lumen",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "reference": null,
      "issueDate": "2026-11-12",
      "validUntil": "2026-11-12",
      "dueDate": "2026-11-12",
      "currency": "EUR",
      "totalExclTaxCents": 1250000,
      "totalInclTaxCents": 1500000,
      "paidCents": 0,
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z"
    }
  }
}

An invoice is fully paid

invoice.paid

ObjectSalesDocumentMay carry data.previous.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "invoice.paid",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "type": "invoice",
      "number": "FA-2026-042",
      "status": "paid",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "clientName": "Atelier Lumen",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "reference": null,
      "issueDate": "2026-11-12",
      "validUntil": "2026-11-12",
      "dueDate": "2026-11-12",
      "currency": "EUR",
      "totalExclTaxCents": 1250000,
      "totalInclTaxCents": 1500000,
      "paidCents": 0,
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z"
    }
  }
}

Tasks

tasks

A task is created

task.created

ObjectTask

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "task.created",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "title": "Rappeler pour le devis",
      "description": null,
      "dueDate": "2026-11-20",
      "done": false,
      "completedAt": "2026-11-12T09:15:00Z",
      "assigneeId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "assigneeGroupId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "recurrence": "none",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z"
    }
  }
}

A task is completed

task.completed

ObjectTask

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "task.completed",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "title": "Rappeler pour le devis",
      "description": null,
      "dueDate": "2026-11-20",
      "done": true,
      "completedAt": "2026-11-12T09:15:00Z",
      "assigneeId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "assigneeGroupId": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "contactId": "6b1f0c2e-8d2a-4f7e-9c51-0a4f4b8e2d10",
      "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "opportunityId": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "recurrence": "none",
      "createdBy": "0b7c6f3e-4d2a-4e1f-9a8b-7c6d5e4f3a2b",
      "createdAt": "2026-11-12T09:15:00Z",
      "updatedAt": "2026-11-12T09:15:00Z"
    }
  }
}

A task is deleted

task.deleted

ObjectIdentifier only: { "id" }.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "task.deleted",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d"
    }
  }
}

Test

A test, sent with “Send a test”

webhook.test

ObjectThe subscription being tested: id, url, message.

Body example
JSON
{
  "id": "evt_01JCQ7Z8K9V5W2X3Y4Z5A6B7C8",
  "type": "webhook.test",
  "createdAt": "2026-11-12T10:00:00Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "data": {
    "object": {
      "id": "9c4e2a71-1b3d-4f6a-8e2c-5d7f9a0b1c2d",
      "url": "https://hooks.exemple.fr/lyane",
      "message": "Évènement de test envoyé depuis Lyane."
    }
  }
}