BizKitHub Developer Documentation

Parameters

7 query

Query parameters

· 7

limitnumberOptional

Maximum items per page.

Example50

pagenumberOptional

Page number (1-based).

Example1

Lead pipeline status.

source"web_form" | "phone" | "email" | "referral" | "other"Optional

How the lead was acquired.

assignedMemberIdstringOptional

Filter by assigned member ID.

Exampleexample_assignedMemberId

fulltextQuerystringOptional

Search across subject, description, customer name and email.

Exampleexample_fulltextQuery

orderBystringOptional

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

Exampleexample_orderBy

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

idnumberRequired

Lead ID.

Lead pipeline status.

source"web_form" | "phone" | "email" | "referral" | "other"Required

How the lead was acquired.

subjectstringRequired

Lead subject/title.

estimatedValuenumber | nullRequired

One of 2:

Variant 1

number

Estimated deal value.

Variant 2

null

followUpDateDate | string | string | number | nullRequired

One of 2:

Variant 1

Date | string | string | number

Next follow-up date.

One of 4:

Variant 1

Date

Next follow-up date.

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

Variant 2

null

insertedDateDate | string | string | numberRequired

When the lead was created.

One of 4:

Variant 1

Date

When the lead was created.

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

updatedDateDate | string | string | numberRequired

Last update.

One of 4:

Variant 1

Date

Last update.

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

closedDateDate | string | string | number | nullRequired

One of 2:

Variant 1

Date | string | string | number

When the lead was closed (won/lost).

One of 4:

Variant 1

Date

When the lead was closed (won/lost).

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

Variant 2

null

customerobject | nullRequired

One of 2:

Variant 1

externalIdstringRequired

emailstring | nullRequired

One of 2:

Variant 1

string

Customer e-mail. null for phone-only customers and anonymised contacts.

Variant 2

null

namestringRequired

Variant 2

null

assignedMemberNamestring | nullRequired

One of 2:

Variant 1

string

Name of assigned sales rep.

Variant 2

null

itemCountnumberRequired

Total matching leads.

Response example

application/json

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

/bff/lead/list

Parameters

Query parameters

Response schema

Response example

Request example

Need an API key?