For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Lead (v2)

Retrieve a fully-hydrated snapshot of a single lead by its UUID. The response shape is the same as each result in Search Leads, with the addition of duplicatedConnections.

Authentication

Pass your customer-managed API key in the Authorization header.

Authorization: <your-api-key>

If you are using an OAuth2 token instead:

Authorization: Bearer <oauth2-token>

Endpoint

GET https://api.popl.co/api/pub/v2/leads/:leadId

Path Parameters

  • leadId — UUID of the lead to retrieve

Response

{
  "data": {
    "leadId": "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee",
    "legacyLeadId": "1547",
    "assignedMembers": [4822],
    "systemFields": {
      "leadId": "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee",
      "legacyLeadId": "1547",
      "ownerId": "owner-uuid-1",
      "captureDatetime": "2024-01-15T10:30:00.000Z",
      "gdprConsentDatetime": null,
      "requestId": null,
      "userPid": 7891,
      "email": "[email protected]",
      "salutation": null,
      "firstName": "John",
      "middleName": null,
      "lastName": "Smith",
      "nickname": null,
      "suffix": null,
      "fullName": "John Smith",
      "profileImageUrl": null,
      "businessCardImageUrl": null,
      "appToAppProfileUrl": null,
      "jobTitle": "Head of Strategy",
      "website": "https://abcindustries.com",
      "note": "Met at booth 42",
      "linkedinUrl": "https://linkedin.com/in/johnsmith",
      "campaignId": 101,
      "companyName": "ABC Industries",
      "companyEmail": null,
      "companyDescription": null,
      "companyFoundingYear": null,
      "companyNaicsCode": null,
      "companyType": null,
      "companyLinkedin": null,
      "companySize": null,
      "companyIndustry": null,
      "companyAnnualRevenue": null,
      "companyTotalFunding": null,
      "monthlyWebsiteVisitors": null,
      "technologiesUsed": null,
      "companyCountry": null,
      "companyFormattedAddress": null,
      "companyStreetAddress1": null,
      "companyStreetAddress2": null,
      "companyCity": null,
      "companyState": null,
      "companyPostalCode": null,
      "companyStateCode": null,
      "companyCountryCode": null,
      "leadCountry": "US",
      "leadFormattedAddress": null,
      "leadStreetAddress1": null,
      "leadStreetAddress2": null,
      "leadCity": null,
      "leadState": null,
      "leadPostalCode": null,
      "leadStateCode": null,
      "leadCountryCode": null,
      "leadSource": "QR_CODE_SCAN",
      "enrichedKeys": [],
      "lat": null,
      "lng": null
    },
    "userDefinedFields": [
      {
        "udfDefinitionId": "udf-def-uuid-1",
        "type": "TEXT",
        "selectOptions": null,
        "selectedValues": null,
        "label": "Interested In",
        "value": "Enterprise Plan",
        "attachment": null,
        "isHidden": false,
        "attributeCategory": "UDF",
        "legacyQualifierId": null
      }
    ],
    "tags": [
      { "id": 12, "value": "VIP", "archived": false }
    ],
    "phoneNumbers": [
      {
        "value": "+15551234567",
        "type": "MOBILE",
        "originalNumberLabel": null,
        "enrichmentType": null
      }
    ],
    "crmExportData": [
      {
        "exportId": "export-uuid-1",
        "integrationPlatform": "salesforce",
        "crmLink": "https://na1.salesforce.com/003abc",
        "nativeIntegrationId": null,
        "legacyIntegrationId": 5,
        "exportType": "CONTACT",
        "exportedAt": "2024-02-01T09:00:00.000Z"
      }
    ],
    "systemFieldLabelOverrides": {},
    "duplicatedConnections": [
      {
        "legacyLeadId": "1548",
        "assignedMemberId": 4823,
        "leadId": "bbbbbbbb-cccc-4ddd-8eee-ffffffffffff",
        "leadData": {
          "name": "John Smith",
          "email": "[email protected]",
          "profileImageUrl": null,
          "leadSource": "APP_TO_APP",
          "createdAt": "2024-01-16T08:00:00.000Z"
        },
        "memberData": {
          "name": "Sarah - Sales @ Popl",
          "email": "[email protected]",
          "profileImageUrl": "https://cdn.popl.co/4823-icon.jpg"
        }
      }
    ],
    "memberDetails": [
      {
        "memberId": 4822,
        "name": "Jason - CEO @ Popl",
        "email": "[email protected]",
        "profileImageUrl": "https://cdn.popl.co/4822-icon.jpg"
      }
    ],
    "campaignDetails": { "name": "Dreamforce 2024" },
    "templateDetails": { "name": "Sales Card" },
    "calendarLinks": [
      {
        "id": "cal-link-uuid-1",
        "url": "https://calendly.com/jason/30min?name=John+Smith&email=john.smith%40gmail.com",
        "label": "Book a 30-min call"
      }
    ],
    "calendarBookings": [
      {
        "id": "booking-uuid-1",
        "calendarLinkId": "cal-link-uuid-1",
        "startTime": "2024-02-10T14:00:00.000Z",
        "endTime": "2024-02-10T14:30:00.000Z"
      }
    ]
  }
}

Notes

  • leadId must be a valid UUID

  • assignedMemberId, memberData, and systemFields.assignedMemberId are not returned in the pub/v2 response — use assignedMembers and memberDetails instead

  • duplicatedConnections lists other lead records sharing the same email within the same owner account, indicating the contact scanned multiple team members

  • calendarLinks URLs are pre-filled with the lead's contact details (name, email, company) where supported by the scheduling provider

  • userDefinedFields includes full UDF definitions (label, type, options) alongside their current values

  • systemFieldLabelOverrides reflects any team-level renames applied to standard field labels; fields with no override are omitted or null

  • Authorization is evaluated per lead: the requester must be the assigned member, or hold team admin scope over that member. If shareLeads is disabled on the team, only the assigned member may access the lead

Errors

  • 400 INVALID_REQUESTleadId path parameter is not a valid UUID

  • 401 TOKEN_UNAUTHORIZED — API key is missing, invalid, or the requester lacks access to this lead

  • 404 LEAD_NOT_FOUND — No lead with the given UUID exists, or it has been deleted

Last updated