Get a single Lead | Close | Developer API Documentation

curl https://api.close.com/api/v1/lead/id/ \
     -u "<CLOSE_API_KEY>:"

{
  "contact_ids": [
    "cont_o0kP3Nqyq0wxr5DLWIEm8mVr6ZpI0AhonKLDG0V5Qjh"
  ],
  "date_created": "2013-02-01T00:54:51.333000+00:00",
  "date_updated": "2013-02-06T20:53:01.977000+00:00",
  "description": "",
  "html_url": "https://app.close.com/lead/lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O/",
  "id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
  "name": "Wayne Enterprises (Sample Lead)",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "status_id": "stat_1ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "addresses": [],
  "display_name": "Wayne Enterprises (Sample Lead)",
  "status_label": "Potential",
  "tasks": [],
  "contacts": [
    {
      "date_created": "2013-02-01T00:54:51.331000+00:00",
      "date_updated": "2013-02-06T20:53:01.954000+00:00",
      "display_name": "Bruce Wayne",
      "id": "cont_o0kP3Nqyq0wxr5DLWIEm8mVr6ZpI0AhonKLDG0V5Qjh",
      "name": "Bruce Wayne",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "title": "The Dark Knight",
      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "emails": [
        {
          "email": "thedarkknight@close.com",
          "is_unsubscribed": false,
          "type": "office"
        }
      ],
      "phones": [
        {
          "phone": "+16503334444",
          "type": "office",
          "phone_formatted": "+1 650-333-4444"
        }
      ],
      "custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj": "CEO"
    }
  ],
  "opportunities": [
    {
      "annualized_expected_value": 37500,
      "annualized_value": 50000,
      "confidence": 75,
      "date_created": "2013-02-01T00:54:51.337000+00:00",
      "date_updated": "2013-02-01T00:54:51.337000+00:00",
      "expected_value": 37500,
      "id": "oppo_8eB77gAdf8FMy6GsNHEy84f7uoeEWv55slvUjKQZpJt",
      "lead_id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
      "note": "Bruce needs new software for the Bat Cave.",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "status_id": "stat_4ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "value": 50000,
      "value_period": "one_time",
      "lead_name": "Wayne Enterprises (Sample Lead)",
      "pipeline_id": "pipe_04fC628PVB0HjK2Qq5EqEf",
      "pipeline_name": "Sales",
      "status_label": "Active",
      "status_type": "active",
      "user_name": "John Doe",
      "value_currency": "USD",
      "value_formatted": "$500"
    },
    {
      "annualized_expected_value": 45000,
      "annualized_value": 60000,
      "confidence": 75,
      "date_created": "2013-02-01T00:54:51.337000+00:00",
      "date_updated": "2013-02-01T00:54:51.337000+00:00",
      "expected_value": 3750,
      "id": "oppo_klajsdflf8FMy6GsNHEy84f7uoeEWv55slvUjKQZpJt",
      "lead_id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
      "note": "Bat Cave monthly maintenance cost",
      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
      "status_id": "stat_4ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
      "value": 5000,
      "value_period": "monthly",
      "lead_name": "Wayne Enterprises (Sample Lead)",
      "pipeline_id": "pipe_04fC628PVB0HjK2Qq5EqEf",
      "pipeline_name": "Sales",
      "status_label": "Active",
      "status_type": "active",
      "user_name": "John Doe",
      "value_currency": "USD",
      "value_formatted": "$50 monthly"
    }
  ],
  "custom.cf_ORxgoOQ5YH1p7lDQzFJ88b4z0j7PLLTRaG66m8bmcKv": "Website contact form",
  "custom.cf_nenE344jkwrjyRRezwsf8b4V1MCoXWIDHIStmFavZks": [
    "Choice 1",
    "Choice 2"
  ]
}

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Query parameters

_fieldsstringOptional

Comma-separated list of fields to include in the response.

Response

Successful response

contact_idslist of strings

created_bystring or null

date_createddatetime

date_updateddatetime

descriptionstring or null

html_urlstring

idstring

namestring or null

organization_idstring

status_idstring

updated_bystring or null

urlstring or null

addresseslist of objects

contacts_summarystring

created_by_namestring or null

display_namestring

integration_linkslist of objects

localtimedatetime or null

primary_address_summarystring or null

primary_emailobject or null

primary_phoneobject or null

recent_callslist of maps from strings to any

sourcestring or null

status_labelstring

summarieslist of maps from strings to any

taskslist of maps from strings to any

updated_by_namestring or null

contactslist of objectsDeprecated

opportunitieslist of objectsDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error