API reference

The documented surface below is Lynqu’s stability contract: these endpoint groups keep their request/response shapes, and breaking changes ship as a new API version. Endpoints you may discover outside this list are internal and can change without notice. Don’t build on them.

An OpenAPI 3 specification of this surface is published alongside these docs and regenerated on every backend release.

Resource groups

All organization-scoped groups live under /b2b/organizations/{organization}/… and require an organization role that can see the resource in the app.

Cards · /cards

Digital card CRUD, templates and palettes, card statistics, vCard download. Cards you own or manage; publish state and visibility rules are enforced server-side.

Contacts. /contacts, /b2b/organizations/{org}/contacts

Personal saved connections and the organization address book: create, search, tag, annotate.

Leads · /b2b/organizations/{org}/leads

The sales pipeline: list and filter leads, read the activity timeline, create and update leads, move pipeline stages, assign owners, manage contact points (tasks), duplicates, and lead documents. Reads and writes follow your role and department scope exactly as in the app.

The leads list takes segment_id to return the leads of one segment (see Segments below).

Segments · /b2b/organizations/{org}/segments

Read-only. GET lists the organization’s lead segments in their report order. Use a segment’s id as segment_id on the leads list. Stable fields: id, name, color, description, position, lead_count (the leads your key’s user can see) and updated_at. definition describes the conditions for information only; its shape can change between releases, and definition_version changes when it does. Creating, editing, ordering and deleting segments happen in the app, not through the API.

Campaigns · /b2b/organizations/{org}/campaigns

Campaigns, goals, members, capture-form stats, and lead attachment.

Events · /b2b/organizations/{org}/events

Time-bound or open-ended events with a four-state lifecycle (draft → active → archived → closed), optionally rolled up to a campaign.

Departments & users. /b2b/organizations/{org}/departments, …/users

Org structure and membership: departments (nested), member roles and status, invites.

Developer · /developer/api-keys

Key management. Session-token only. API keys cannot manage API keys (see Authentication).

Common parameters

• Pagination: list endpoints accept page and per_page (per_page is capped, typically at 100). Responses carry Laravel-style pagination metadata inside data.
• Localization: Accept-Language controls human-readable messages only.

Anything missing?

If you need an endpoint that isn’t part of the stable surface yet, ask at lynqu.com/support, expanding the documented surface is a product decision, and demand moves it.