Quickstart

This guide takes you from zero to your first authenticated request — reading your organization, then listing leads from your workspace.

Prerequisites

Before you begin, you need:

A Leadey account. Sign up at app.leadey.ai — new workspaces start on a 14-day free trial.
An API key (created in the next step).
A terminal with curl, or any HTTP client.

Get started

Create an API key

In the Cockpit, open Settings → API Keys and select Create key. Give it a name, choose an access level, then copy the key — it starts with leadey_sk_live_ and is shown only once.Read only is the default and is all you need for this guide. Choose Read and write when the integration also needs to create leads, log calls, or manage tasks — see Writing data.Store it somewhere safe. It carries the access of your workspace, so never commit it to source control or expose it in client-side code. If a key leaks, revoke it from the same screen.

Authenticate

Every request authenticates with your key as a Bearer token in the Authorization header.

export LEADEY_API_KEY="leadey_sk_live_your_key_here"

Confirm it works by reading your organization:

curl https://backend.leadey.ai/v1/me \
  -H "Authorization: Bearer $LEADEY_API_KEY"

A 200 response returns your organization, plan, and credit balance:

{
  "data": {
    "id": "org_123",
    "name": "Acme Inc",
    "plan": "growth",
    "planStatus": "active",
    "credits": { "balance": 2840, "included": 10000, "used": 7160 },
    "createdAt": "2026-01-04T10:30:00.000Z"
  }
}

List your leads

Now fetch a page of leads. Responses are paginated — pass page and pageSize (max 100).

curl "https://backend.leadey.ai/v1/leads?pageSize=5" \
  -H "Authorization: Bearer $LEADEY_API_KEY"

The response is a data array plus a meta object describing the page:

{
  "data": [
    {
      "id": "lead_456",
      "name": "Jordan Lee",
      "title": "VP Engineering",
      "company": "Northwind",
      "email": "jordan@northwind.com",
      "status": "pending",
      "score": 78,
      "campaignId": "funnel_789",
      "campaignName": "Q3 — Hiring surge",
      "createdAt": "2026-06-12T14:22:00.000Z"
    }
  ],
  "meta": { "page": 1, "pageSize": 5, "totalCount": 134, "totalPages": 27 }
}

Next steps

Explore the API

Browse every endpoint and try requests in the playground.

Authentication

Key formats, rotation, and security.

Writing data

Create leads, add notes, and log calls.

Pagination

Page through large result sets.

Errors

Status codes and the error shape.

Need help? Reach the team at support@leadey.ai, or manage keys and credits anytime in the dashboard.

Getting started

Core concepts

Using the API

Webhooks

Prerequisites

Get started

Next steps

Explore the API

Authentication

Writing data

Pagination

Errors

​Prerequisites

​Get started

​Next steps

Explore the API

Authentication

Writing data

Pagination

Errors

Prerequisites

Get started

Next steps