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

List Leads

||View as Markdown|
GET
https://api.close.com/api/v1/lead/
GET
/api/v1/lead/
$curl https://api.close.com/api/v1/lead/ \
>     -u "<CLOSE_API_KEY>:"
1{
2  "data": [
3    {
4      "contact_ids": [
5        "cont_o0kP3Nqyq0wxr5DLWIEm8mVr6ZpI0AhonKLDG0V5Qjh"
6      ],
7      "created_by": null,
8      "date_created": "2013-02-01T00:54:51.333000+00:00",
9      "date_updated": "2013-02-06T20:53:01.977000+00:00",
10      "description": "",
11      "html_url": "https://app.close.com/lead/lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O/",
12      "id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
13      "name": "Wayne Enterprises (Sample Lead)",
14      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
15      "status_id": "stat_1ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
16      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
17      "url": null,
18      "addresses": [],
19      "display_name": "Wayne Enterprises (Sample Lead)",
20      "status_label": "Potential",
21      "tasks": [],
22      "contacts": [
23        {
24          "created_by": null,
25          "date_created": "2013-02-01T00:54:51.331000+00:00",
26          "date_updated": "2013-02-06T20:53:01.954000+00:00",
27          "display_name": "Bruce Wayne",
28          "id": "cont_o0kP3Nqyq0wxr5DLWIEm8mVr6ZpI0AhonKLDG0V5Qjh",
29          "name": "Bruce Wayne",
30          "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
31          "title": "The Dark Knight",
32          "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
33          "emails": [
34            {
35              "email": "thedarkknight@close.com",
36              "is_unsubscribed": false,
37              "type": "office"
38            }
39          ],
40          "phones": [
41            {
42              "phone": "+16503334444",
43              "type": "office",
44              "phone_formatted": "+1 650-333-4444"
45            }
46          ],
47          "custom.cf_j0P7kHmgFTZZnYBFtyPSZ3uQw4dpW8xKcW7Krps8atj": "CEO"
48        }
49      ],
50      "opportunities": [
51        {
52          "annualized_expected_value": 37500,
53          "annualized_value": 50000,
54          "confidence": 75,
55          "contact_id": null,
56          "created_by": null,
57          "date_created": "2013-02-01T00:54:51.337000+00:00",
58          "date_lost": null,
59          "date_updated": "2013-02-01T00:54:51.337000+00:00",
60          "date_won": null,
61          "expected_value": 37500,
62          "id": "oppo_8eB77gAdf8FMy6GsNHEy84f7uoeEWv55slvUjKQZpJt",
63          "lead_id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
64          "note": "Bruce needs new software for the Bat Cave.",
65          "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
66          "status_id": "stat_4ZdiZqcSIkoGVnNOyxiEY58eTGQmFNG3LPlEVQ4V7Nk",
67          "updated_by": null,
68          "user_id": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
69          "value": 50000,
70          "value_period": "one_time",
71          "lead_name": "Wayne Enterprises (Sample Lead)",
72          "pipeline_id": "pipe_04fC628PVB0HjK2Qq5EqEf",
73          "pipeline_name": "Sales",
74          "status_label": "Active",
75          "status_type": "active",
76          "user_name": "John Doe",
77          "value_currency": "USD",
78          "value_formatted": "$500"
79        },
80        {
81          "annualized_expected_value": 45000,
82          "annualized_value": 60000,
83          "confidence": 75,
84          "contact_id": null,
85          "created_by": null,
86          "date_created": "2013-02-01T00:54:51.337000+00:00",
87          "date_lost": null,
88          "date_updated": "2013-02-01T00:54:51.337000+00:00",
89          "date_won": null,
90          "expected_value": 3750,
91          "id": "oppo_klajsdflf8FMy6GsNHEy84f7uoeEWv55slvUjKQZpJt",
92          "lead_id": "lead_IIDHIStmFcFQZZP0BRe99V1MCoXWz2PGCm6EDmR9v2O",
93          "note": "Bat Cave monthly maintenance cost",
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    }
116  ],
117  "has_more": false,
118  "total_results": 1
119}
Was this page helpful?
Previous

Leads

Next

Create a new 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.

Query parameters

_limitintegerOptionalDefaults to 100
Number of results to return.
_skipintegerOptionalDefaults to 0
Number of results to skip before returning, for pagination.
_fieldsstringOptional

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

Response

Successful response
datalist of objects
has_moreboolean

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error