LeadList

Paginated list of leads

  • currentPage
    Type: integer

    Current page number

  • data
    Type: array object[] ยท Lead[]

    Array of leads

    Lead object representing a potential customer or client

    • firstName
      Type: string
      required

      Lead's first name

    • id
      Type: integer
      read-only
      required

      Unique identifier for the lead

    • lastName
      Type: string
      required

      Lead's last name

    • accountId
      Type: string

      ID of the account that owns this lead

    • applicationId
      Type: string

      Optional application ID associated with this lead

    • archived
      Type: boolean

      Whether the lead is archived

    • assignedTo
      Type: string

      User assigned to this lead. If not provided, will be automatically assigned using lead rotation if available.

    • auditLog
      Type: array object[]
      read-only

      Comprehensive audit log of all significant events and actions performed on the lead

    • branch
      Type: string

      Branch location

    • buyingRole
      Type: string

      Lead's role in buying decisions

    • company
      Type: string

      Company name

    • createdAt
      Type: stringFormat: date-time
      read-only

      When the lead was created

    • createdBy
      Type: string

      Email of the user who created the lead

    • currentPaymentProcessor
      Type: string

      Lead's current payment processor

    • email
      Type: string

      Lead's email address

    • imgSrc
      Type: string

      URL to lead's profile image

    • interestedInSwitching
      Type: boolean

      Whether the lead is interested in switching services

    • jobTitle
      Type: string

      Lead's job title

    • lastContacted
      Type: stringFormat: date-time

      Date and time of last contact with this lead

    • leadSourceId
      Type: integer

      ID of the lead source associated with this lead. Required if the team has lead sources, unless skipTeamAndSourceRequirement=true.

    • location
      Type: string

      Geographic location

    • monthlyTransactionVolume
      Type: integer

      Monthly transaction volume in dollars

    • notes
      Type: string

      General notes about the lead

    • numberOfEmployees
      Type: integer

      Number of employees at the lead's company

    • phone
      Type: string

      Lead's phone number

    • position
      Type: string

      Position within company

    • processStage
      Type: string

      Current stage in the sales process

    • productsServicesSold
      Type: string

      Products or services the lead sells

    • source
      Type: string

      Text description of lead source

    • teamId
      Type: integer

      ID of the team associated with this lead. Required if teams exist in the account, unless skipTeamAndSourceRequirement=true.

    • updatedAt
      Type: stringFormat: date-time
      read-only

      When the lead was last updated

  • totalCount
    Type: integer

    Total number of leads matching the query

  • totalPages
    Type: integer

    Total number of pages