Get a Lead

Returns a lead in the workspace, with its linked profile details and a reference to its current company.

The id path parameter is a numeric identifier. Pass the lead_id returned by other v2 endpoints, such as the Signals endpoints — don't guess, hard-code, or reuse an id from another workspace.

A lead with no linked profile is returned with the profile fields set to null. When the current company cannot be resolved, company is null. Neither case is an error.

Get a lead

GET/api/v2/partner/workspaces/{partner_workspace_id}/leads/{id}

Path parameters

Parameter	Type	Description
partner_workspace_id	string	Opaque workspace identifier from the partner system.
id	integer	Id of the lead.

Example request

curl "https://api.getsillage.com/api/v2/partner/workspaces/ws_123/leads/901" \
  -H "Authorization: Bearer $SILLAGE_API_KEY"

Example response

{
  "data": {
    "id": 901,
    "first_name": "Jane",
    "last_name": "Doe",
    "linkedin_url": "https://linkedin.com/in/janedoe",
    "linkedin_handle": "janedoe",
    "linkedin_headline": "VP Product at Acme",
    "avatar_url": "https://media.licdn.com/janedoe.jpg",
    "email": "jane.doe@acme.com",
    "phone": null,
    "position": "VP Product",
    "location": "Paris, France",
    "geo": {
      "city": "Paris",
      "region": "Ile-de-France",
      "country": "France",
      "country_code": "FR"
    },
    "company": {
      "id": 456,
      "name": "Acme Inc",
      "domain": "acme.com",
      "linkedin_url": "https://www.linkedin.com/company/acme",
      "linkedin_handle": "acme",
      "activity_summary": "Acme sells collaboration software to mid-market teams.",
      "employee_range": "51-200",
      "location": "Paris, France"
    },
    "experiences": [
      {
        "title": "VP Product",
        "company_name": "Acme Inc",
        "company_linkedin_url": "https://www.linkedin.com/company/acme",
        "location": "Paris, France",
        "start_date": "2023-01-01",
        "end_date": null,
        "is_current": true
      }
    ]
  }
}

Response fields

Field	Type	Description
id	integer	Id of the lead.
first_name	string or null	First name.
last_name	string or null	Last name.
linkedin_url	string or null	LinkedIn profile URL.
linkedin_handle	string or null	LinkedIn profile handle (slug).
linkedin_headline	string or null	LinkedIn headline.
avatar_url	string or null	Profile picture URL.
email	string or null	Email address, when known.
phone	string or null	Phone number, when known.
position	string or null	Current job title.
location	string or null	Location as a display string.
geo	object or null	Structured location. `null` when no structured location could be resolved — not an error.
geo.city	string or null	City.
geo.region	string or null	Region or state.
geo.country	string or null	Country.
geo.country_code	string or null	ISO country code.
company	object or null	The lead's current company, when one can be resolved. `null` when the lead has no linked profile, no current company, or that company is not tracked in this workspace — not an error.
company.id	integer	This company's id in the workspace. Pass it to Get a company.
company.name	string or null	Company name.
company.domain	string or null	Company domain.
company.linkedin_url	string or null	Company LinkedIn URL.
company.linkedin_handle	string or null	Company LinkedIn handle.
company.activity_summary	string or null	A short summary of the company's activity.
company.employee_range	string or null	Employee headcount range, e.g. `51-200`.
company.location	string or null	Company location.
experiences	array or null	LinkedIn work history, in LinkedIn source order, including the current role. `null` when no work history is available for this lead — not an error.
experiences[].title	string or null	Job title.
experiences[].company_name	string or null	Employer name.
experiences[].company_linkedin_url	string or null	Employer LinkedIn URL.
experiences[].location	string or null	Job location.
experiences[].start_date	string or null	Start date.
experiences[].end_date	string or null	End date. `null` for the current role.
experiences[].is_current	boolean	Whether this is the lead's current role. Use this flag to identify it — do not assume it is the first entry.

Errors

Status	Meaning
400	Invalid path parameters.
401	The master key is missing or invalid.
404	No lead found for this `id`.
429	Too many requests.
500	An unexpected server error occurred.

Error responses use RFC 9457 problem documents with Content-Type: application/problem+json.