Lead

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

    • account_id
      Type: string

      Account ID associated with the action

    • apiKey
      Type: string nullable

      API key identifier if the action was performed via API key authentication

    • created
      Type: stringFormat: date-time

      Timestamp when the event occurred

    • data
      Type: object

      Event-specific data containing details about what was changed or accessed (structure varies by event type)

    • event
      Type: string

      Type of event (e.g., lead_created, lead_updated, lead_archived, lead_converted)

    • id
      Type: integer

      Unique identifier for the audit log entry

    • requestHeaders
      Type: object

      Sanitized HTTP headers from the request (sensitive values are masked)

    • requestIpAddress
      Type: string

      IP address of the request origin

    • requestMethod
      Type: string

      HTTP method used (GET, POST, PATCH, DELETE)

    • requestPath
      Type: string

      API endpoint path that was called

    • user
      Type: string

      Email address or identifier of the user who performed the action

  • 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