Get leads

Authentication

Request

string

required

Must be "get_leads".

uuid

required

The channel to retrieve leads from. Your company must have access to this channel.

Response

Returns a JSON array of lead objects ordered by created_at descending. Up to 100 leads are returned per request.

Custom properties defined on the channel appear as top-level keys on each lead, keyed by the property definition name (for example, "Deal size"). Use get_channels to retrieve the list of property definitions for a channel.

array

Show Lead object

uuid

Lead ID.

string | null

Contact email.

string | null

First name.

string | null

Last name.

string | null

Phone number.

string | null

Company name of the lead.

string | null

Lead source.

string | null

Employee at the referring company who submitted the lead.

string | null

External business identifier.

string | null

Free-text notes.

timestamp

When the lead was created.

string | null

Current lead status name.

string

Any custom properties defined for the channel appear as additional top-level keys, named by their property definition name.

Example

Request

curl -X POST https://data.keenpartner.com/functions/v1/keen-api \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "action": "get_leads",
    "channel_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }'

Response

[
  {
    "id": "99887766-5544-3322-1100-aabbccddeeff",
    "email": "jane@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "phone": "+45 12345678",
    "company_name": "Acme Inc",
    "source": "website",
    "referring_employee": "John Smith",
    "business_id": "biz-123",
    "notes": "Interested in premium plan",
    "created_at": "2026-04-21T10:00:00.000Z",
    "status": "New",
    "Deal size": "50000",
    "Region": "EMEA"
  }
]

Errors

Status	Error	Cause
`400`	`"channel_id required"`	The `channel_id` field is missing.
`401`	`"Invalid API key"`	Missing or invalid `X-Api-Key` header.
`403`	`"Channel not accessible"`	Your company does not have access to this channel.

Overview

Channels

Leads

Purchases

Authentication

Request

Response

Example

Request

Response

Errors

​Authentication

​Request

​Response

​Example

​Request

​Response

​Errors

Authentication

Request

Response

Example

Request

Response

Errors