Get a single Lead

GET

https://api.close.com/api/v1/lead/:id/

GET

/api/v1/lead/:id/

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

1 {
2   "contact_ids": [
3     "cont_o0kP3Nqyq0wxr5DLWIEm8mVr6ZpI0AhonKLDG0V5Qjh"
4   ],
5   "created_by": null,
6   "date_created": "2013-02-01T00:54:51.333000+00:00",
7   "date_updated": "2013-02-06T20:53:01.977000+00:00",
8   "description": "",
9   "html_url": "https://app.close.com/lead/lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O/",
10   "id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
11   "name": "Wayne Enterprises (Sample Lead)",
12   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
13   "status_id": "stat_1ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
14   "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
15   "url": null,
16   "addresses": [],
17   "display_name": "Wayne Enterprises (Sample Lead)",
18   "status_label": "Potential",
19   "tasks": [],
20   "contacts": [
21     {
22       "created_by": null,
23       "date_created": "2013-02-01T00:54:51.331000+00:00",
24       "date_updated": "2013-02-06T20:53:01.954000+00:00",
25       "display_name": "Bruce Wayne",
26       "id": "cont_o0kP3Nqyq0wxr5DLWIEm8mVr6ZpI0AhonKLDG0V5Qjh",
27       "name": "Bruce Wayne",
28       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
29       "title": "The Dark Knight",
30       "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
31       "emails": [
32         {
33           "email": "thedarkknight@close.com",
34           "is_unsubscribed": false,
35           "type": "office"
36         }
37       ],
38       "phones": [
39         {
40           "phone": "+16503334444",
41           "type": "office",
42           "phone_formatted": "+1 650-333-4444"
43         }
44       ],
45       "custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj": "CEO"
46     }
47   ],
48   "opportunities": [
49     {
50       "annualized_expected_value": 37500,
51       "annualized_value": 50000,
52       "confidence": 75,
53       "contact_id": null,
54       "created_by": null,
55       "date_created": "2013-02-01T00:54:51.337000+00:00",
56       "date_lost": null,
57       "date_updated": "2013-02-01T00:54:51.337000+00:00",
58       "date_won": null,
59       "expected_value": 37500,
60       "id": "oppo_8eB77gAdf8FMy6GsNHEy84f7uoeEWv55slvUjKQZpJt",
61       "lead_id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
62       "note": "Bruce needs new software for the Bat Cave.",
63       "note_html": "<body><p>Bruce needs new software for the Bat Cave.</p></body>",
64       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
65       "status_id": "stat_4ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
66       "updated_by": null,
67       "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
68       "value": 50000,
69       "value_period": "one_time",
70       "lead_name": "Wayne Enterprises (Sample Lead)",
71       "pipeline_id": "pipe_04fC628PVB0HjK2Qq5EqEf",
72       "pipeline_name": "Sales",
73       "status_label": "Active",
74       "status_type": "active",
75       "user_name": "John Doe",
76       "value_currency": "USD",
77       "value_formatted": "$500"
78     },
79     {
80       "annualized_expected_value": 45000,
81       "annualized_value": 60000,
82       "confidence": 75,
83       "contact_id": null,
84       "created_by": null,
85       "date_created": "2013-02-01T00:54:51.337000+00:00",
86       "date_lost": null,
87       "date_updated": "2013-02-01T00:54:51.337000+00:00",
88       "date_won": null,
89       "expected_value": 3750,
90       "id": "oppo_klajsdflf8FMy6GsNHEy84f7uoeEWv55slvUjKQZpJt",
91       "lead_id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
92       "note": "Bat Cave monthly maintenance cost",
93       "note_html": "<body><p>Bat Cave monthly maintenance cost</p></body>",
94       "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
95       "status_id": "stat_4ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
96       "updated_by": null,
97       "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
98       "value": 5000,
99       "value_period": "monthly",
100       "lead_name": "Wayne Enterprises (Sample Lead)",
101       "pipeline_id": "pipe_04fC628PVB0HjK2Qq5EqEf",
102       "pipeline_name": "Sales",
103       "status_label": "Active",
104       "status_type": "active",
105       "user_name": "John Doe",
106       "value_currency": "USD",
107       "value_formatted": "$50 monthly"
108     }
109   ],
110   "custom.cf_ORxgoOQ5YH1p7lDQzFJ88b4z0j7PLLTRaG66m8bmcKv": "Website contact form",
111   "custom.cf_nenE344jkwrjyRRezwsf8b4V1MCoXWIDHIStmFavZks": [
112     "Choice 1",
113     "Choice 2"
114   ]
115 }

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

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 objectsOptional

contacts_summarystringOptional

created_by_namestring or nullOptional

display_namestringOptional

integration_linkslist of objectsOptional

localtimedatetime or nullOptional

primary_address_fullstring or nullOptional

primary_address_summarystring or nullOptional

primary_emailobject or nullOptional

primary_phoneobject or nullOptional

recent_callslist of maps from strings to anyOptional

sourcestring or nullOptional

status_labelstringOptional

summarieslist of maps from strings to anyOptional

taskslist of maps from strings to anyOptional

updated_by_namestring or nullOptional

contactslist of objectsOptionalDeprecated

opportunitieslist of objectsOptionalDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error