Leads

List leads

Returns inbound leads from your website forms, hosted contact pages, and inbound email address. Filter by boardId to narrow to one board, and by triageStatus to filter the inbox (e.g. only new to mimic the unread tray).

Leads and Deals are separate objects — see the API description for the lifecycle. Promote a Lead to a Deal via POST /v1/leads/{id}/promote.

get/v1/leads

Request

  • Base URL: https://app.getdealboard.com
  • URL: https://app.getdealboard.com/v1/leads
  • Auth: HTTP bearer

Query parameters

limitinteger

Max number of items per page (1-100).

cursorstring

Opaque cursor from a previous response's nextCursor.

boardIdstring uuid

Filter to leads on this board.

triageStatus'new' | 'contacted' | 'promoted' | 'junk' | 'bad_fit' | 'stale'

Filter to one triage status. Unknown values return an empty list (forward-compatible — clients can pre-filter without coupling to the enum).

qstring

Case-insensitive substring search over company name, company website, work email, first name and last name. The lookup to use for "has this company ever contacted us?" — it searches the whole workspace server-side, so an empty result means no match.

Response

OK

hasMoreboolean required
nextCursorstring nullable required

Pass as ?cursor= on the next request to fetch the next page.

Changes

No recorded changes to this operation across all 1 revision of this API.