---
title: "List leads in a data collection"
method: GET
path: "/data-collections/{id}/leads"
tags: ["Data collections"]
---

# List leads in a data collection

`GET /data-collections/{id}/leads`

## Request

- Base URL: `https://api.flogpt.com/api/v1`
- URL: `https://api.flogpt.com/api/v1/data-collections/{id}/leads`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-api-key`

The rows of the collection, ordered by row number. Use `updatedSince` to
pull only what has changed since a previous sync.

## Query parameters

- `page` integer
- `limit` integer
- `status` 'new' | 'contacted' | 'callback' | 'won' | 'lost'
- `updatedSince` string, date-time

## Response `200`

Lead page

- object: The envelope every paginated list endpoint returns.
  - `data` object[], required
    - `id` string
    - `rowNumber` integer
    - `name` string, nullable
    - `phone` string, nullable
    - `email` string, nullable
    - `company` string, nullable
    - `status` 'new' | 'contacted' | 'callback' | 'won' | 'lost' | 'null', nullable
    - `potential` 'hot' | 'warm' | 'cold' | 'null', nullable
    - `followUpAt` string, date-time, nullable
    - `tags` string[]
    - `optedOut` boolean: Suppresses every automated outbound send for this lead.
    - `assignedToUserId` string, nullable
    - `statusEnteredAt` string, date-time, nullable
    - `firstContactedAt` string, date-time, nullable
    - `lastContactedAt` string, date-time, nullable
    - `fields` object
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
  - `page` integer, required
  - `limit` integer, required
  - `total` integer, required: Matching records across all pages.

## Other responses

- `400`: The request is invalid.
- `404`: The resource does not exist in the API key's organization.

---

[API](https://skmtc.dev/flogpt/apis/flogpt-organization-api.md) · [All operations](https://skmtc.dev/flogpt/apis/flogpt-organization-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flogpt/apis/flogpt-organization-api/revisions/c3a6cff76797?raw)
