> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/lead/list-leads/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.jazzhq.ai/_mcp/server.

# List a partner's leads

GET https://api.jazzhq.ai/api/v1/vendors/partners/{partnerId}/leads

Returns the leads belonging to one of your partners, newest first.

Archived leads are excluded unless you pass `archived=true`. Results are always
tie-broken by `id`, so paging through a large result set never skips or repeats
a lead.


Reference: https://developers.jazzhq.ai/api-reference/vendor-customer-ap-is/lead/list-leads

## Authentication

- `X-API-KEY` header (required) — Your vendor API key. Required on every request under /api/v1/vendors/**.

## Request

### Path parameters

- `partnerId` (long, required) — ID of the partner whose leads to list.

### Query parameters

- `page` (integer, optional, default: 0) — Zero-based page number.
- `perPage` (integer, optional, default: 20) — Number of results per page. Values above 100 are rejected.
- `sortBy` (enum, optional, default: createdAt) — Field to sort by. An unrecognised value falls back to `createdAt`.
  - Allowed values: `id`, `createdAt`, `updatedAt`
- `sortDirection` (enum, optional, default: desc)
  - Allowed values: `asc`, `desc`
- `approvalStatus` (enum, optional)
  - Allowed values: `PENDING`, `APPROVED`, `REJECTED`
- `status` (list of long, optional) — Id of a lead status dropdown value. Repeatable.
- `source` (list of long, optional) — Id of a lead source dropdown value. Repeatable.
- `keyword` (string, optional) — Case-insensitive prefix match on first name or email address.
- `createdAtAfter` (date, optional) — Only leads created on or after this date.
- `createdAtBefore` (date, optional) — Only leads created on or before this date.
- `archived` (boolean, optional) — Omit for active leads only. Pass `true` to list archived leads instead.

## Response

### 200

Leads retrieved successfully.

- `success` (boolean, optional)
- `message` (string, optional, nullable)
- `data` (LeadPage, optional)
- `timestamp` (datetime, optional)

## Errors

### 400 Bad Request Error

A query parameter was invalid - `perPage` above 100, a negative `page`, an unknown `approvalStatus`, or a date that isn't `YYYY-MM-DD`.

- `message` (string, optional) — Machine-readable error code. One of: VALIDATION_FAILED, INVALID_REQUEST, DUPLICATE_ENTRY, RESOURCE_NOT_FOUND, INVALID_STATE_TRANSITION, INTERNAL_SERVER_ERROR.
- `status` (integer, optional)
- `success` (boolean, optional)
- `errors` (list of ValidationErrorDetail, optional)
- `timestamp` (datetime, optional)

### 401 Unauthorized Error

Authentication failed - the X-API-KEY header was missing or invalid, or the request path is outside the /api/v1/vendors/ namespace this key is authorized for.

- `success` (boolean, optional)
- `message` (string, optional) — One of: API_KEY_MISSING, INVALID_API_KEY, UNKNOWN_API_NAMESPACE.
- `data` (AuthErrorResponseData, optional, nullable)
- `timestamp` (datetime, optional)

### 404 Not Found Error

The requested resource was not found.

- `message` (string, optional) — Machine-readable error code. One of: VALIDATION_FAILED, INVALID_REQUEST, DUPLICATE_ENTRY, RESOURCE_NOT_FOUND, INVALID_STATE_TRANSITION, INTERNAL_SERVER_ERROR.
- `status` (integer, optional)
- `success` (boolean, optional)
- `errors` (list of ValidationErrorDetail, optional)
- `timestamp` (datetime, optional)

### 500 Internal Server Error

An unexpected error occurred.

- `message` (string, optional) — Machine-readable error code. One of: VALIDATION_FAILED, INVALID_REQUEST, DUPLICATE_ENTRY, RESOURCE_NOT_FOUND, INVALID_STATE_TRANSITION, INTERNAL_SERVER_ERROR.
- `status` (integer, optional)
- `success` (boolean, optional)
- `errors` (list of ValidationErrorDetail, optional)
- `timestamp` (datetime, optional)

## Types

### LeadPage

- `data` (list of Lead, optional)
- `page` (integer, optional)
- `perPage` (integer, optional)
- `totalItems` (long, optional)

### ValidationErrorDetail

- `field` (string, optional) — Name of the request field this error relates to.
- `error` (string, optional) — Human-readable description of what's wrong.

### AuthErrorResponseData

### Lead

- `id` (long, optional)
- `partnerId` (long, optional)
- `firstName` (string, optional)
- `lastName` (string, optional, nullable)
- `emailAddress` (string, optional)
- `phoneNumber` (string, optional, nullable)
- `linkedInUrl` (string, optional, nullable)
- `companyName` (string, optional)
- `websiteUrl` (string, optional, nullable)
- `companySize` (string, optional, nullable)
- `industry` (string, optional, nullable)
- `jobTitle` (string, optional, nullable)
- `city` (string, optional, nullable)
- `state` (string, optional, nullable)
- `country` (string, optional, nullable)
- `source` (long, optional, nullable) — Id of a lead source dropdown value configured for your account.
- `status` (long, optional, nullable) — Id of a lead status dropdown value configured for your account.
- `leadAge` (integer, optional, nullable)
- `productsInterested` (string, optional, nullable)
- `businessImpactMetrics` (string, optional, nullable)
- `externalId` (string, optional, nullable) — Your own identifier for this lead. Stored and echoed back unchanged.
- `approvalStatus` (enum, optional)
  - Allowed values: `PENDING`, `APPROVED`, `REJECTED`
- `rejectReason` (string, optional, nullable)
- `rejectComment` (string, optional, nullable)
- `lastActiveAt` (datetime, optional, nullable)
- `submittedByType` (enum, optional, nullable) — What created the lead.
  - Allowed values: `PARTNER_USER`, `VENDOR_USER`, `INTEGRATION`, `SYSTEM`, `API`
- `isDuplicate` (boolean, optional) — Another active lead or contact already exists with this email address.
- `archived` (boolean, optional) — Archived leads are excluded from listings by default.
- `createdAt` (datetime, optional)
- `updatedAt` (datetime, optional)

## Examples

**Response**

```json
{
  "success": true,
  "message": "string",
  "data": {
    "data": [
      {
        "id": 300,
        "partnerId": 1001,
        "firstName": "Jane",
        "lastName": "Doe",
        "emailAddress": "jane@acme.com",
        "phoneNumber": "string",
        "linkedInUrl": "string",
        "companyName": "Acme Inc",
        "websiteUrl": "string",
        "companySize": "50-100",
        "industry": "string",
        "jobTitle": "VP Sales",
        "city": "string",
        "state": "string",
        "country": "string",
        "source": 1,
        "status": 1,
        "leadAge": 1,
        "productsInterested": "string",
        "businessImpactMetrics": "string",
        "externalId": "string",
        "approvalStatus": "PENDING",
        "rejectReason": "string",
        "rejectComment": "string",
        "lastActiveAt": "2024-01-15T09:30:00Z",
        "submittedByType": "PARTNER_USER",
        "isDuplicate": true,
        "archived": true,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z"
      }
    ],
    "page": 1,
    "perPage": 1,
    "totalItems": 1
  },
  "timestamp": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://api.jazzhq.ai/api/v1/vendors/partners/1/leads"

headers = {"X-API-KEY": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.jazzhq.ai/api/v1/vendors/partners/1/leads';
const options = {method: 'GET', headers: {'X-API-KEY': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jazzhq.ai/api/v1/vendors/partners/1/leads"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.jazzhq.ai/api/v1/vendors/partners/1/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.jazzhq.ai/api/v1/vendors/partners/1/leads")
  .header("X-API-KEY", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.jazzhq.ai/api/v1/vendors/partners/1/leads', [
  'headers' => [
    'X-API-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.jazzhq.ai/api/v1/vendors/partners/1/leads");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-KEY", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-KEY": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.jazzhq.ai/api/v1/vendors/partners/1/leads")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```