| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.close.com/api/v1 | link | — | — | — |
Actions (145)
Activities · 52
- Create LeadStatusChangePOST /activity/status_change/lead/
Create a Lead Status Change event (historical import).
documented - Create OpportunityStatusChangePOST /activity/status_change/opportunity/
Create an Opportunity Status Change event (historical import).
documented - Create SMSPOST /activity/sms/{?send_to_inbox}
Create an SMS activity.
documented - Create WhatsAppMessagePOST /activity/whatsapp_message/{?send_to_inbox}
Create a WhatsApp message activity.
documented - Create callPOST /activity/call/
Log a Call activity (manual via API).
documented - Create emailPOST /activity/email/
Create an Email activity (including handling attachments and templates).
documented - Create notePOST /activity/note/
Create a Note activity.
documented - Create/Update Meeting integrationPOST /activity/meeting/{id}/integration/
Integrate a third-party meeting app with a Meeting activity (OAuth apps only).
documented - Delete FormSubmissionDELETE /activity/form_submission/{id}/
Delete a FormSubmission activity.
documented - Delete LeadStatusChangeDELETE /activity/status_change/lead/{id}/
Delete a LeadStatusChange.
documented - Delete MeetingDELETE /activity/meeting/{id}/
Delete a Meeting activity.
documented - Delete NoteDELETE /activity/note/{id}/
Delete a Note activity.
documented - Delete OpportunityStatusChangeDELETE /activity/status_change/opportunity/{id}/
Delete an OpportunityStatusChange.
documented - Delete SMSDELETE /activity/sms/{id}/
Delete an SMS activity.
documented - Delete TaskCompletedDELETE /activity/task_completed/{id}/
Delete a TaskCompleted.
documented - Delete WhatsAppMessageDELETE /activity/whatsapp_message/{id}/
Delete a WhatsApp message.
documented - Delete callDELETE /activity/call/{id}/
Delete a Call activity.
documented - Delete emailDELETE /activity/email/{id}/
Delete an Email activity.
documented - Delete emailthreadDELETE /activity/emailthread/{id}/
Delete an EmailThread activity and associated emails.
documented - List Call activitiesGET /activity/call/{?lead_id, user_id, date_created__gt, date_created__lt, _limit, _skip}
List Call-type activities (and related fields).
documented - List Created activitiesGET /activity/created/{?lead_id, user_id, date_created__gt, date_created__lt, _limit, _skip}
List Created-type activities.
documented - List Email activitiesGET /activity/email/{?lead_id, user_id, date_created__gt, date_created__lt, _limit, _skip}
List Email-type activities.
documented - List EmailThread activitiesGET /activity/emailthread/{?lead_id, user_id, date_created__gt, date_created__lt, _limit, _skip}
List email conversation threads.
documented - List FormSubmissionGET /activity/form_submission/{?lead_id, contact_id, organization_id, form_id, form_id__in, date_created__gt, date_created__lt, _limit, _skip, _fields}
List FormSubmission activities.
documented - List LeadMergeGET /activity/lead_merge/{?lead_id, user_id, date_created__gt, date_created__lt, _limit, _skip}
List Lead Merge activities.
documented - List LeadStatusChangeGET /activity/status_change/lead/{?lead_id, user_id, date_created__gt, date_created__lt, _limit, _skip}
List Lead Status Change events.
documented - List Meeting activitiesGET /activity/meeting/{?lead_id, user_id, date_created__gt, date_created__lt, _limit, _skip}
List Meeting activities.
documented - List Note activitiesGET /activity/note/{?lead_id, user_id, date_created__gt, date_created__lt, _limit, _skip}
List Note activities.
documented - List OpportunityStatusChangeGET /activity/status_change/opportunity/{?lead_id, opportunity_id, user_id, date_created__gt, date_created__lt, _limit, _skip}
List Opportunity Status Change events.
documented - List SMSGET /activity/sms/{?lead_id, user_id, date_created__gt, date_created__lt, _limit, _skip}
List SMS activities.
documented - List TaskCompletedGET /activity/task_completed/{?lead_id, user_id, date_created__gt, date_created__lt, _limit, _skip}
List TaskCompleted activities.
documented - List WhatsAppMessageGET /activity/whatsapp_message/{?lead_id, user_id, external_whatsapp_message_id, date_created__gt, date_created__lt}
List WhatsApp messages.
documented - List activitiesGET /activity/{?parameters}
List or filter all activity types (general activities endpoint).
documented - Retrieve FormSubmissionGET /activity/form_submission/{id}/{?_fields}
Fetch a FormSubmission activity.
documented - Retrieve LeadMergeGET /activity/lead_merge/{id}/
Fetch a LeadMerge by ID.
documented - Retrieve LeadStatusChangeGET /activity/status_change/lead/{id}/
Fetch a LeadStatusChange by ID.
documented - Retrieve MeetingGET /activity/meeting/{id}/
Fetch a Meeting activity.
documented - Retrieve NoteGET /activity/note/{id}/
Fetch a Note activity.
documented - Retrieve OpportunityStatusChangeGET /activity/status_change/opportunity/{id}/
Fetch an OpportunityStatusChange by ID.
documented - Retrieve SMSGET /activity/sms/{id}/
Fetch a single SMS activity.
documented - Retrieve TaskCompletedGET /activity/task_completed/{id}/
Fetch a TaskCompleted by ID.
documented - Retrieve WhatsAppMessageGET /activity/whatsapp_message/{id}/
Fetch a WhatsApp message.
documented - Retrieve callGET /activity/call/{id}/
Fetch a single Call activity.
documented - Retrieve created activityGET /activity/created/{id}/
Fetch a Created activity by ID.
documented - Retrieve emailGET /activity/email/{id}/
Fetch a single Email activity.
documented - Retrieve emailthreadGET /activity/emailthread/{id}/
Fetch a single EmailThread activity.
documented - Update MeetingPUT /activity/meeting/{id}/
Update a Meeting activity.
documented - Update NotePUT /activity/note/{id}/
Update a Note activity.
documented - Update SMSPUT /activity/sms/{id}/
Update an SMS activity.
documented - Update WhatsAppMessagePUT /activity/whatsapp_message/{id}/
Update a WhatsApp message.
documented - Update callPUT /activity/call/{id}/
Update a Call activity (e.g., notes or outcome).
documented - Update emailPUT /activity/email/{id}/
Update an Email activity (e.g., status, body, or scheduling).
documented
Bulk Actions · 12
- Fetch bulk deleteGET /bulk_action/delete/{id}/
Fetch a bulk delete.
documented - Fetch bulk editGET /bulk_action/edit/{id}/
Fetch a bulk edit.
documented - Fetch bulk emailGET /bulk_action/email/{id}/
Fetch a bulk email object.
documented - Fetch bulk sequence subscriptionGET /bulk_action/sequence_subscription/{id}/
Fetch a bulk sequence subscription.
documented - Initiate bulk deletePOST /bulk_action/delete/
Initiate bulk deletes.
documented - Initiate bulk editPOST /bulk_action/edit/
Initiate bulk edits.
documented - Initiate bulk emailPOST /bulk_action/email/
Create a bulk email job.
documented - Initiate bulk sequence subscriptionPOST /bulk_action/sequence_subscription/
Bulk subscribe contacts to a sequence.
documented - List bulk deletesGET /bulk_action/delete/
List bulk deletes.
documented - List bulk editsGET /bulk_action/edit/
List bulk edits.
documented - List bulk emailsGET /bulk_action/email/
List bulk emails.
documented - List bulk sequence subscriptionsGET /bulk_action/sequence_subscription/
List bulk sequence subscriptions.
documented
Sequences · 9
- Create sequencePOST /sequence/
Create a sequence.
documented - Delete sequenceDELETE /sequence/{id}/
Delete a sequence.
documented - Fetch sequenceGET /sequence/{id}/
Fetch a sequence.
documented - List SequencesGET /sequence/{?_limit, _skip}
List sequences.
documented - List sequence subscriptionsGET /sequence_subscription/{?sequence_id, contact_id, lead_id}
List sequence subscriptions.
documented - Retrieve sequence subscriptionGET /sequence_subscription/{id}/
Fetch a sequence subscription by ID.
documented - Subscribe to sequencePOST /sequence_subscription/
Subscribe a contact/lead to a sequence.
documented - Update sequencePUT /sequence/{id}/
Update a sequence.
documented - Update sequence subscriptionPUT /sequence_subscription/{id}/
Update a sequence subscription.
documented
Reporting · 8
- Get activity reportPOST /report/activity/
Generate an activity report (overview or comparison).
documented - Get custom reportGET /report/custom/{ORGANIZATION_ID}/{?query, x, y, interval, transform_y, group_by, start, end}
Generic custom reporting for any object.
documented - Get funnel report (stages)POST /report/funnel/opportunity/stages/
Get a stages-based view of the opportunity funnel.
documented - Get funnel report (totals)POST /report/funnel/opportunity/totals/
Get a totals view of the opportunity funnel.
documented - Get lead status change reportGET /report/statuses/lead/{ORGANIZATION_ID}/{?date_start, date_end, query}
Lead-status-change reporting for a time period.
documented - Get opportunity status change reportGET /report/statuses/opportunity/{ORGANIZATION_ID}/{?user_id, date_start, date_end, smart_view_id, query}
Opportunity-status-change reporting for a time period.
documented - Get report: sent emails by templateGET /report/sent_emails/{ORGANIZATION_ID}/{?user_id, date_start, date_end}
Get a report of sent emails grouped by template.
documented - List activity metricsGET /report/activity/metrics/
List predefined metrics used in activity reports.
documented
Groups · 7
- Add member to groupPOST /group/{group_id}/member/
Add a user to a group.
documented - Create groupPOST /group/{?_fields}
Create a new group.
documented - Delete groupDELETE /group/{group_id}/
Delete a group.
documented - List groupsGET /group/{?_fields}
List groups with optional field data.
documented - Remove member from groupDELETE /group/{group_id}/member/{user_id}/
Remove a user from a group.
documented - Retrieve groupGET /group/{group_id}/{?_fields}
Fetch a single group.
documented - Update groupPUT /group/{group_id}/{?_fields}
Update group data.
documented
Leads · 7
- Advanced filtering (data/search)POST /api/v1/data/search/
Post an Advanced Filtering query to locate leads or related objects using arbitrary filter criteria.
documented - Create leadPOST /lead/
Create a new lead with optional nested data (contacts, addresses, custom fields).
documented - Delete leadDELETE /lead/{id}/
Remove a lead from Close.
documented - List leadsGET /lead/{?_limit, _skip, _fields}
Return a list of leads with optional field filtering and pagination.
documented - Merge leadsPOST /lead/merge/
Merge two leads into a destination lead (historical merge operation).},{
documented - Retrieve leadGET /lead/{id}/{?_fields}
Fetch a single lead by its ID.
documented - Update leadPUT /lead/{id}/
Update fields on an existing lead (supports non-destructive patches).
documented
Email Templates · 6
- Create email templatePOST /email_template/
Create an email template.
documented - Delete email templateDELETE /email_template/{id}/
Delete an email template.
documented - Fetch email templateGET /email_template/{id}/
Fetch a single email template.
documented - List email templatesGET /email_template/{?is_archived, _limit, _skip}
List email templates.
documented - Render email templateGET /email_template/{id}/render/{?lead_id, contact_id, query, entry, mode}
Render a template for a lead or contact.
documented - Update email templatePUT /email_template/{id}/
Update an email template.
documented
Send As · 6
- Bulk edit Send As associationsPOST /send_as/bulk/
Bulk edit Send As associations.
documented - Create Send As associationPOST /send_as/
Create a Send As association.
documented - Delete Send As associationDELETE /send_as/{id}/
Delete a Send As association.
documented - Delete Send As by allowing/allowed userDELETE /send_as/{?allowing_user_id, allowed_user_id}
Delete a Send As association by users.
documented - Fetch Send As associationGET /send_as/{id}/
Fetch a single Send As association.
documented - List Send As associationsGET /send_as/{?allowing_user_id, allowed_user_id}
List Send As associations.
documented
Contacts · 5
- Create contactPOST /contact/
Create a new contact (attached to a lead if provided).
documented - Delete contactDELETE /contact/{id}/
Delete a contact.
documented - List contactsGET /contact/{?_limit, _skip}
Return a list of contacts with optional pagination.
documented - Retrieve contactGET /contact/{id}/
Fetch a single contact by ID.
documented - Update contactPUT /contact/{id}/
Update a contact's fields.
documented
Integration Links · 5
- Create integration linkPOST /integration_link/
Create an integration link.
documented - Delete integration linkDELETE /integration_link/{id}/
Delete an integration link.
documented - Fetch integration linkGET /integration_link/{id}/
Fetch an integration link.
documented - List integration linksGET /integration_link/
List integration links.
documented - Update integration linkPUT /integration_link/{id}/
Update an integration link.
documented
Opportunities · 5
- Create opportunityPOST /opportunity/
Create an opportunity.
documented - Delete opportunityDELETE /opportunity/{id}/
Delete an opportunity.
documented - List opportunitiesGET /opportunity/{?lead_id, user_id, status_id, status_label, status_type, date_created__{lt|gt|lte|gte}, date_updated__{lt|gt|lte|gte}, date_won__{lt|gt|lte|gte}, value_period, query, _order_by, _group_by, _fields, lead_saved_search_id, _limit, _skip}
List or filter opportunities.
documented - Retrieve opportunityGET /opportunity/{id}/
Fetch an opportunity by ID.
documented - Update opportunityPUT /opportunity/{id}/
Update an opportunity.
documented
Smart Views · 5
- Create Smart ViewPOST /saved_search/
Create a Smart View (saved search).
documented - Delete Smart ViewDELETE /saved_search/{id}/
Delete a Smart View.
documented - Fetch Smart ViewGET /saved_search/{id}/
Fetch a Smart View by ID.
documented - List Smart ViewsGET /saved_search/{?type, type__in}
List smart views (saved searches) for leads or contacts.
documented - Update Smart ViewPUT /saved_search/{id}/
Update a Smart View.
documented
SMS Templates · 5
- Create SMS templatePOST /sms_template/
Create an SMS template.
documented - Delete SMS templateDELETE /sms_template/{id}/
Delete an SMS template.
documented - Fetch SMS templateGET /sms_template/{id}/
Fetch a single SMS template.
documented - List SMS templatesGET /sms_template/{? _limit, _skip}
List SMS templates.
documented - Update SMS templatePUT /sms_template/{id}/
Update an SMS template.
documented
Pipelines · 4
- Create pipelinePOST /pipeline/
Create a new pipeline.
documented - Delete pipelineDELETE /pipeline/{pipeline_id}/
Delete a pipeline (only if it contains no statuses).
documented - List pipelinesGET /pipeline/{?pipeline_id, _fields}
List all pipelines.
documented - Update pipelinePUT /pipeline/{pipeline_id}/
Update a pipeline (rename, reorder statuses, move statuses between pipelines).
documented