For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomepageProduct HelpLog inTry for Free
Developers HomeAPI ReferenceMCP
Developers HomeAPI ReferenceMCP
  • Getting Started
    • Introduction
    • Authentication with API Keys
    • Authentication with OAuth
    • API Clients
    • Pagination
    • Specifying Fields
    • Filter Parameters
    • HTTP Response Codes
    • Rate Limits
    • Timezone Offsets
    • Rich Text Fields
    • Changelog
  • CRM Core
    • Leads
      • GETList Leads
      • POSTCreate a new lead
      • POSTMerge two leads
      • GETGet a single Lead
      • PUTUpdate an existing lead
      • DELDelete a lead
    • Contacts
    • Opportunities
    • Tasks
    • Files
    • Custom Objects
    • Comments
  • Activities
    • Activities
    • Notes
    • Calls
    • Emails
    • Email Threads
    • WhatsApp Messages
    • Meetings
    • Custom Activities
    • Creations
    • Form Submissions
    • Lead Status Changes
    • Opportunity Status Changes
    • Lead Merges
    • Task Completions
  • Events & Webhooks
    • Webhooks
    • Events
  • Search & Reporting
    • Advanced Filtering
    • Smart Views
    • Reporting
  • Automation & Bulk Actions
    • Sequences (Workflows)
    • Bulk Actions
    • Exports
    • AI Field Enrichment
  • CRM Configuration
    • Custom Fields
    • Custom Activity Types
    • Custom Object Types
    • Pipelines
    • Opportunity Statuses
    • Lead Statuses
    • Integration Links
    • Forms
  • Communication Configuration
    • Email Templates
    • SMS Templates
    • Outcomes
    • Playbooks
    • Scheduling Links Guide
    • Scheduling Links
    • Connected Accounts
    • Send As
    • Unsubscribed Emails
    • Phone Numbers
    • Blocked Phone Numbers
    • Dialers
  • Users & Organizations
    • Users
    • Organizations
    • Memberships
    • Roles
    • Groups
Close

Product

OverviewCommunicationAutomationIntegrationsReportingSMSCallingSecurityForms

Pricing & Use Cases

PricingClose vs Other CRMsCustomer Stories

Resources

Sales BlogSales ResourcesSales GuidesWebinarsOn-Demand DemoSales Tools

Company

AboutCareersPartner with CloseBrand GuidelinesTermsPrivacyGDPRCCPA

Get Help

+1-833-GO-CLOSEHelp CenterDownload the Close AppProduct UpdatesSystem Status
LogoLogo
HomepageProduct HelpLog inTry for Free
CRM CoreLeads

Get a single Lead

||View as Markdown|
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      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
64      "status_id": "stat_4ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
65      "updated_by": null,
66      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
67      "value": 50000,
68      "value_period": "one_time",
69      "lead_name": "Wayne Enterprises (Sample Lead)",
70      "pipeline_id": "pipe_04fC628PVB0HjK2Qq5EqEf",
71      "pipeline_name": "Sales",
72      "status_label": "Active",
73      "status_type": "active",
74      "user_name": "John Doe",
75      "value_currency": "USD",
76      "value_formatted": "$500"
77    },
78    {
79      "annualized_expected_value": 45000,
80      "annualized_value": 60000,
81      "confidence": 75,
82      "contact_id": null,
83      "created_by": null,
84      "date_created": "2013-02-01T00:54:51.337000+00:00",
85      "date_lost": null,
86      "date_updated": "2013-02-01T00:54:51.337000+00:00",
87      "date_won": null,
88      "expected_value": 3750,
89      "id": "oppo_klajsdflf8FMy6GsNHEy84f7uoeEWv55slvUjKQZpJt",
90      "lead_id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
91      "note": "Bat Cave monthly maintenance cost",
92      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
93      "status_id": "stat_4ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
94      "updated_by": null,
95      "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
96      "value": 5000,
97      "value_period": "monthly",
98      "lead_name": "Wayne Enterprises (Sample Lead)",
99      "pipeline_id": "pipe_04fC628PVB0HjK2Qq5EqEf",
100      "pipeline_name": "Sales",
101      "status_label": "Active",
102      "status_type": "active",
103      "user_name": "John Doe",
104      "value_currency": "USD",
105      "value_formatted": "$50 monthly"
106    }
107  ],
108  "custom.cf_ORxgoOQ5YH1p7lDQzFJ88b4z0j7PLLTRaG66m8bmcKv": "Website contact form",
109  "custom.cf_nenE344jkwrjyRRezwsf8b4V1MCoXWIDHIStmFavZks": [
110    "Choice 1",
111    "Choice 2"
112  ]
113}
Was this page helpful?
Previous

Merge two leads

Next

Update an existing lead

Built with

Authentication

AuthorizationBasic
Use your API key as the username and leave the password empty.
OR
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