DocsAPI ReferenceLead/bff/lead/list
getLeadAdmin BFF

/bff/lead/list

Returns a paginated list of leads/inquiries with customer and assignee info. Supports filtering by status, source, assigned member, and full-text search.

LeadgetBffLeadList

Parameters

7 query

7 total
Query · 7
limitnumber

Maximum items per page.

pagenumber

Page number (1-based).

statusstring | string | string | string | string | string | string

Lead pipeline status.

sourcestring | string | string | string | string

How the lead was acquired.

assignedMemberIdstring

Filter by assigned member ID.

fulltextQuerystring

Search across subject, description, customer name and email.

orderBystring

Sort field:direction (e.g. "insertedDate:desc", "estimatedValue:asc", "followUpDate:asc").

Request

GET /bff/lead/list

get
curl -X GET "https://api.bizkithub.com/bff/lead/list?limit=50&page=1&assignedMemberId=example_assignedMemberId&fulltextQuery=example_fulltextQuery&orderBy=example_orderBy" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "items": [
    {
      "id": 0,
      "subject": "example_subject"
    }
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key