Logo
Platform Guide
API Reference
Platform Updates
Platform updates
Leads

List leads

List all leads for the authenticated user

GET

/ user / leads

This endpoint allows you to list all leads belonging to the authenticated user.

Response fields

leads array

id integer

The id of the lead

campaign_id integer

The ID of the campaign this lead belongs to

phone_number string

The phone number of the lead in E.164 format

variables object

The variables associated with the lead

status string

The status of the lead

created_at string

The created at date of the lead

updated_at string

The updated at date of the lead

campaign object

The campaign information

id integer

The id of the campaign

name string

The name of the campaign

secondary_contacts array

Array of secondary contact leads associated with this lead

id integer

The id of the secondary contact lead

phone_number string

The phone number of the secondary contact in E.164 format

variables object

The variables associated with the secondary contact

status string

The status of the secondary contact

created_at string

The created at date of the secondary contact

updated_at string

The updated at date of the secondary contact

List leads
200 Response
[
  {
    "id": 1,
    "campaign_id": 1,
    "phone_number": "+1234567890",
    "variables": {
      "customer_name": "John Doe",
      "email": "john.doe@example.com"
    },
    "status": "created",
    "created_at": "2025-06-30 11:18:04",
    "updated_at": "2025-06-30 11:18:04",
    "campaign": {
      "id": 1,
      "name": "My new campaign"
    },
    "secondary_contacts": [
      {
        "id": 2,
        "phone_number": "+1234567899",
        "variables": {
          "customer_name": "Jane Doe Secondary",
          "email": "jane.doe.secondary@example.com"
        },
        "status": "created",
        "created_at": "2025-06-30 11:18:04",
        "updated_at": "2025-06-30 11:18:04"
      }
    ]
  }
]