Get enquiry logs

POST

/api/v1/Lead/getEnquiryLog

Retrieve a list of leads/enquiries based on filter criteria

Authorizations

• Bearer

Request Body ^required

Filter criteria for the enquiry log

Filter options for retrieving enquiry logs

object

fromDate

Start date for the filter (optional)

string | null format: date-time

Example

2026-01-01T00:00:00Z

toDate

End date for the filter (optional)

string | null format: date-time

Example

2026-02-01T00:00:00Z

dealershipCode

Specific dealership code to filter by (optional)

string | null

Example

AKL01

Example

{
  "fromDate": "2026-01-01T00:00:00Z",
  "toDate": "2026-02-01T00:00:00Z",
  "dealershipCode": "AKL01"
}

Responses

200

List of enquiries

Array<object>

Details of a lead/enquiry

object

branch

Keys/branch identifier

string | null

Example

Christchurch

type

required

Type of the enquiry (e.g. General, TestDrive)

string

Allowed values: General PhoneCall FinanceLead TestDrive TradeIn Watchlist

Example

TestDrive

createdAt

required

When the enquiry was created

string format: date-time

Example

2026-02-15T14:30:00Z

phone

Contact phone number

string | null

Example

0211234567

email

Contact email address

string | null

Example

[email protected]

message

Enquiry message content

string | null

Example

I'd like to book a test drive.

name

Name of the person enquiring

string | null

Example

Jane Doe

listingId

Optional vehicle identifier

integer | null format: int32

Example

105

stockNumber

Stock number of the vehicle

string | null

Example

STOCK-001

Example

{
  "branch": "Christchurch",
  "type": "TestDrive",
  "createdAt": "2026-02-15T14:30:00Z",
  "phone": "0211234567",
  "email": "[email protected]",
  "message": "I'd like to book a test drive.",
  "name": "Jane Doe",
  "listingId": 105
}