Close CRM

Provides integration with Close CRM using OAuth or API key authentication to query and manage supported CRM resources.

Revision History

0.0.0.3 - Initial release.

Connection

Use this Connection to store the Close CRM authentication settings and request configuration used by all Node methods.

Property Type Description
Base Url String Close API base URL. Leave the default value unless Close instructs you to use a different host.
Auth Mode Close CRM Auth Mode Selects whether the Connection uses API key Basic authentication or OAuth bearer-token authentication.
API Key Masked Close API key used as the Basic authentication username when Auth Mode is ApiKey.
Client Id String OAuth client identifier issued by Close when Auth Mode is OAuth.
Client Secret Masked OAuth client secret issued by Close when Auth Mode is OAuth.
Access Token Masked Current OAuth access token used for Close API requests.
Refresh Token Masked OAuth refresh token used to renew the access token.
Access Token Expires At UTC String UTC expiry timestamp used by Flowgear to refresh the access token before it expires.
Scopes String OAuth scopes granted to the Connection. The default scope is all.full_access offline_access.
Timeout (seconds) Integer Timeout used for Connection validation and runtime API calls. The default is 30.

Setup Notes

  1. Keep Base Url set to https://api.close.com/api/v1 unless Close instructs you to use a different host.
  2. Select the Auth Mode required by your Close integration.
  3. For API key authentication, set Auth Mode to ApiKey, enter the Close API key in API Key, then save and test the Connection.
  4. For OAuth authentication, create or reuse a Close OAuth app, then enter its Client Id and Client Secret on the Connection.
  5. Add the Flowgear OAuth callback URL for your environment to the Close OAuth app's allowed redirect URLs.
  6. Click Connect your Account, sign in to Close, and authorize access.
  7. Save and test the Connection after authorization. Flowgear validates the credentials against Close's current-user endpoint.

OAuth Connections use the stored Refresh Token to renew access automatically. Close can rotate refresh tokens, so Flowgear persists updated token values after a successful refresh.

Methods

The Node exposes template-driven methods backed by the embedded Close CRM OpenAPI document. Select a template so Flowgear fills in the correct OperationId, Options, and, when applicable, Items contract.

Query

Use Query to execute supported Close CRM read operations.

Parameter Type Description
Connection Connection Close CRM Connection profile.
OperationId String Identifier of the Close CRM query operation selected by the template.
Options Object Route and query values required by the selected operation.
Return Type Description
Response Array One normalized row for each object returned by Close. List responses emit one row per item in data[] and copy collection metadata onto each row under CloseCollection.

Create

Use Create to execute supported Close CRM create operations.

Parameter Type Description
Connection Connection Close CRM Connection profile.
OperationId String Identifier of the Close CRM create operation selected by the template.
Options Object Route and query values required by the selected operation.
Items Array Structured JSON request body for the selected create operation. Each top-level item is sent as a separate Close request.
Return Type Description
Response Array Normalized response rows with Close response fields and operation status fields under Flowgear.

Update

Use Update to execute supported Close CRM update operations.

Parameter Type Description
Connection Connection Close CRM Connection profile.
OperationId String Identifier of the Close CRM update operation selected by the template.
Options Object Route and query values required by the selected operation.
Items Array Structured JSON request body for the selected update operation. Each top-level item is sent as a separate Close request.
Return Type Description
Response Array Normalized response rows with Close response fields and operation status fields under Flowgear.

Delete

Use Delete to execute supported Close CRM delete operations.

Parameter Type Description
Connection Connection Close CRM Connection profile.
OperationId String Identifier of the Close CRM delete operation selected by the template.
Options Object Route and query values required by the selected operation.
Return Type Description
Response Array Normalized response row for the selected delete operation, including Close response fields when the provider returns a body.

Action

Use Action to execute supported Close CRM non-CRUD operations, e.g. merge, report, export, file, bulk-action, or field-enrichment operations.

Parameter Type Description
Connection Connection Close CRM Connection profile.
OperationId String Identifier of the Close CRM action operation selected by the template.
Options Object Route and query values required by the selected operation.
Items Array Optional structured JSON request body for the selected action operation. Templates show Items when the selected action requires a request body.
Return Type Description
Response Array Normalized response rows with Close response fields and operation status fields under Flowgear.

Usage Notes

  • Use the template picker to select a supported Close CRM operation. Templates set OperationId and expose the matching typed Options and Items fields.
  • You can browse and expand templates without live Close credentials because the Node uses an embedded OpenAPI document for template discovery.
  • Runtime API calls require a valid Close CRM Connection.
  • The Node shows only supported non-deprecated Close OpenAPI operations that match the Node's JSON request and response contract.
  • Options carries route and query values required by the selected OperationId. Missing required route values return a validation error before the request is sent.
  • Query list operations page internally. Workflow designers do not need to provide Close transport paging fields such as _limit, _skip, or _cursor when the Node manages paging.
  • Event queries use Close cursor paging internally with a page size of 50.
  • Query list responses unwrap data[] so each item becomes a separate Response row. Collection metadata such as has_more, total_results, cursor_next, and cursor_previous is preserved under Response.CloseCollection.
  • Create, Update, and body-based Action templates execute one Close request per top-level Items object and emit rows in input order.
  • Mutation response rows include Response.Flowgear.IsSuccess and, when available, Response.Flowgear.Message. Provider error payloads are preserved under Response.CloseError.
  • If a Close response already contains a Flowgear field, the provider value is preserved under Response.CloseOriginalFlowgear.

Known Issues

  • Close Advanced Filtering operations are not exposed in this release because they are documented outside the embedded OpenAPI document.