Get lead

GET 
/leads/:lead_id

Get lead

Request

Path Parameters

lead_id stringrequired
Example: 82de27cb-6f8c-4278-b783-82d1d916eddc

Query Parameters

include_raw_data boolean
Whether to include raw data fetched from the 3rd party provider.
Example: true

Header Parameters

x-customer-id stringrequired
The customer ID that uniquely identifies the customer in your application
Example: my-customer-1
x-provider-name stringrequired
The provider name
Example: salesforce

Responses

200

Lead

application/json

Schema

Schema

addresses object[]required
Array [
address_type stringrequired
Possible values: [primary, mailing, other, billing, shipping]
city stringnullablerequired
country stringnullablerequired
postal_code stringnullablerequired
state stringnullablerequired
street_1 stringnullablerequired
street_2 stringnullablerequired
]
company stringnullablerequired
converted_account_id stringnullablerequired
converted_account object
addresses object[]required
Array [
address_type stringrequired
Possible values: [primary, mailing, other, billing, shipping]
city stringnullablerequired
country stringnullablerequired
postal_code stringnullablerequired
state stringnullablerequired
street_1 stringnullablerequired
street_2 stringnullablerequired
]
description stringnullablerequired
id stringrequired
industry stringnullablerequired
last_activity_at date-timenullablerequired
name stringnullablerequired
number_of_employees integernullablerequired
owner_id stringnullablerequired
phone_numbers object[]required
Array [
phone_number stringnullablerequired
phone_number_type stringrequired
Possible values: [primary, mobile, fax, other]
]
lifecycle_stage lifecycle_stagenullablerequired
Possible values: [subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer, evangelist, other]
website stringnullablerequired
created_at date-timenullablerequired
updated_at date-timenullablerequired
is_deleted booleanrequired
last_modified_at date-timerequired
converted_contact_id stringnullablerequired
converted_contact object
account_id stringnullablerequired
owner_id stringnullablerequired
addresses object[]required
Array [
address_type stringrequired
Possible values: [primary, mailing, other, billing, shipping]
city stringnullablerequired
country stringnullablerequired
postal_code stringnullablerequired
state stringnullablerequired
street_1 stringnullablerequired
street_2 stringnullablerequired
]
email_addresses object[]required
Array [
email_address stringrequired
email_address_type stringrequired
Possible values: [primary, work, other]
]
first_name stringnullablerequired
id stringrequired
last_activity_at date-timenullablerequired
last_name stringnullablerequired
phone_numbers object[]required
Array [
phone_number stringnullablerequired
phone_number_type stringrequired
Possible values: [primary, mobile, fax, other]
]
lifecycle_stage lifecycle_stagenullablerequired
Possible values: [subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer, evangelist, other]
created_at date-timenullablerequired
updated_at date-timenullablerequired
is_deleted booleanrequired
last_modified_at date-timerequired
raw_data object
property name* any
converted_date date-timenullablerequired
email_addresses object[]
Array [
email_address stringrequired
email_address_type stringrequired
Possible values: [primary, work, other]
]
first_name stringnullable
id stringrequired
last_name stringnullablerequired
lead_source stringnullablerequired
owner_id stringnullablerequired
phone_numbers object[]required
Array [
phone_number stringnullablerequired
phone_number_type stringrequired
Possible values: [primary, mobile, fax, other]
]
title stringnullablerequired
created_at date-timenullablerequired
updated_at date-timenullablerequired
is_deleted booleanrequired
last_modified_at date-timerequired

Example (from schema)

{
  "addresses": [
    {
      "address_type": "shipping",
      "city": "San Francisco",
      "country": "US",
      "postal_code": "94107",
      "state": "CA",
      "street_1": "525 Brannan",
      "street_2": null
    }
  ],
  "company": "Supaglue",
  "converted_account_id": "88cc44ca-7a34-4e8b-b0da-51c3aae34daf",
  "converted_account": {
    "addresses": [
      {
        "address_type": "shipping",
        "city": "San Francisco",
        "country": "US",
        "postal_code": "94107",
        "state": "CA",
        "street_1": "525 Brannan",
        "street_2": null
      }
    ],
    "description": "Integration API",
    "id": 1234,
    "industry": "API's",
    "last_activity_at": "2022-02-27T00:00:00Z",
    "name": "Sample Customer",
    "number_of_employees": 276000,
    "owner_id": "d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69",
    "phone_numbers": [
      {
        "phone_number": "+14151234567",
        "phone_number_type": "primary"
      }
    ],
    "lifecycle_stage": "subscriber",
    "website": "https://supaglue.com/",
    "created_at": "2022-02-27T00:00:00Z",
    "updated_at": "2022-02-27T00:00:00Z",
    "is_deleted": false,
    "last_modified_at": "2022-02-27T00:00:00Z"
  },
  "converted_contact_id": "8c8de778-a219-4d6c-848c-1d57b52149f6",
  "converted_contact": {
    "account_id": "fd089246-09b1-4e3b-a60a-7a76314bbcce",
    "owner_id": "23e640fe-6105-4a11-a636-3aa6b6c6e762",
    "addresses": [
      {
        "address_type": "shipping",
        "city": "San Francisco",
        "country": "US",
        "postal_code": "94107",
        "state": "CA",
        "street_1": "525 Brannan",
        "street_2": null
      }
    ],
    "email_addresses": [
      {
        "email_address": "hello@supaglue.com",
        "email_address_type": "work"
      }
    ],
    "first_name": "George",
    "id": 54312,
    "last_activity_at": "2022-02-27T00:00:00Z",
    "last_name": "Xing",
    "phone_numbers": [
      {
        "phone_number": "+14151234567",
        "phone_number_type": "primary"
      }
    ],
    "lifecycle_stage": "subscriber",
    "created_at": "2022-02-27T00:00:00Z",
    "updated_at": "2022-02-27T00:00:00Z",
    "is_deleted": false,
    "last_modified_at": "2022-02-27T00:00:00Z",
    "raw_data": {}
  },
  "converted_date": "2023-02-27T00:00:00Z",
  "email_addresses": [
    {
      "email_address": "hello@supaglue.com",
      "email_address_type": "work"
    }
  ],
  "first_name": "George",
  "id": 54312,
  "last_name": "Xing",
  "lead_source": "API Blogger",
  "owner_id": "62e5e0f7-becd-4ae2-be82-8b4e1d5ed8a2",
  "phone_numbers": [
    {
      "phone_number": "+14151234567",
      "phone_number_type": "primary"
    }
  ],
  "title": "Co-Founder",
  "created_at": "2023-02-10T00:00:00Z",
  "updated_at": "2023-02-10T00:00:00Z",
  "is_deleted": false,
  "last_modified_at": "2022-02-27T00:00:00Z"
}

Loading...