> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Close

> How to set up the Close connector, plus the actions and events that are available.

![Close](https://stackone-logos.com/api/close/filled/svg)

v1.2.1[See changelog](https://docs.stackone.com/connectors/close/changelog.md)

[81 actions](#actions) · [14 events](#events) · 2 auth methods

CRM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/close/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an OAuth app in Close. All OAuth apps receive full read/write access with automatic token refresh.

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/close/guides/connector-profile/api-key.md)
>
> No app registration required. API key inherits the permissions of the user who created it.

Optionally, configure receiving Events for Close into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/close/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/close/guides/link-account/oauth-2-0.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/close/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

81 actions

ActionDescription

List Activities`close_list_activities`

List or filter all activity types

List Notes`close_list_notes`

List or filter all note activities

Get Note`close_get_note`

Get a single note activity by ID

Create Note`close_create_note`

Create a note activity on a lead

Update Note`close_update_note`

Update a note activity

Delete Note`close_delete_note`

Delete a note activity

List Calls`close_list_calls`

List or filter all call activities

Get Call`close_get_call`

Get a single call activity by ID

Log Call`close_create_call`

Log an external call activity on a lead

List Emails`close_list_emails`

List or filter all email activities

Get Email`close_get_email`

Get a single email activity by ID

List SMS`close_list_sms`

List or filter all SMS activities

List Meetings`close_list_meetings`

List or filter all meeting activities

Get Meeting`close_get_meeting`

Get a single meeting activity by ID

List Contacts`close_list_contacts`

List all contacts in your Close organization

Get Contact`close_get_contact`

Retrieve a single contact by ID

Create Contact`close_create_contact`

Create a new contact on a lead

Update Contact`close_update_contact`

Update an existing contact

Delete Contact`close_delete_contact`

Delete a contact by ID

List Lead Custom Fields`close_list_lead_custom_fields`

List all custom fields defined for leads

Get Lead Custom Field`close_get_lead_custom_field`

Retrieve a single lead custom field by ID

Create Lead Custom Field`close_create_lead_custom_field`

Create a new custom field for leads

Update Lead Custom Field`close_update_lead_custom_field`

Update a lead custom field

Delete Lead Custom Field`close_delete_lead_custom_field`

Delete a lead custom field

List Contact Custom Fields`close_list_contact_custom_fields`

List all custom fields defined for contacts

Get Contact Custom Field`close_get_contact_custom_field`

Retrieve a single contact custom field by ID

List Opportunity Custom Fields`close_list_opportunity_custom_fields`

List all custom fields defined for opportunities

Get Opportunity Custom Field`close_get_opportunity_custom_field`

Retrieve a single opportunity custom field by ID

List Groups`close_list_groups`

List all groups in your organization

Get Group`close_get_group`

Retrieve a single group by ID

Create Group`close_create_group`

Create a new group

Update Group`close_update_group`

Update an existing group

Delete Group`close_delete_group`

Delete a group

List Leads`close_list_leads`

List all leads in your Close organization

Get Lead`close_get_lead`

Retrieve a single lead by ID

Create Lead`close_create_lead`

Create a new lead

Update Lead`close_update_lead`

Update an existing lead

Delete Lead`close_delete_lead`

Delete a lead by ID

Merge Leads`close_merge_leads`

Merge two leads into one

List Opportunities`close_list_opportunities`

List or filter opportunities

Get Opportunity`close_get_opportunity`

Retrieve a single opportunity by ID

Create Opportunity`close_create_opportunity`

Create a new opportunity on a lead

Update Opportunity`close_update_opportunity`

Update an existing opportunity

Delete Opportunity`close_delete_opportunity`

Delete an opportunity by ID

List Pipelines`close_list_pipelines`

List all pipelines in your organization

Create Pipeline`close_create_pipeline`

Create a new pipeline

Update Pipeline`close_update_pipeline`

Update an existing pipeline

Delete Pipeline`close_delete_pipeline`

Delete a pipeline

List Roles`close_list_roles`

List all roles in your organization

Get Role`close_get_role`

Retrieve a single role by ID

Create Role`close_create_role`

Create a new role

Update Role`close_update_role`

Update an existing role

Delete Role`close_delete_role`

Delete a role

List Sequences`close_list_sequences`

List all sequences (workflows)

Get Sequence`close_get_sequence`

Retrieve a single sequence by ID

List Sequence Subscriptions`close_list_sequence_subscriptions`

List subscriptions for a sequence

Get Sequence Subscription`close_get_sequence_subscription`

Retrieve a single sequence subscription by ID

Subscribe Contact To Sequence`close_subscribe_contact_to_sequence`

Subscribe a contact to a sequence

Update Sequence Subscription`close_update_sequence_subscription`

Update a sequence subscription (pause/resume)

List Smart Views`close_list_smart_views`

List all smart views in your organization

Get Smart View`close_get_smart_view`

Retrieve a single smart view by ID

Create Smart View`close_create_smart_view`

Create a new smart view

Update Smart View`close_update_smart_view`

Update an existing smart view

Delete Smart View`close_delete_smart_view`

Delete a smart view

List Lead Statuses`close_list_lead_statuses`

List all lead statuses in your organization

Create Lead Status`close_create_lead_status`

Create a new lead status

Update Lead Status`close_update_lead_status`

Rename a lead status

Delete Lead Status`close_delete_lead_status`

Delete a lead status

List Opportunity Statuses`close_list_opportunity_statuses`

List all opportunity statuses in your organization

Create Opportunity Status`close_create_opportunity_status`

Create a new opportunity status

Update Opportunity Status`close_update_opportunity_status`

Rename an opportunity status

Delete Opportunity Status`close_delete_opportunity_status`

Delete an opportunity status

List Tasks`close_list_tasks`

List or filter tasks

Get Task`close_get_task`

Retrieve a single task by ID

Create Task`close_create_task`

Create a new task on a lead

Update Task`close_update_task`

Update an existing task

Delete Task`close_delete_task`

Delete a task by ID

Get Current User`close_get_current_user`

Fetch information about the authenticated user

List Users`close_list_users`

List all users in your organization

Get User`close_get_user`

Retrieve a single user by ID

List User Availabilities`close_list_user_availabilities`

List user availability statuses

## Events

Tags

Select all
|
Clear

Activities

Calls

Contacts

Emails

Leads

Meetings

Memberships

Notes

Opportunities

SMS

Sequences

Subscriptions

Tasks

Webhooks

No tags found

14 events

EventDescriptionTags

Reject Unsigned Webhook`close_webhook_reject_unsigned`

Rejects inbound Close webhook requests missing the close-sig-hash / close-sig-timestamp signature headers.

Webhooks

Lead Event`close_webhook_lead_event`

Processes Close lead webhook events (created, updated, deleted, merged).

LeadsWebhooks

Contact Event`close_webhook_contact_event`

Processes Close contact webhook events (created, updated, deleted).

ContactsWebhooks

Opportunity Event`close_webhook_opportunity_event`

Processes Close opportunity webhook events (created, updated, deleted).

OpportunitiesWebhooks

Call Activity Event`close_webhook_call_event`

Processes Close call activity webhook events (created, completed).

ActivitiesCallsWebhooks

Email Activity Event`close_webhook_email_event`

Processes Close email activity webhook events (created, sent).

ActivitiesEmailsWebhooks

SMS Activity Event`close_webhook_sms_event`

Processes Close SMS activity webhook events (created, sent).

ActivitiesSMSWebhooks

Note Activity Event`close_webhook_note_event`

Processes Close note activity webhook events (created, updated).

ActivitiesNotesWebhooks

Meeting Activity Event`close_webhook_meeting_event`

Processes Close meeting activity webhook events (scheduled, completed).

ActivitiesMeetingsWebhooks

Lead Status Change Event`close_webhook_lead_status_change_event`

Processes Close lead status change activity webhook events.

LeadsWebhooks

Opportunity Status Change Event`close_webhook_opportunity_status_change_event`

Processes Close opportunity status change activity webhook events.

OpportunitiesWebhooks

Task Event`close_webhook_task_event`

Processes Close lead task webhook events (created, completed).

TasksWebhooks

Sequence Subscription Event`close_webhook_sequence_subscription_event`

Processes Close sequence subscription webhook events (created, updated).

SequencesSubscriptionsWebhooks

Membership Event`close_webhook_membership_event`

Processes Close organization membership webhook events (activated, deactivated).

MembershipsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.