← Tools Reference

Close

Close integration (Productivity, Marketing). Imported from open-connector.

API key10 toolshttps://api.close.com/api/v1
GET
close_list_leads
List Close leads with optional pagination and field selection.

/lead/

3 parameters
ParamTypeRequiredDescription
limitintegeroptionalMaximum number of Close records to return.
skipintegeroptionalNumber of Close records to skip before this page.
includeFieldsarrayoptionalAdditional Close API fields to request through the _fields query parameter.
GET
close_get_lead
Fetch a single Close lead by ID.

/lead/{leadId}/

2 parameters
ParamTypeRequiredDescription
leadIdstringrequiredThe Close lead ID.
includeFieldsarrayoptionalAdditional Close API fields to request through the _fields query parameter.
POST
close_create_lead
Create a Close lead with optional nested contacts and addresses.

/lead/

6 parameters
ParamTypeRequiredDescription
namestringrequiredThe Close lead name.
descriptionstringoptionalThe Close lead description.
statusIdstringoptionalThe Close lead status ID.
urlstringoptionalThe lead website URL.
addressesarrayoptionalLead addresses.
contactsarrayoptionalNested contacts created together with the lead.
PUT
close_update_lead
Update writable fields on an existing Close lead.

/lead/{leadId}/

5 parameters
ParamTypeRequiredDescription
leadIdstringrequiredThe Close lead ID.
namestringoptionalThe Close lead name.
descriptionstringoptionalThe Close lead description.
statusIdstringoptionalThe Close lead status ID.
urlstringoptionalThe lead website URL.
GET
close_list_contacts
List Close contacts with optional lead filtering and pagination.

/contact/

4 parameters
ParamTypeRequiredDescription
limitintegeroptionalMaximum number of Close records to return.
skipintegeroptionalNumber of Close records to skip before this page.
includeFieldsarrayoptionalAdditional Close API fields to request through the _fields query parameter.
leadIdstringoptionalOnly return contacts linked to this Close lead ID.
GET
close_get_contact
Fetch a single Close contact by ID.

/contact/{contactId}/

2 parameters
ParamTypeRequiredDescription
contactIdstringrequiredThe Close contact ID.
includeFieldsarrayoptionalAdditional Close API fields to request through the _fields query parameter.
GET
close_list_tasks
List Close tasks with lead, assignee, completion, and view filters.

/task/

7 parameters
ParamTypeRequiredDescription
limitintegeroptionalMaximum number of Close records to return.
skipintegeroptionalNumber of Close records to skip before this page.
includeFieldsarrayoptionalAdditional Close API fields to request through the _fields query parameter.
leadIdstringoptionalOnly return tasks linked to this Close lead ID.
assignedTostringoptionalOnly return tasks assigned to this Close user ID.
isCompletebooleanoptionalOnly return tasks with this completion state.
viewstringoptionalThe Close task view filter such as inbox or archive.
GET
close_get_task
Fetch a single Close task by ID.

/task/{taskId}/

2 parameters
ParamTypeRequiredDescription
taskIdstringrequiredThe Close task ID.
includeFieldsarrayoptionalAdditional Close API fields to request through the _fields query parameter.
GET
close_list_opportunities
List Close opportunities with stable workflow filters and pagination.

/opportunity/

12 parameters
ParamTypeRequiredDescription
limitintegeroptionalMaximum number of Close records to return.
skipintegeroptionalNumber of Close records to skip before this page.
includeFieldsarrayoptionalAdditional Close API fields to request through the _fields query parameter.
leadIdstringoptionalOnly return opportunities linked to this Close lead ID.
userIdstringoptionalOnly return opportunities owned by this Close user ID.
statusIdstringoptionalOnly return opportunities in this Close status ID.
statusTypestringoptionalThe Close opportunity status type.
valuePeriodstringoptionalThe Close opportunity value period.
isStalledbooleanoptionalOnly return opportunities with this stalled flag.
querystringoptionalThe Close search query applied to opportunities.
leadQuerystringoptionalThe Close lead search query applied before opportunity filtering.
orderBystringoptionalThe Close _order_by value for sorting opportunities.
GET
close_get_opportunity
Fetch a single Close opportunity by ID.

/opportunity/{opportunityId}/

2 parameters
ParamTypeRequiredDescription
opportunityIdstringrequiredThe Close opportunity ID.
includeFieldsarrayoptionalAdditional Close API fields to request through the _fields query parameter.