Leads

List the coach's leads

Cursor-paginated, most recently active first. Narrow it with channel, or search names and handles with q. Send nextCursor back as cursor for the next page. A key on the redacted data tier gets the structured fields only, so displayName and externalUserId come back blank.

API key scopes: leads:read.

get/api/leads

Request

  • Base URL: https://api.setluca.com
  • URL: https://api.setluca.com/api/leads
  • Auth: one of:
    • API key in cookie luca.session_token
    • API key in header x-api-key
    • HTTP bearer

Query parameters

limitinteger

Maximum number of items to return on this page.

cursorstring

Opaque pagination cursor from the previous page. Omit it for the first page.

channel'telegram' | 'instagram' | 'messenger' | 'whatsapp'

Return only records on this messaging channel.

qstring

Free-text search term.

Headers

Luca-API-Version'1'

The major version of the API this client was built against. Omit it and the request is served by the current major version. Any other value is refused with 400 unsupported_api_version.

Response

ok

nextCursorstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.