API reference

POSTCreate a connect link

POST /v1/partner/connect_links: A single-use link (7 days at most) a contractor's owner opens to approve your access.

POSThttps://api.light-ai.app/v1/partner/connect_links

A single-use link (7 days at most) a contractor's owner opens to approve your access. The owner signs in (or signs up), sees your verified legal name, domain and every scope, and approves. Never email API keys: send connect links. The url is returned only here (and on an Idempotency-Key replay).

Credential	Partner API key (a key of a partner account).
Test mode	Live keys only (answers 400 `test_mode_unsupported` to a test key).
Idempotency	`Idempotency-Key` supported. See Idempotency.

Headers#

Light-AI-Versionstring#

Pin a dated API version (defaults to the key's version). One of: 2026-11-01.

Idempotency-Keystring#

Retry-safe writes: the same key and body replay the first response for 24 hours (Idempotent-Replayed: true). 8–128 characters.

Request body#

scopesstring[]required#

One of: leads:read, leads:write, clients:read, clients:write, projects:read, projects:write, quotes:read, quotes:write, quotes:share_link, quotes:asset_links, webhooks:manage, events:read, mockups:read, mockups:write, forms:read, forms:write. 1–16 items.

organizationstring#

Bind the link to one organization (when you already know its id). Id prefix org_.

client_labelstring#

Required for unbound links: who you are connecting (shown to you on confirmation). 1–120 characters.

external_referencestring#

1–255 characters.

metadataobject#

redirect_uristring#

https URL on your verified domain to return to after consent. Light AI appends connect_link (cl_…), grant (grant_…), organization (org_…) and grant_status (active, or pending when an unbound link still needs POST /v1/partner/grants/{grant_id}/confirm); your own query parameters are kept, so one redirect_uri can serve every contractor. At most 2048 characters.

expires_in_hoursinteger#

Default 168 (7 days). 1–168.

Response 201#

The link (with its url).

idstringrequired#

Id prefix cl_.

objectstringrequired#

Always connect_link.

scopesstring[]required#

bound_organizationstring | nullrequired#

Id prefix org_.

client_labelstring | nullrequired#

external_referencestring | nullrequired#

metadataobjectrequired#

redirect_uristring | nullrequired#

statusstringrequired#

One of: open, consumed, expired, revoked.

grantstring | nullrequired#

Id prefix grant_.

created_attimestamprequired#

RFC 3339 timestamp (UTC, milliseconds).

expires_attimestamprequired#

RFC 3339 timestamp (UTC, milliseconds).

consumed_attimestamp | nullrequired#

RFC 3339 timestamp (UTC, milliseconds).

urlstring#

The link to send to the contractor. Returned only when created.

Errors#

Status	Meaning
`400`	Bad request. `bad_request`, `test_mode_mismatch`, `test_mode_unsupported`, `unsupported_api_version`
`401`	Missing or invalid credential. `authentication_required`, `invalid_api_key`, `api_key_revoked`, `api_key_expired`, `api_key_suspended`
`403`	Not allowed. `insufficient_scope`, `plan_upgrade_required`, `organization_paused`, `organization_off_season`, `api_disabled`, `api_access_not_enabled`, `ip_not_allowed`, `forbidden`
`404`	Not found (also for objects of other organizations and for organizations without an active grant).
`409`	Conflict. `stale_state`, `conflict`, `idempotency_in_progress`, `idempotency_scope_mismatch`, `quote_already_decided`, `quote_not_current`, `billing_review_required`
`413`	Request bodies are limited to 256 KB.
`415`	The body is not JSON: send Content-Type: application/json. `unsupported_media_type`
`422`	Validation failed. `idempotency_key_reused`
`429`	Rate limited or daily cap reached. See Retry-After and the RateLimit headers. `rate_limited`, `daily_cap_reached`
`500`	Unexpected server error. Safe to retry with exponential backoff; quote the Request-Id to support. `internal_error`
`503`	Temporarily unavailable. Retry with exponential backoff. `service_unavailable`

Request

curl -X POST "https://api.light-ai.app/v1/partner/connect_links" \
  -H "Authorization: Bearer $LIGHT_AI_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "scopes": [
    "leads:read",
    "leads:write",
    "clients:read",
    "projects:read",
    "quotes:read",
    "quotes:write",
    "webhooks:manage"
  ],
  "client_label": "Bright Nights Lighting",
  "external_reference": "ghl-location-AbC123",
  "redirect_uri": "https://app.acme-automations.com/light-ai/connected"
}'

const response = await fetch('https://api.light-ai.app/v1/partner/connect_links', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LIGHT_AI_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "scopes": [
      "leads:read",
      "leads:write",
      "clients:read",
      "projects:read",
      "quotes:read",
      "quotes:write",
      "webhooks:manage"
    ],
    "client_label": "Bright Nights Lighting",
    "external_reference": "ghl-location-AbC123",
    "redirect_uri": "https://app.acme-automations.com/light-ai/connected"
  }),
});
const data = await response.json();

import os, uuid, requests

response = requests.post(
    "https://api.light-ai.app/v1/partner/connect_links",
    headers={
        "Authorization": f"Bearer {os.environ['LIGHT_AI_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
      "scopes": [
        "leads:read",
        "leads:write",
        "clients:read",
        "projects:read",
        "quotes:read",
        "quotes:write",
        "webhooks:manage"
      ],
      "client_label": "Bright Nights Lighting",
      "external_reference": "ghl-location-AbC123",
      "redirect_uri": "https://app.acme-automations.com/light-ai/connected"
    },
    timeout=30,
)
data = response.json()

Response 201JSON

{
  "id": "cl_3f9c2a7be41d…",
  "object": "connect_link",
  "scopes": [
    "leads:read"
  ],
  "bound_organization": "org_3f9c2a7be41d…",
  "client_label": "string",
  "external_reference": "string",
  "metadata": {},
  "redirect_uri": "string",
  "status": "open",
  "grant": "grant_3f9c2a7be41d…",
  "created_at": "2026-10-12T14:03:11.000Z",
  "expires_at": "2026-10-12T14:03:11.000Z",
  "consumed_at": "2026-10-12T14:03:11.000Z",
  "url": "https://example.com/…"
}