For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogo
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 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
  • 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
  • July 16, 2026
  • June 1, 2026
  • May 7, 2026
  • May 4, 2026
  • April 10, 2026
  • April 6, 2026
  • March 6, 2026
  • January 14, 2026
  • December 17, 2025
  • August 25, 2025
  • August 14, 2025
  • July 29, 2025
  • July 16, 2025
  • June 25, 2025
  • February 14, 2025
  • January 6, 2025
  • December 2, 2024
  • November 6, 2024
  • September 9, 2024
  • August 28, 2024
  • June 26, 2024
  • June 20, 2024
  • June 10, 2024
  • June 7, 2024
  • April 24, 2024
  • March 28, 2024
  • March 27, 2024
  • February 26, 2024
  • February 21, 2024
  • February 15, 2024
  • November 13, 2023
  • November 10, 2023
  • October 26, 2023
  • October 2, 2023
  • September 21, 2023
  • August 29, 2023
  • July 21, 2023
  • June 29, 2023
  • June 20, 2023
  • May 1, 2023
  • December 22, 2022
  • September 26, 2022
  • March 10, 2022
  • February 15, 2022
  • February 14, 2022
  • November 16, 2021
  • November 9, 2021
  • June 11, 2021
  • June 7, 2021
  • May 17, 2021
  • April 22, 2021
  • April 13, 2021
  • March 31, 2021
  • January 5, 2021
  • October 29, 2020
  • October 9, 2020
  • October 3, 2020
  • September 18, 2020
  • August 13, 2020
  • August 7, 2020
  • June 30, 2020
  • May 19, 2020
  • April 30, 2020
  • April 6, 2020
  • December 10, 2019
  • November 13, 2019
  • October 31, 2019
  • October 12, 2019
  • August 20, 2019
  • July 2, 2019
  • June 18, 2019
  • May 10, 2019
  • May 8, 2019
  • April 25, 2019
  • April 9, 2019
  • March 7, 2019
  • February 22, 2019
  • February 18, 2019
  • January 25, 2019
  • November 28, 2018
  • Leads
  • List Leads
  • Create a new lead
  • Merge two leads
  • Get a single Lead
  • Update an existing lead
  • Delete a lead
  • Contacts
  • List contacts
  • Create a new contact
  • Fetch a single contact
  • Update an existing contact
  • Delete a contact
  • Opportunities
  • List or filter opportunities
  • Create an opportunity
  • Retrieve an opportunity
  • Update an opportunity
  • Delete an opportunity
  • Tasks
  • List or filter tasks
  • Create a task
  • Bulk-update tasks
  • Fetch a task's details
  • Update a task
  • Delete a task
  • Files
  • Generate a signed S3 POST
  • Custom Objects
  • List Custom Object instances
  • Create a new Custom Object instance
  • Retrieve a single Custom Object instance
  • Updating a Custom Object instance
  • Delete a Custom Object instance
  • Comments
  • Fetch multiple comments
  • Create a Comment
  • Fetch an individual comment
  • Update a Comment
  • Remove a comment
  • Fetch multiple comment threads
  • Fetch an individual comment thread
  • Activities
  • List or filter all activity types
  • Notes
  • List or filter all Note activities
  • Create a Note activity
  • Get a single Note activity
  • Update a Note activity
  • Delete a Note activity
  • Calls
  • List or filter all Call activities
  • Log an external Call activity
  • Get a single Call activity
  • Update a Call activity
  • Delete a Call activity
  • Emails
  • List or filter all Email activities
  • Create an Email activity
  • Get a single Email activity
  • Update an Email activity
  • Delete an Email activity
  • Email Threads
  • List or filter all EmailThread activities
  • Get a single EmailThread activity
  • Delete an EmailThread activity
  • List or filter all SMS activities
  • Create an SMS activity
  • Get a single SMS activity
  • Update an SMS activity
  • Delete an SMS activity
  • WhatsApp Messages
  • List or filter all WhatsAppMessage activities
  • Create a WhatsAppMessage activity
  • Get a single WhatsAppMessage activity
  • Update a WhatsAppMessage activity
  • Delete a WhatsAppMessage activity
  • Meetings
  • Meeting Search
  • List or filter all Meeting activities
  • Get a single Meeting activity
  • Update a Meeting activity
  • Delete a Meeting activity
  • Create or update third-party Meeting integration
  • Custom Activities
  • List or filter all Custom Activity instances
  • Create a new Custom Activity instance
  • Get a single Custom Activity instance
  • Updating a Custom Activity instance
  • Delete a Custom Activity instance
  • Creations
  • List or filter all Created activities
  • Get a single Created activity
  • Form Submissions
  • List or filter all FormSubmission activities
  • Get a single FormSubmission activity
  • Delete a FormSubmission activity
  • Lead Status Changes
  • List or filter all LeadStatusChange activities
  • Create a new LeadStatusChange activity
  • Get a single LeadStatusChange activity
  • Delete a single LeadStatusChange activity
  • Opportunity Status Changes
  • List or filter all OpportunityStatusChange activities
  • Create a new OpportunityStatusChange activity
  • Get a single OpportunityStatusChange activity
  • Delete a single OpportunityStatusChange activity
  • Lead Merges
  • List or filter all LeadMerge activities
  • Get a single LeadMerge activity
  • Task Completions
  • List or filter all TaskCompleted activities
  • Get a single TaskCompleted activity
  • Delete a TaskCompleted activity
  • Webhooks
  • Webhook Filters
  • List Webhook subscriptions
  • Create new Webhook subscription
  • Retrieve a single Webhook subscription
  • Update existing Webhook subscription
  • Delete Webhook subscription
  • Events
  • List of Event Types
  • Retrieve a list of events
  • Retrieve a single event by ID
  • Advanced Filtering
  • Smart Views
  • List Smart Views
  • Create a Smart View
  • Get a single Smart View
  • Update a Smart View
  • Delete a Smart View
  • Reporting
  • Get an activity report
  • List the predefined metrics used in activity reports
  • Get custom report (Explorer)
  • Get a funnel report (stages)
  • Get a funnel report (totals)
  • Get sent emails report
  • Get lead status change report
  • Get opportunity status change report
  • Sequences (Workflows)
  • List Sequences
  • Create a Sequence
  • Fetch a Sequence
  • Update a Sequence
  • Delete a Sequence
  • List Sequence Subscriptions
  • Subscribe a Contact to a Sequence
  • Fetch a single Sequence Subscription
  • Update a specific Subscription
  • Delete a Sequence Subscription
  • Bulk Actions
  • List bulk emails
  • Initiate a new bulk email
  • Fetch a single bulk email object
  • List bulk edits
  • Initiate a new bulk edit
  • Fetch a single bulk edit object
  • List bulk deletes
  • Initiate a new bulk delete
  • Fetch a single bulk delete object
  • List bulk sequence subscriptions
  • Initiate a new bulk sequence subscription
  • Fetch a single bulk sequence subscription object
  • Exports
  • List all the exports
  • List Lead Exports
  • Export leads based on a search query
  • Get a single Lead Export
  • List Opportunity Exports
  • Export opportunities, based on opportunity filters
  • Get a single Opportunity Export
  • Get a single Export
  • AI Field Enrichment
  • Enrich a specific field on a lead or contact using AI
  • Custom Fields
  • Custom Field Schemas
  • Retrieve a custom field schema
  • Update a custom field schema
  • List Lead Custom Fields
  • Create a new Lead Custom Field
  • Fetch Lead Custom Field's details
  • Update a Lead Custom Field
  • Delete a Lead Custom Field
  • List Contact Custom Fields
  • Create a new Contact Custom Field
  • Fetch Contact Custom Field's details
  • Update a Contact Custom Field
  • Delete a Contact Custom Field
  • List Opportunity Custom Fields
  • Create a new Opportunity Custom Field
  • Fetch Opportunity Custom Field's details
  • Update an Opportunity Custom Field
  • Delete an Opportunity Custom Field
  • List Activity Custom Fields
  • Create a new Activity Custom Field
  • Fetch Activity Custom Field's details
  • Update an Activity Custom Field
  • Delete an Activity Custom Field
  • List Custom Object Custom Fields
  • Create a new Custom Object Custom Field
  • Fetch Custom Object Custom Field's details
  • Update a Custom Object Custom Field
  • Delete a Custom Object Custom Field
  • Shared Custom Fields
  • List Shared Custom Fields
  • Create a new Shared Custom Field
  • Fetch Shared Custom Field's details
  • Update a Shared Custom Field
  • Delete a Shared Custom Field
  • Associate a Shared Custom Field with an object type
  • Fetch a Shared Custom Field Association
  • Update an existing Shared Custom Field Association
  • Disassociate a Shared Custom Field from an object type
  • Custom Activity Types
  • List Custom Activity Types
  • Create new Custom Activity Type
  • Retrieve a single Custom Activity Type
  • Update existing Custom Activity Type
  • Delete a Custom Activity Type
  • Custom Object Types
  • List Custom Object Types
  • Create new Custom Object Type
  • Retrieve a single Custom Object Type
  • Update existing Custom Object Type
  • Delete a Custom Object Type
  • Pipelines
  • List Pipelines for your organization
  • Create a Pipeline
  • Fetch a single Pipeline
  • Update a Pipeline
  • Delete a Pipeline
  • Opportunity Statuses
  • List opportunity statuses for your organization
  • Create an opportunity status
  • Fetch a single opportunity status
  • Rename an opportunity status
  • Delete an opportunity status
  • Lead Statuses
  • List lead statuses for your organization
  • Create a new status that can be applied to leads
  • Fetch a single lead status
  • Rename a lead status
  • Delete a lead status
  • Integration Links
  • Get all integration links for your organization
  • Create an integration link
  • Get a single integration link
  • Update an integration link
  • Delete an integration link
  • Forms
  • List Forms
  • Retrieve a Form
  • Email Templates
  • List email templates
  • Create an email template
  • Fetch an email template
  • Update an email template
  • Delete an email template
  • Render an email template
  • SMS Templates
  • List SMS templates
  • Create an SMS template
  • Fetch an SMS template
  • Update an SMS template
  • Delete an SMS template
  • Outcomes
  • List or filter outcomes
  • Create an outcome
  • Fetch a single outcome
  • Update an outcome
  • Delete an outcome
  • Playbooks
  • List or filter playbooks
  • Create a playbook
  • Fetch a single playbook
  • Update a playbook
  • Delete a playbook
  • Archive a playbook
  • Unarchive a playbook
  • Scheduling Links Guide
  • Scheduling Links
  • List User Scheduling Links
  • Create a User Scheduling Link
  • Create or update a Scheduling Link via OAuth
  • Delete a User Scheduling Link via OAuth integration
  • Fetch a User Scheduling Link
  • Update a User Scheduling Link
  • Delete a User Scheduling Link
  • List Shared Scheduling Links
  • Create a Shared Scheduling Link
  • Fetch a Shared Scheduling Link
  • Update a Shared Scheduling Link
  • Delete a Shared Scheduling Link
  • Map a Shared Scheduling Link
  • Unmap a Shared Scheduling Link
  • Connected Accounts
  • List connected accounts
  • Fetch a single connected account
  • Send As
  • List Send As Associations
  • Create a Send As Association
  • Delete a Send As Association by allowed user
  • Edit Send As Associations in bulk
  • Retrieve a single Send As Association
  • Delete a Send As Association by ID
  • Unsubscribed Emails
  • List all unsubscribed emails
  • Unsubscribe an email address
  • Resubscribe an email address
  • Phone Numbers
  • List or search for phone numbers
  • Request an internal phone number
  • Retrieve a single phone number
  • Update a phone number
  • Delete a phone number
  • Blocked Phone Numbers
  • List Blocked Phone Numbers
  • Create a Blocked Phone Number
  • Retrieve Blocked Phone Number settings
  • Update Blocked Phone Number settings
  • Retrieve a single Blocked Phone Number
  • Update a Blocked Phone Number
  • Delete a Blocked Phone Number
  • Dialers
  • List or filter all dialer sessions
  • Get a single dialer session
  • Users
  • Fetch information about yourself
  • List users in your organization
  • List user availability statuses
  • Fetch a single user
  • Organizations
  • Get an organization's details
  • Update an organization
  • Memberships
  • Create a membership
  • Bulk update memberships
  • Update a membership
  • Delete a membership
  • Get pinned views for a membership
  • Update pinned views for a membership
  • Roles
  • List all the roles defined for your organization
  • Create a new role
  • Fetch a single role
  • Update existing role
  • Delete a role
  • Groups
  • List Groups for your organization
  • Create a Group
  • Add a User to a Group
  • Remove a User from a Group
  • Fetch an individual Group
  • Update a Group
  • Delete a Group
HomepageProduct HelpLog inTry for Free
Getting Started

API Changelog

April 9, 2019
April 9, 2019

All exports are now compressed with GZIP

All exports are now compressed with GZIP. Downloads will now set HTTP headers Content-Encoding: gzip, and Content-Type: text/csv or Content-Type: application/json depending on export format.

Was this page helpful?
Edit this page
Previous

Support for Multi-Select Custom Fields

Next

Drop the field plan_type from the Membership API

Built with
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