Sign in

v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Leads

Retrieve a lead

Retrieves the details of an existing lead. You need only supply the unique lead key that was returned upon lead creation.

get/v2/leads/{lead_key}

Path parameters

lead_keystring required

A unique key that identifies this lead. Can be either the lead's external_key or key value.

Response

Retrieves the details of an existing lead. You need only supply the unique lead key that was returned upon lead creation.

messagestring required
statusinteger required

Example response

{
  "data": {
    "created_at": 1574181282399,
    "key": "co_a80cb515fe",
    "updated_at": 1574181282399,
    "amount": 25000,
    "customer_key": "cus_1234",
    "external_key": "361ba21c-ca87-46b0-baa4-97ca16e55059",
    "fields": [
      {
        "field_key": "field_fjkdlrh9i32nfew",
        "name": "Company Address"
      }
    ],
    "meta": {
      "company": "Lockman Olson",
      "email": "River96@example.com",
      "first_name": "River",
      "last_name": "Tremblay"
    },
    "partner_key": "bertramgilfoyle",
    "stage_data": {
      "api_name": "closed won",
      "name": "Closed Won"
    },
    "status": "open",
    "team": {
      "created_at": 1574181282399,
      "key": "co_a80cb515fe",
      "updated_at": 1574181282399,
      "name": "Tushar"
    },
    "team_member": {
      "created_at": 1574181282399,
      "key": "co_a80cb515fe",
      "updated_at": 1574181282399,
      "email": "tushten@partnerstack.com",
      "first_name": "Tushar",
      "last_name": "Sutherland",
      "personal_stack_key": "stck_1234567890"
    }
  }
}