Getting started

The Lynqu REST API gives Business and Enterprise accounts programmatic access to the same platform the apps use: cards, contacts, leads, campaigns, events, and team data.

Base URL

https://api.lynqu.com/v1

All requests use HTTPS and JSON. Send an Accept: application/json header on every request.

Authentication

Authenticate with an API key passed as a Bearer token:

curl https://api.lynqu.com/v1/developer/api-keys \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Accept: application/json"

Create keys from your Lynqu dashboard — see Authentication.

Response envelope

Every endpoint responds with the same envelope:

{
  "status": "success",
  "message": "OK",
  "data": { },
  "errors": []
}

On failure, status is "error" and errors carries one or more structured entries:

{
  "status": "error",
  "message": "API keys are available on Business and Enterprise plans.",
  "data": null,
  "errors": [
    {
      "type": "PlanError",
      "key": "plan",
      "errorMessage": "API keys are available on Business and Enterprise plans.",
      "errorTitle": "Upgrade required"
    }
  ]
}

See Rate limits & errors for status codes and retry guidance.

Your first request

List your organization’s leads (replace {org} with your organization id):

curl "https://api.lynqu.com/v1/b2b/organizations/{org}/leads" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Accept: application/json"

Your API key acts as you: it sees exactly what your account sees, filtered by your organization role and department scope. An employee key cannot read leads its owner cannot read in the app.

Localized responses

Human-readable message strings honor the Accept-Language header (12 languages, e.g. de, ja, pt-BR). Machine fields — status, error type/key — never change with locale. Don’t parse message.