Skip to main content
GET
/
v1
/
leads
List leads
curl --request GET \
  --url https://api.example.com/v1/leads
{
  "data": [
    {
      "id": 44,
      "status": "submitted",
      "created_at": "2025-05-16",
      "lead_info": {
        "name": "Alice Brown",
        "email": "[email protected]"
      },
      "converted_to": null,
      "submitter": {
        "id": "partner_123",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "submission_form": [
        {
          "question": "Name",
          "answer": "Alice Brown"
        },
        {
          "question": "Email address",
          "answer": "[email protected]"
        }
      ],
      "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
}
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

ParameterTypeDefaultDescription
limitinteger15Number of results per page (1-250)
pageinteger1Page number for pagination

​
Request

cURL
curl --location 'https://api.partnero.com/v1/leads' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

​
Response

{
  "data": [
    {
      "id": 44,
      "status": "submitted",
      "created_at": "2025-05-16",
      "lead_info": {
        "name": "Alice Brown",
        "email": "[email protected]"
      },
      "converted_to": null,
      "submitter": {
        "id": "partner_123",
        "name": "John Doe",
        "email": "[email protected]"
      },
      "submission_form": [
        {
          "question": "Name",
          "answer": "Alice Brown"
        },
        {
          "question": "Email address",
          "answer": "[email protected]"
        }
      ],
      "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
}

​
Response Fields

FieldTypeDescription
dataarrayArray of lead objects
data[].idintegerUnique lead ID
data[].statusstringLead status: submitted, converted, rejected
data[].lead_infoobjectBasic lead information (name, email)
data[].submitterobjectPartner who submitted the lead
data[].submission_formarrayCustom form field responses
data[].converted_toobject | nullCustomer data if lead was converted
data[].can_be_convertedbooleanWhether lead can be converted
data[].can_be_rejectedbooleanWhether lead can be rejected
data[].created_atstringCreation date

​
Get Lead Details Configuration

Retrieve lead form configuration and commission settings: 
GET https://api.partnero.com/v1/leads/details
This returns information about custom form fields and lead commission settings.