Find paginated Lead Events

GET

leadEvents

curl --request GET \
  --url https://commerce.driv.ly/api/leadEvents \
  --header 'Authorization: <api-key>'

{
  "docs": [
    {
      "lead": 123,
      "type": "Cancel",
      "status": "Provide Customer With Three Options",
      "nextSteps": "<string>",
      "createdBy": 123,
      "currentStatusFor": 123,
      "updatedAt": "<string>",
      "createdAt": "<string>"
    }
  ],
  "totalDocs": 123,
  "limit": 123,
  "totalPages": 123,
  "page": 123,
  "pagingCounter": 123,
  "hasPrevPage": true,
  "hasNextPage": true,
  "prevPage": 123,
  "nextPage": 123
}

Make sure you install our SDK first. You can find out how, and more here.

import { SDK } from '@drivly/commerce'
import type { leadEvents } from '@drivly/commerce'

const sdk = new SDK(...)

const leadEvents = await sdk.leadEvents.find(): Promise<leadEvents[]>

Authorizations

Authorization

string

header

required

Query Parameters

depth

number

number of levels to automatically populate relationships and uploads

locale

string

retrieves document(s) in a specific locale

fallback-locale

string

specifies a fallback locale if no locale value exists

sort

string

sort by field

where

object

pass a where query to constrain returned documents (complex type, see documentation)

limit

number

limit the returned documents to a certain number

page

number

get a specific page of documents

Response

200 - application/json

docs

object[]

required

totalDocs

number

required

limit

number

required

totalPages

number

required

page

number

required

pagingCounter

number

required

hasPrevPage

boolean

required

hasNextPage

boolean

required

number

Update an existing Trade Payoff Balance Create a new Lead Event

curl --request GET \
  --url https://commerce.driv.ly/api/leadEvents \
  --header 'Authorization: <api-key>'

{
  "docs": [
    {
      "lead": 123,
      "type": "Cancel",
      "status": "Provide Customer With Three Options",
      "nextSteps": "<string>",
      "createdBy": 123,
      "currentStatusFor": 123,
      "updatedAt": "<string>",
      "createdAt": "<string>"
    }
  ],
  "totalDocs": 123,
  "limit": 123,
  "totalPages": 123,
  "page": 123,
  "pagingCounter": 123,
  "hasPrevPage": true,
  "hasNextPage": true,
  "prevPage": 123,
  "nextPage": 123
}

Commerce

Resources

API Reference

Find paginated Lead Events

Authorizations

Query Parameters

Response