---
title: "List All Prospects"
method: GET
path: "/v1/prospects"
tags: ["Prospects"]
---

# List All Prospects

`GET /v1/prospects`

List All Prospects

## Query parameters

- `search_by` string, nullable — Field name to search by
- `search_value` string, nullable — Value to search for in the specified field
- `status` string, nullable — Filter by status
- `sort_by` string, nullable — Field to sort by
- `sort_order` 'asc' | 'desc'
- `skip` integer — Number of records to skip
- `limit` integer — Maximum number of records to return

## Response `200`

List of prospects retrieved successfully

- ProspectOutput[]
  - `id` string, required
  - `orgId` string
  - `name` string, nullable
  - `email` string, nullable
  - `phoneNumber` string, nullable
  - `externalReference` ExternalReference[], nullable, required
    - `providerName` string, required — External service provider name
    - `id` string, required — External service identifier
    - `providerProps` object, nullable — Props for the external reference
  - `status` string, required
  - `prospectProps` object, nullable, required
  - `createdBy` string
  - `createdAt` string, date-time
  - `updatedBy` string
  - `updatedAt` string, date-time

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/tratahq/apis/trata-ai-api.md) · [All operations](https://skmtc.net/tratahq/apis/trata-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tratahq/trata-ai-api/revisions/8f7b69ee5a90/schema)