> ## Documentation Index
> Fetch the complete documentation index at: https://docs.partnero.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List leads

> Retrieve a list of all leads

A lead is someone who has expressed interest in your product or service by submitting a form or interacting with your platform, but has not yet signed up as a customer.

## Endpoint

```
GET https://api.partnero.com/v1/leads
```

## Query Parameters

| Parameter | Type    | Default | Description                        |
| --------- | ------- | ------- | ---------------------------------- |
| `limit`   | integer | 15      | Number of results per page (1-250) |
| `page`    | integer | 1       | Page number for pagination         |

## Request

```bash cURL theme={null}
curl --location 'https://api.partnero.com/v1/leads' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

## Response

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "data": [
      {
        "id": 44,
        "status": "submitted",
        "created_at": "2025-05-16",
        "lead_info": {
          "name": "Alice Brown",
          "email": "alice.brown@partnero.com"
        },
        "converted_to": null,
        "submitter": {
          "id": "partner_123",
          "name": "John Doe",
          "email": "john.doe@partnero.com"
        },
        "submission_form": [
          {
            "question": "Name",
            "answer": "Alice Brown"
          },
          {
            "question": "Email address",
            "answer": "alice.brown@partnero.com"
          }
        ],
        "can_be_converted": true,
        "can_be_rejected": true
      }
    ],
    "links": {
      "first": "https://api.partnero.com/v1/leads?page=1",
      "last": null,
      "prev": null,
      "next": null
    },
    "meta": {
      "current_page": 1,
      "from": 1,
      "path": "https://api.partnero.com/v1/leads",
      "per_page": 15,
      "to": 1
    },
    "status": 1
  }
  ```
</ResponseExample>

### Response Fields

| Field                     | Type           | Description                                       |
| ------------------------- | -------------- | ------------------------------------------------- |
| `data`                    | array          | Array of lead objects                             |
| `data[].id`               | integer        | Unique lead ID                                    |
| `data[].status`           | string         | Lead status: `submitted`, `converted`, `rejected` |
| `data[].lead_info`        | object         | Basic lead information (name, email)              |
| `data[].submitter`        | object         | Partner who submitted the lead                    |
| `data[].submission_form`  | array          | Custom form field responses                       |
| `data[].converted_to`     | object \| null | Customer data if lead was converted               |
| `data[].can_be_converted` | boolean        | Whether lead can be converted                     |
| `data[].can_be_rejected`  | boolean        | Whether lead can be rejected                      |
| `data[].created_at`       | string         | Creation date                                     |

## Get Lead Details Configuration

Retrieve lead form configuration and commission settings:

```bash theme={null}
GET https://api.partnero.com/v1/leads/details
```

This returns information about custom form fields and lead commission settings.