Close integration (Productivity, Marketing). Imported from open-connector.
https://api.close.com/api/v1/lead/
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Maximum number of Close records to return. |
| skip | integer | optional | Number of Close records to skip before this page. |
| includeFields | array | optional | Additional Close API fields to request through the _fields query parameter. |
/lead/{leadId}/
| Param | Type | Required | Description |
|---|---|---|---|
| leadId | string | required | The Close lead ID. |
| includeFields | array | optional | Additional Close API fields to request through the _fields query parameter. |
/lead/
| Param | Type | Required | Description |
|---|---|---|---|
| name | string | required | The Close lead name. |
| description | string | optional | The Close lead description. |
| statusId | string | optional | The Close lead status ID. |
| url | string | optional | The lead website URL. |
| addresses | array | optional | Lead addresses. |
| contacts | array | optional | Nested contacts created together with the lead. |
/lead/{leadId}/
| Param | Type | Required | Description |
|---|---|---|---|
| leadId | string | required | The Close lead ID. |
| name | string | optional | The Close lead name. |
| description | string | optional | The Close lead description. |
| statusId | string | optional | The Close lead status ID. |
| url | string | optional | The lead website URL. |
/contact/
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Maximum number of Close records to return. |
| skip | integer | optional | Number of Close records to skip before this page. |
| includeFields | array | optional | Additional Close API fields to request through the _fields query parameter. |
| leadId | string | optional | Only return contacts linked to this Close lead ID. |
/contact/{contactId}/
| Param | Type | Required | Description |
|---|---|---|---|
| contactId | string | required | The Close contact ID. |
| includeFields | array | optional | Additional Close API fields to request through the _fields query parameter. |
/task/
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Maximum number of Close records to return. |
| skip | integer | optional | Number of Close records to skip before this page. |
| includeFields | array | optional | Additional Close API fields to request through the _fields query parameter. |
| leadId | string | optional | Only return tasks linked to this Close lead ID. |
| assignedTo | string | optional | Only return tasks assigned to this Close user ID. |
| isComplete | boolean | optional | Only return tasks with this completion state. |
| view | string | optional | The Close task view filter such as inbox or archive. |
/task/{taskId}/
| Param | Type | Required | Description |
|---|---|---|---|
| taskId | string | required | The Close task ID. |
| includeFields | array | optional | Additional Close API fields to request through the _fields query parameter. |
/opportunity/
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Maximum number of Close records to return. |
| skip | integer | optional | Number of Close records to skip before this page. |
| includeFields | array | optional | Additional Close API fields to request through the _fields query parameter. |
| leadId | string | optional | Only return opportunities linked to this Close lead ID. |
| userId | string | optional | Only return opportunities owned by this Close user ID. |
| statusId | string | optional | Only return opportunities in this Close status ID. |
| statusType | string | optional | The Close opportunity status type. |
| valuePeriod | string | optional | The Close opportunity value period. |
| isStalled | boolean | optional | Only return opportunities with this stalled flag. |
| query | string | optional | The Close search query applied to opportunities. |
| leadQuery | string | optional | The Close lead search query applied before opportunity filtering. |
| orderBy | string | optional | The Close _order_by value for sorting opportunities. |
/opportunity/{opportunityId}/
| Param | Type | Required | Description |
|---|---|---|---|
| opportunityId | string | required | The Close opportunity ID. |
| includeFields | array | optional | Additional Close API fields to request through the _fields query parameter. |