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
    • 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 Field Schemas
        • GETList Lead Custom Fields
        • POSTCreate a new Lead Custom Field
        • GETFetch Lead Custom Field's details
        • PUTUpdate a Lead Custom Field
        • DELDelete a Lead Custom Field
      • Shared 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 ConfigurationCustom FieldsLead Custom Fields

List Lead Custom Fields

||View as Markdown|
GET
https://api.close.com/api/v1/custom_field/lead/
GET
/api/v1/custom_field/lead/
$curl https://api.close.com/api/v1/custom_field/lead/ \
>     -u "<CLOSE_API_KEY>:"
1{
2  "data": [
3    {
4      "accepts_multiple_values": false,
5      "choices": null,
6      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
7      "date_created": "2014-11-07T05:06:09.422000+00:00",
8      "date_updated": "2014-11-10T20:56:16.784000+00:00",
9      "description": "The number of users in the company",
10      "editable_with_roles": [],
11      "id": "cf_v6S011I6MqcbVvB2FA5Nk8dr5MkL8sWuCiG8cUleO9c",
12      "name": "# of users",
13      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
14      "type": "number",
15      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
16    },
17    {
18      "accepts_multiple_values": true,
19      "choices": [
20        "Apparel",
21        "Cars",
22        "Cosmetics",
23        "IT"
24      ],
25      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
26      "date_created": "2014-11-07T05:06:09.423000+00:00",
27      "date_updated": "2014-11-12T22:37:55.752000+00:00",
28      "description": null,
29      "editable_with_roles": [],
30      "id": "cf_8wtBWsdRU2Fur7GDnEeXQ7ra2Vu7R4hG1SNYdiEhh0F",
31      "name": "Industry",
32      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
33      "type": "choices",
34      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
35    },
36    {
37      "accepts_multiple_values": false,
38      "choices": null,
39      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
40      "date_created": "2014-11-10T23:38:14.535000+00:00",
41      "date_updated": "2014-11-10T23:38:14.535000+00:00",
42      "description": "ID in the company database",
43      "editable_with_roles": [
44        "admin",
45        "role_4zhUd9gDKwVv0Bbl2Nk0Ud"
46      ],
47      "id": "cf_vvHHPVktybLXXqKrUF88PLsGm8sh202oMq3XGy6RcBm",
48      "name": "Internal Database ID",
49      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
50      "type": "text",
51      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
52    },
53    {
54      "accepts_multiple_values": false,
55      "choices": null,
56      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
57      "date_created": "2014-11-10T20:56:44.780000+00:00",
58      "date_updated": "2014-11-10T20:56:44.780000+00:00",
59      "description": null,
60      "editable_with_roles": [],
61      "id": "cf_xUDvptVqoPQYv5tmRFDxemYOWFT9nlLRqJyQhpcNh4z",
62      "name": "Language Preference",
63      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
64      "type": "text",
65      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
66    },
67    {
68      "accepts_multiple_values": false,
69      "choices": null,
70      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
71      "date_created": "2014-11-07T05:06:09.413000+00:00",
72      "date_updated": "2014-11-10T20:51:12.636000+00:00",
73      "description": "The date the trial expires",
74      "editable_with_roles": [],
75      "id": "cf_MakiQgTzKXrcL8sDJbS2lkuUcA2FxZJAW8Q38ARgwWh",
76      "name": "Trial Due",
77      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
78      "type": "date",
79      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
80    },
81    {
82      "accepts_multiple_values": false,
83      "choices": null,
84      "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
85      "date_created": "2014-11-07T05:06:09.413000+00:00",
86      "date_updated": "2014-11-10T20:51:12.636000+00:00",
87      "description": "The AE in charge of this account",
88      "editable_with_roles": [],
89      "id": "cf_MakiQgTzKXrcL8sDJbS2lkuUcA2FxZJAW8Q38ARgwWh",
90      "name": "Owner",
91      "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
92      "type": "user",
93      "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA"
94    }
95  ],
96  "has_more": false
97}
List all the lead custom fields for your organization.
Was this page helpful?
Previous

Update a custom field schema

Next

Create a new Lead Custom Field

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

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error