Leads

Get a lead

Path

• leadIdstringRequired

  The lead.

Answer

200 OK The lead.

• dataLeadRequired
  Inside it

  • idstringRequired
  • firstNamestringRequired
  • lastNamestringRequired
  • fullNamestringRequired
  • titlestringRequired
  • companystringRequired
  • companyShortstringRequired

    What {{company_short}} (and {{company_name}}) say for this lead in messages: the short name set for them, or the company name cleaned up (no Inc., no tagline).

  • companyShortSetbooleanRequired

    A short company name was set for this lead; false means the automatic one.

  • locationstringRequired
  • industrystringRequired
  • linkedinUrlstringRequired
  • emailstring or nullRequired

    A found email, when it is usable.

  • emailStatusstring or nullRequired

    One of deliverable, catch_all, unknown.

  • statusstringRequired

    One of new, queued, contacted, connected, replied, suppressed.

  • stagestringRequired

    Where the person is, as the Leads table’s Stage column says it: Blacklisted or Do not contact (suppressed) first, then an outcome you recorded (interested, qualified, booked, attended, won, no_show, lost), then Interested or Not interested from tags and AI reply tags, else the automatic status (new, queued, contacted, connected, replied). One of new, queued, contacted, connected, replied, interested, qualified, booked, attended, won, not_interested, no_show, lost, suppressed, blacklisted.

  • tagsarray of stringRequired
  • customFieldsobjectRequired

    The lead's custom field values by field key: text, numbers, dates as YYYY-MM-DD, web addresses, and lists for Multi-select fields.

  • listsarray of objectRequired
    Each item

    • idstringRequired

      The list's ID.

    • namestringRequired

      The list's name.

  • fromPostobject or nullRequired

    The LinkedIn post this person liked or commented on when they were saved from it (Posts › Engagers), kept beside how they were first added. Null when they weren't saved from a post.

    Inside it

    • postUrlstringRequired
    • topicstring or nullRequired

      What the post was about, in the workspace's words: what {{post_topic}} says in messages.

    • interactionstringRequired

      One of like, comment.

    • commentstring or nullRequired

      Their comment, up to 300 characters.

    • yourPostbooleanRequired

      The post is one of the workspace's own.

    • engagedAtstring · date-timeRequired
    • savedAtstring · date-timeRequired
  • createdAtstring · date-timeRequired
  • updatedAtstring · date-timeRequired

    The last time anything about this person changed: their details, lists or tags, an email found, outreach or a reply. What updatedSince filters on.

  • campaignsarray of LeadCampaignRequired
    Each item

    • campaignobjectRequired
      Inside it

      • idstringRequired
      • namestringRequired
      • statusstringRequired

        draft: not launched. active: running. paused: stopped by the owner. completed: finished. One of draft, active, paused, completed.

    • statusstringRequired

      Where the person is in a campaign. One of active, waiting_for_acceptance, retrying, paused, needs_review, replied, suppressed, finished, stopped.

    • stepintegerRequired

      The step they are on, from 1.

    • stepsintegerRequired
    • senderobject or nullRequired

      The LinkedIn account reaching out.

      Inside it

      • idstring
      • namestring
    • connectionRequestSentAtstring · date-time or nullRequired
    • acceptedAtstring · date-time or nullRequired
    • lastContactedAtstring · date-time or nullRequired
    • messagesSentintegerRequired
    • repliedAtstring · date-time or nullRequired
    • finishedAtstring · date-time or nullRequired
    • nextStepAtstring · date-time or nullRequired

      When the next step is due, while active.

    • pausedReasonstring or nullRequired

Errors

• 401 Unauthorizedunauthorized
• 404 Not foundnot_found not_in_campaign
• 429 Too many requestsrate_limited
• 500 Server errorserver_error

Every error has the same shape. See Errors.