---
title: "List synced Yelp leads for the current user"
method: GET
path: "/app/yelp/leads"
tags: ["App Yelp"]
---

# List synced Yelp leads for the current user

`GET /app/yelp/leads`

## Request

- Base URL: `https://api.optimyzee.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.optimyzee.com/app/yelp/leads`
- Auth: none declared
- TypeScript: <https://skmtc.dev/optimyzee/apis/optimyzee-api/docs/app/yelp/leads/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `businessId` string
- `status` string
- `limit` integer

## Response `200`

OK

- AppYelpLeadSchema[]
  - `id` string, required
  - `businessId` string, nullable, required
  - `businessName` string, nullable, required
  - `conversationId` string, nullable, required
  - `consumer` string, nullable, required
  - `type` string, required
  - `excerpt` string, nullable, required
  - `status` string, required
  - `responseMinutes` integer, nullable, required
  - `createdAt` string, nullable, required
  - `lastEventAt` string, nullable, required
  - `conversationMessages` object[], required
  - `timelineEvents` object[], required
  - `replyDraftId` integer, nullable, required
  - `replyDraftStatus` string, nullable, required
  - `replyDraftBody` string, nullable, required
  - `replyDraftMessage` string, nullable, required
  - `replyDraftGeneratedAt` string, nullable, required
  - `assignedUserId` integer, nullable
  - `assignedUserName` string, nullable
  - `claimedAt` string, nullable
  - `phoneShared` boolean
  - `sharedPhone` string, nullable
  - `phoneSource` string, nullable: opt_in | conversation
  - `emailShared` boolean
  - `sharedEmail` string, nullable
  - `emailSource` string, nullable: opt_in | conversation
  - `businessTimezone` string, nullable: IANA timezone of the business (autoresponder setting, else its US state) — show lead times in the client's local clock

---

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