Connectors

API for managing Integration App connectors and their licenses.

These endpoints are only available to Celigo Partners.

Connectors are packaged integration applications (e.g. "Shopify – NetSuite Connector") that Partners publish to the Celigo marketplace. Each connector has an install base, license management, and update push capabilities.

Connector schema

List connectors

get

/v1/connectors

Returns all connectors owned by the authenticated Partner account.

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Array of connector resources.

application/json

Connector object as returned by the API. Also used as the request body for create and update; readOnly fields are server-managed and ignored on writes.

namestringRequired

Display name for the connector, shown on its marketplace listing.

Example: Shopify - NetSuite

descriptionstringOptional

Summary of what the connector does, shown on its marketplace listing.

Example: Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.

imageURLstringOptional

URL of the connector's logo image displayed in the marketplace.

Example: https://integrator.io/images/connectors/shopify-netsuite.png

websiteURLstringOptional

URL of the publisher's product or documentation page for the connector.

Example: https://www.celigo.com/integration-apps/shopify-netsuite/

contactEmailstring · emailOptional

Contact email for the connector's publisher.

Example: support@example.com

publishedbooleanOptional

When true, the connector is visible in the Celigo marketplace.

managedbooleanOptional

When true, the connector is managed by Celigo.

_integrationIdstring · objectIdOptional

Master integration the connector packages and installs.

Example: 6405b9d73496e05ff253d587

_stackIdstring · objectIdOptional

Stack that hosts the connector's installer and lifecycle functions.

Example: 61f92026dd053843b5d72350

installerFunctionstringOptional

Function invoked from the connector's stack when the connector is installed.

Example: installConnector

updateFunctionstringOptional

Function invoked to apply connector updates to existing installations.

Example: updateConnector

preUninstallFunctionstringOptional

Function invoked before an installation is uninstalled.

Example: preUninstallConnector

uninstallerFunctionstringOptional

Function invoked when an installation is uninstalled.

Example: uninstallConnector

externalInstallerFunctionstringOptional

Function invoked for externally triggered installs (for example, installConnectorFromExternalApp).

Example: installConnectorFromExternalApp

_sharedImportIdsstring · objectId[]Optional

Imports shared with installations of this connector.

_sharedExportIdsstring · objectId[]Optional

Exports shared with installations of this connector.

applicationsstring[]Optional

Application slugs (e.g. netsuite, shopify).

trialEnabledbooleanOptional

When true, trial licenses are enabled for this connector. Requires trialPeriod and _trialLicenseId to be set.

trialPeriodintegerOptional

Trial period in days. Required when trialEnabled is true.

Example: 30

_trialLicenseIdstring · objectIdOptional

License template ID for trials. Required when trialEnabled is true.

Example: 624cb0356309dc3a543733a4

frameworkstring · enumOptional

Marks a connector built on the Integration App Framework 2.0. Set to twoDotZero for 2.0 connectors and omit for classic connectors; when set, twoDotZero._integrationId is required and must match _integrationId.

Example: twoDotZeroPossible values:

_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Format is a 24-character hexadecimal string.

Example: 5f8d43a1b9e5a80011a35f2c

createdAtstring · date-timeRead-onlyOptional

Timestamp when the resource was created. Set automatically and cannot be modified.

Example: 2023-04-01T09:15:32Z

lastModifiedstring · date-timeRead-onlyOptional

Timestamp when the resource was last updated. Changes whenever any property is modified.

Example: 2023-04-15T14:30:15Z

deletedAtstring · nullableRead-onlyOptional

Timestamp when the resource was soft-deleted. When null or absent, the resource is active.

Example: 2023-05-20T11:45:32Z

_userIdstring · objectIdRead-onlyRequired

User who published the connector.

Example: 54f66374661734964a00011e

handlestringRead-onlyRequired

Auto-generated short unique slug for the connector.

Example: sc4n

numInstallsintegerRead-onlyOptional

Number of active installations of this connector.

Example: 3672

204

No connectors exist.

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

get/v1/connectors

GET /v1/connectors HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "54fa0b38a7044f9252000036",
    "_userId": "54f66374661734964a00011e",
    "name": "Shopify - NetSuite",
    "handle": "sc4n",
    "description": "Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.",
    "applications": [
      "netsuite",
      "65bb6a09de4fef278556c5fe"
    ],
    "published": true,
    "trialEnabled": false,
    "numInstalls": 3672,
    "createdAt": "2015-03-06T20:16:56.000Z",
    "lastModified": "2026-04-22T07:14:42.124Z"
  }
]

Create a connector

post

/v1/connectors

Creates a new connector (Integration App).

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Fields that can be sent when creating or updating a connector. Partner accounts only.

namestringRequired

Display name for the connector, shown on its marketplace listing.

Example: Shopify - NetSuite

descriptionstringOptional

Summary of what the connector does, shown on its marketplace listing.

Example: Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.

imageURLstringOptional

URL of the connector's logo image displayed in the marketplace.

Example: https://integrator.io/images/connectors/shopify-netsuite.png

websiteURLstringOptional

URL of the publisher's product or documentation page for the connector.

Example: https://www.celigo.com/integration-apps/shopify-netsuite/

contactEmailstring · emailOptional

Contact email for the connector's publisher.

Example: support@example.com

publishedbooleanOptional

When true, the connector is visible in the Celigo marketplace.

managedbooleanOptional

When true, the connector is managed by Celigo.

_integrationIdstring · objectIdOptional

Master integration the connector packages and installs.

Example: 6405b9d73496e05ff253d587

_stackIdstring · objectIdOptional

Stack that hosts the connector's installer and lifecycle functions.

Example: 61f92026dd053843b5d72350

installerFunctionstringOptional

Function invoked from the connector's stack when the connector is installed.

Example: installConnector

updateFunctionstringOptional

Function invoked to apply connector updates to existing installations.

Example: updateConnector

preUninstallFunctionstringOptional

Function invoked before an installation is uninstalled.

Example: preUninstallConnector

uninstallerFunctionstringOptional

Function invoked when an installation is uninstalled.

Example: uninstallConnector

externalInstallerFunctionstringOptional

Function invoked for externally triggered installs (for example, installConnectorFromExternalApp).

Example: installConnectorFromExternalApp

_sharedImportIdsstring · objectId[]Optional

Imports shared with installations of this connector.

_sharedExportIdsstring · objectId[]Optional

Exports shared with installations of this connector.

applicationsstring[]Optional

Application slugs (e.g. netsuite, shopify).

trialEnabledbooleanOptional

When true, trial licenses are enabled for this connector. Requires trialPeriod and _trialLicenseId to be set.

trialPeriodintegerOptional

Trial period in days. Required when trialEnabled is true.

Example: 30

_trialLicenseIdstring · objectIdOptional

License template ID for trials. Required when trialEnabled is true.

Example: 624cb0356309dc3a543733a4

frameworkstring · enumOptional

Example: twoDotZeroPossible values:

Responses

201

Connector created.

application/json

Connector object as returned by the API. Also used as the request body for create and update; readOnly fields are server-managed and ignored on writes.

namestringRequired

Display name for the connector, shown on its marketplace listing.

Example: Shopify - NetSuite

descriptionstringOptional

Summary of what the connector does, shown on its marketplace listing.

Example: Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.

imageURLstringOptional

URL of the connector's logo image displayed in the marketplace.

Example: https://integrator.io/images/connectors/shopify-netsuite.png

websiteURLstringOptional

URL of the publisher's product or documentation page for the connector.

Example: https://www.celigo.com/integration-apps/shopify-netsuite/

contactEmailstring · emailOptional

Contact email for the connector's publisher.

Example: support@example.com

publishedbooleanOptional

When true, the connector is visible in the Celigo marketplace.

managedbooleanOptional

When true, the connector is managed by Celigo.

_integrationIdstring · objectIdOptional

Master integration the connector packages and installs.

Example: 6405b9d73496e05ff253d587

_stackIdstring · objectIdOptional

Stack that hosts the connector's installer and lifecycle functions.

Example: 61f92026dd053843b5d72350

installerFunctionstringOptional

Function invoked from the connector's stack when the connector is installed.

Example: installConnector

updateFunctionstringOptional

Function invoked to apply connector updates to existing installations.

Example: updateConnector

preUninstallFunctionstringOptional

Function invoked before an installation is uninstalled.

Example: preUninstallConnector

uninstallerFunctionstringOptional

Function invoked when an installation is uninstalled.

Example: uninstallConnector

externalInstallerFunctionstringOptional

Function invoked for externally triggered installs (for example, installConnectorFromExternalApp).

Example: installConnectorFromExternalApp

_sharedImportIdsstring · objectId[]Optional

Imports shared with installations of this connector.

_sharedExportIdsstring · objectId[]Optional

Exports shared with installations of this connector.

applicationsstring[]Optional

Application slugs (e.g. netsuite, shopify).

trialEnabledbooleanOptional

When true, trial licenses are enabled for this connector. Requires trialPeriod and _trialLicenseId to be set.

trialPeriodintegerOptional

Trial period in days. Required when trialEnabled is true.

Example: 30

_trialLicenseIdstring · objectIdOptional

License template ID for trials. Required when trialEnabled is true.

Example: 624cb0356309dc3a543733a4

frameworkstring · enumOptional

Example: twoDotZeroPossible values:

_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Format is a 24-character hexadecimal string.

Example: 5f8d43a1b9e5a80011a35f2c

createdAtstring · date-timeRead-onlyOptional

Timestamp when the resource was created. Set automatically and cannot be modified.

Example: 2023-04-01T09:15:32Z

lastModifiedstring · date-timeRead-onlyOptional

Timestamp when the resource was last updated. Changes whenever any property is modified.

Example: 2023-04-15T14:30:15Z

deletedAtstring · nullableRead-onlyOptional

Timestamp when the resource was soft-deleted. When null or absent, the resource is active.

Example: 2023-05-20T11:45:32Z

_userIdstring · objectIdRead-onlyRequired

User who published the connector.

Example: 54f66374661734964a00011e

handlestringRead-onlyRequired

Auto-generated short unique slug for the connector.

Example: sc4n

numInstallsintegerRead-onlyOptional

Number of active installations of this connector.

Example: 3672

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

422

Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.

application/json

post/v1/connectors

POST /v1/connectors HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

{
  "name": "Shopify - NetSuite",
  "description": "Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.",
  "applications": [
    "netsuite",
    "65bb6a09de4fef278556c5fe"
  ]
}

{
  "_id": "54fa0b38a7044f9252000036",
  "_userId": "54f66374661734964a00011e",
  "name": "Shopify - NetSuite",
  "handle": "sc4n",
  "description": "Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.",
  "applications": [
    "netsuite",
    "65bb6a09de4fef278556c5fe"
  ],
  "numInstalls": 0,
  "createdAt": "2015-03-06T20:16:56.000Z",
  "lastModified": "2015-03-06T20:16:56.000Z"
}

Get a connector

get

/v1/connectors/{_id}

Returns a single connector by ID.

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstringRequired

The connector ID.

Responses

200

The connector resource.

application/json

Connector object as returned by the API. Also used as the request body for create and update; readOnly fields are server-managed and ignored on writes.

namestringRequired

Display name for the connector, shown on its marketplace listing.

Example: Shopify - NetSuite

descriptionstringOptional

Summary of what the connector does, shown on its marketplace listing.

Example: Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.

imageURLstringOptional

URL of the connector's logo image displayed in the marketplace.

Example: https://integrator.io/images/connectors/shopify-netsuite.png

websiteURLstringOptional

URL of the publisher's product or documentation page for the connector.

Example: https://www.celigo.com/integration-apps/shopify-netsuite/

contactEmailstring · emailOptional

Contact email for the connector's publisher.

Example: support@example.com

publishedbooleanOptional

When true, the connector is visible in the Celigo marketplace.

managedbooleanOptional

When true, the connector is managed by Celigo.

_integrationIdstring · objectIdOptional

Master integration the connector packages and installs.

Example: 6405b9d73496e05ff253d587

_stackIdstring · objectIdOptional

Stack that hosts the connector's installer and lifecycle functions.

Example: 61f92026dd053843b5d72350

installerFunctionstringOptional

Function invoked from the connector's stack when the connector is installed.

Example: installConnector

updateFunctionstringOptional

Function invoked to apply connector updates to existing installations.

Example: updateConnector

preUninstallFunctionstringOptional

Function invoked before an installation is uninstalled.

Example: preUninstallConnector

uninstallerFunctionstringOptional

Function invoked when an installation is uninstalled.

Example: uninstallConnector

externalInstallerFunctionstringOptional

Function invoked for externally triggered installs (for example, installConnectorFromExternalApp).

Example: installConnectorFromExternalApp

_sharedImportIdsstring · objectId[]Optional

Imports shared with installations of this connector.

_sharedExportIdsstring · objectId[]Optional

Exports shared with installations of this connector.

applicationsstring[]Optional

Application slugs (e.g. netsuite, shopify).

trialEnabledbooleanOptional

When true, trial licenses are enabled for this connector. Requires trialPeriod and _trialLicenseId to be set.

trialPeriodintegerOptional

Trial period in days. Required when trialEnabled is true.

Example: 30

_trialLicenseIdstring · objectIdOptional

License template ID for trials. Required when trialEnabled is true.

Example: 624cb0356309dc3a543733a4

frameworkstring · enumOptional

Example: twoDotZeroPossible values:

_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Format is a 24-character hexadecimal string.

Example: 5f8d43a1b9e5a80011a35f2c

createdAtstring · date-timeRead-onlyOptional

Timestamp when the resource was created. Set automatically and cannot be modified.

Example: 2023-04-01T09:15:32Z

lastModifiedstring · date-timeRead-onlyOptional

Timestamp when the resource was last updated. Changes whenever any property is modified.

Example: 2023-04-15T14:30:15Z

deletedAtstring · nullableRead-onlyOptional

Timestamp when the resource was soft-deleted. When null or absent, the resource is active.

Example: 2023-05-20T11:45:32Z

_userIdstring · objectIdRead-onlyRequired

User who published the connector.

Example: 54f66374661734964a00011e

handlestringRead-onlyRequired

Auto-generated short unique slug for the connector.

Example: sc4n

numInstallsintegerRead-onlyOptional

Number of active installations of this connector.

Example: 3672

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

get/v1/connectors/{_id}

GET /v1/connectors/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "54fa0b38a7044f9252000036",
  "_userId": "54f66374661734964a00011e",
  "name": "Shopify - NetSuite",
  "handle": "sc4n",
  "description": "Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.",
  "applications": [
    "netsuite",
    "65bb6a09de4fef278556c5fe"
  ],
  "published": true,
  "trialEnabled": false,
  "numInstalls": 3672,
  "createdAt": "2015-03-06T20:16:56.000Z",
  "lastModified": "2026-04-22T07:14:42.124Z"
}

Update a connector

put

/v1/connectors/{_id}

Full-replaces a connector resource.

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstringRequired

The connector ID.

Body

Fields that can be sent when creating or updating a connector. Partner accounts only.

namestringRequired

Display name for the connector, shown on its marketplace listing.

Example: Shopify - NetSuite

descriptionstringOptional

Summary of what the connector does, shown on its marketplace listing.

Example: Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.

imageURLstringOptional

URL of the connector's logo image displayed in the marketplace.

Example: https://integrator.io/images/connectors/shopify-netsuite.png

websiteURLstringOptional

URL of the publisher's product or documentation page for the connector.

Example: https://www.celigo.com/integration-apps/shopify-netsuite/

contactEmailstring · emailOptional

Contact email for the connector's publisher.

Example: support@example.com

publishedbooleanOptional

When true, the connector is visible in the Celigo marketplace.

managedbooleanOptional

When true, the connector is managed by Celigo.

_integrationIdstring · objectIdOptional

Master integration the connector packages and installs.

Example: 6405b9d73496e05ff253d587

_stackIdstring · objectIdOptional

Stack that hosts the connector's installer and lifecycle functions.

Example: 61f92026dd053843b5d72350

installerFunctionstringOptional

Function invoked from the connector's stack when the connector is installed.

Example: installConnector

updateFunctionstringOptional

Function invoked to apply connector updates to existing installations.

Example: updateConnector

preUninstallFunctionstringOptional

Function invoked before an installation is uninstalled.

Example: preUninstallConnector

uninstallerFunctionstringOptional

Function invoked when an installation is uninstalled.

Example: uninstallConnector

externalInstallerFunctionstringOptional

Function invoked for externally triggered installs (for example, installConnectorFromExternalApp).

Example: installConnectorFromExternalApp

_sharedImportIdsstring · objectId[]Optional

Imports shared with installations of this connector.

_sharedExportIdsstring · objectId[]Optional

Exports shared with installations of this connector.

applicationsstring[]Optional

Application slugs (e.g. netsuite, shopify).

trialEnabledbooleanOptional

When true, trial licenses are enabled for this connector. Requires trialPeriod and _trialLicenseId to be set.

trialPeriodintegerOptional

Trial period in days. Required when trialEnabled is true.

Example: 30

_trialLicenseIdstring · objectIdOptional

License template ID for trials. Required when trialEnabled is true.

Example: 624cb0356309dc3a543733a4

frameworkstring · enumOptional

Example: twoDotZeroPossible values:

Responses

200

Updated connector.

application/json

Connector object as returned by the API. Also used as the request body for create and update; readOnly fields are server-managed and ignored on writes.

namestringRequired

Display name for the connector, shown on its marketplace listing.

Example: Shopify - NetSuite

descriptionstringOptional

Summary of what the connector does, shown on its marketplace listing.

Example: Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.

imageURLstringOptional

URL of the connector's logo image displayed in the marketplace.

Example: https://integrator.io/images/connectors/shopify-netsuite.png

websiteURLstringOptional

URL of the publisher's product or documentation page for the connector.

Example: https://www.celigo.com/integration-apps/shopify-netsuite/

contactEmailstring · emailOptional

Contact email for the connector's publisher.

Example: support@example.com

publishedbooleanOptional

When true, the connector is visible in the Celigo marketplace.

managedbooleanOptional

When true, the connector is managed by Celigo.

_integrationIdstring · objectIdOptional

Master integration the connector packages and installs.

Example: 6405b9d73496e05ff253d587

_stackIdstring · objectIdOptional

Stack that hosts the connector's installer and lifecycle functions.

Example: 61f92026dd053843b5d72350

installerFunctionstringOptional

Function invoked from the connector's stack when the connector is installed.

Example: installConnector

updateFunctionstringOptional

Function invoked to apply connector updates to existing installations.

Example: updateConnector

preUninstallFunctionstringOptional

Function invoked before an installation is uninstalled.

Example: preUninstallConnector

uninstallerFunctionstringOptional

Function invoked when an installation is uninstalled.

Example: uninstallConnector

externalInstallerFunctionstringOptional

Function invoked for externally triggered installs (for example, installConnectorFromExternalApp).

Example: installConnectorFromExternalApp

_sharedImportIdsstring · objectId[]Optional

Imports shared with installations of this connector.

_sharedExportIdsstring · objectId[]Optional

Exports shared with installations of this connector.

applicationsstring[]Optional

Application slugs (e.g. netsuite, shopify).

trialEnabledbooleanOptional

When true, trial licenses are enabled for this connector. Requires trialPeriod and _trialLicenseId to be set.

trialPeriodintegerOptional

Trial period in days. Required when trialEnabled is true.

Example: 30

_trialLicenseIdstring · objectIdOptional

License template ID for trials. Required when trialEnabled is true.

Example: 624cb0356309dc3a543733a4

frameworkstring · enumOptional

Example: twoDotZeroPossible values:

_idstring · objectIdRead-onlyRequired

Unique identifier for the resource. Format is a 24-character hexadecimal string.

Example: 5f8d43a1b9e5a80011a35f2c

createdAtstring · date-timeRead-onlyOptional

Timestamp when the resource was created. Set automatically and cannot be modified.

Example: 2023-04-01T09:15:32Z

lastModifiedstring · date-timeRead-onlyOptional

Timestamp when the resource was last updated. Changes whenever any property is modified.

Example: 2023-04-15T14:30:15Z

deletedAtstring · nullableRead-onlyOptional

Timestamp when the resource was soft-deleted. When null or absent, the resource is active.

Example: 2023-05-20T11:45:32Z

_userIdstring · objectIdRead-onlyRequired

User who published the connector.

Example: 54f66374661734964a00011e

handlestringRead-onlyRequired

Auto-generated short unique slug for the connector.

Example: sc4n

numInstallsintegerRead-onlyOptional

Number of active installations of this connector.

Example: 3672

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

422

Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.

application/json

put/v1/connectors/{_id}

PUT /v1/connectors/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 220

{
  "name": "Shopify - NetSuite",
  "description": "Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.",
  "published": true,
  "trialEnabled": false,
  "applications": [
    "netsuite",
    "65bb6a09de4fef278556c5fe"
  ]
}

{
  "_id": "54fa0b38a7044f9252000036",
  "_userId": "54f66374661734964a00011e",
  "name": "Shopify - NetSuite",
  "handle": "sc4n",
  "description": "Sync orders, customers, fulfillments, and inventory between Shopify and NetSuite.",
  "applications": [
    "netsuite",
    "65bb6a09de4fef278556c5fe"
  ],
  "published": true,
  "trialEnabled": false,
  "numInstalls": 3672,
  "createdAt": "2015-03-06T20:16:56.000Z",
  "lastModified": "2026-04-22T07:14:42.124Z"
}

Delete a connector

delete

/v1/connectors/{_id}

Deletes a connector. This does not affect existing installations.

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstringRequired

The connector ID.

Responses

204

Connector deleted.

No content

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

delete/v1/connectors/{_id}

DELETE /v1/connectors/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get the install base for a connector

get

/v1/connectors/{_id}/installBase

Returns the list of accounts that have installed this connector.

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstringRequired

The connector ID.

Responses

200

Install base data.

application/json

object[]Optional

204

No installations exist for this connector.

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

get/v1/connectors/{_id}/installBase

GET /v1/connectors/{_id}/installBase HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_integrationId": "5f7e39a76bb8d813180a9549",
    "user": {
      "_id": "624774a6a7574d3ed9f9a5cc",
      "email": "admin@example.com",
      "name": "Account Admin"
    }
  }
]

Push update to connector installations

put

/v1/connectors/{_id}/update

Pushes an update to all (or specified) installations of this connector. Triggers the connector's updateFunction on each target integration.

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstringRequired

The connector ID.

Body

_integrationIdsstring[]Optional

Optional list of specific integration IDs to update. Omit to push to all installations.

Responses

200

Update pushed.

No content

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

put/v1/connectors/{_id}/update

PUT /v1/connectors/{_id}/update HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "_integrationIds": [
    "5f7e39a76bb8d813180a9549"
  ]
}

No content

List licenses for a connector

get

/v1/connectors/{_id}/licenses

Returns all licenses issued for this connector.

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstringRequired

The connector ID.

Responses

200

Array of license records.

application/json

_idstring · objectIdRead-onlyOptional

System-generated unique identifier for the license.

Example: 624cb0356309dc3a543733a4

expiresstring · date-timeOptional

Date and time at which the license expires.

Example: 2027-04-05T00:00:00.000Z

createdstring · date-timeOptional

Timestamp when the license was created.

Example: 2022-04-05T21:10:13.226Z

_integrationIdstring · objectIdOptional

Integration instance created for the licensed user's installation of this connector. Each connector license maps one user's installation to its own integration.

Example: 5f7e39a76bb8d813180a9549

204

No licenses exist for this connector.

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

get/v1/connectors/{_id}/licenses

GET /v1/connectors/{_id}/licenses HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "624cb0356309dc3a543733a4",
    "created": "2022-04-05T21:10:13.226Z",
    "expires": "2027-04-05T00:00:00.000Z",
    "opts": {
      "connectorEdition": "premium",
      "addonLicenses": [
        {
          "type": "store",
          "licenses": [
            {
              "addOnEdition": "premium"
            }
          ]
        }
      ]
    },
    "user": {
      "_id": "624774a6a7574d3ed9f9a5cc",
      "email": "admin@example.com",
      "name": "Account Admin"
    },
    "_integrationId": "5f7e39a76bb8d813180a9549"
  }
]

Create a license for a connector

post

/v1/connectors/{_id}/licenses

Creates a new license for a connector. Supply the target user's email address in the request body — the backend resolves it to a user account. If the email is not a registered integrator.io user, an invalid_user error is returned.

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstringRequired

The connector ID.

Body

emailstring · emailOptional

Email address of the integrator.io user to license. The backend resolves this to a user account.

Example: admin@example.com

expiresstring · date-timeOptional

Date and time at which the license expires.

Example: 2027-04-05T00:00:00.000Z

Responses

201

License created.

application/json

_idstring · objectIdRead-onlyOptional

System-generated unique identifier for the license.

Example: 624cb0356309dc3a543733a4

expiresstring · date-timeOptional

Date and time at which the license expires.

Example: 2027-04-05T00:00:00.000Z

createdstring · date-timeOptional

Timestamp when the license was created.

Example: 2022-04-05T21:10:13.226Z

_integrationIdstring · objectIdOptional

Integration instance created for the licensed user's installation of this connector. Each connector license maps one user's installation to its own integration.

Example: 5f7e39a76bb8d813180a9549

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

422

Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.

application/json

post/v1/connectors/{_id}/licenses

POST /v1/connectors/{_id}/licenses HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "email": "admin@example.com",
  "expires": "2027-04-05T00:00:00.000Z",
  "opts": {
    "connectorEdition": "premium"
  }
}

{
  "_id": "624cb0356309dc3a543733a4",
  "created": "2022-04-05T21:10:13.226Z",
  "expires": "2027-04-05T00:00:00.000Z",
  "opts": {
    "connectorEdition": "premium"
  },
  "user": {
    "_id": "624774a6a7574d3ed9f9a5cc",
    "email": "admin@example.com",
    "name": "Account Admin"
  }
}

Get a license

get

/v1/connectors/{_id}/licenses/{_licenseId}

Returns a specific license for a connector.

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstringRequired

The connector ID.

_licenseIdstringRequired

The license ID.

Responses

200

The license record.

application/json

_idstring · objectIdRead-onlyOptional

System-generated unique identifier for the license.

Example: 624cb0356309dc3a543733a4

expiresstring · date-timeOptional

Date and time at which the license expires.

Example: 2027-04-05T00:00:00.000Z

createdstring · date-timeOptional

Timestamp when the license was created.

Example: 2022-04-05T21:10:13.226Z

_integrationIdstring · objectIdOptional

Integration instance created for the licensed user's installation of this connector. Each connector license maps one user's installation to its own integration.

Example: 5f7e39a76bb8d813180a9549

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

get/v1/connectors/{_id}/licenses/{_licenseId}

GET /v1/connectors/{_id}/licenses/{_licenseId} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "624cb0356309dc3a543733a4",
  "created": "2022-04-05T21:10:13.226Z",
  "expires": "2027-04-05T00:00:00.000Z",
  "opts": {
    "connectorEdition": "premium",
    "addonLicenses": [
      {
        "type": "store",
        "licenses": [
          {
            "addOnEdition": "premium"
          }
        ]
      }
    ]
  },
  "user": {
    "_id": "624774a6a7574d3ed9f9a5cc",
    "email": "admin@example.com",
    "name": "Account Admin"
  },
  "_integrationId": "5f7e39a76bb8d813180a9549"
}

Update a license

put

/v1/connectors/{_id}/licenses/{_licenseId}

Updates an existing license for a connector (e.g. change expiry or edition).

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstringRequired

The connector ID.

_licenseIdstringRequired

The license ID.

Body

_idstring · objectIdRead-onlyOptional

System-generated unique identifier for the license.

Example: 624cb0356309dc3a543733a4

expiresstring · date-timeOptional

Date and time at which the license expires.

Example: 2027-04-05T00:00:00.000Z

createdstring · date-timeOptional

Timestamp when the license was created.

Example: 2022-04-05T21:10:13.226Z

_integrationIdstring · objectIdOptional

Integration instance created for the licensed user's installation of this connector. Each connector license maps one user's installation to its own integration.

Example: 5f7e39a76bb8d813180a9549

Responses

200

Updated license.

application/json

_idstring · objectIdRead-onlyOptional

System-generated unique identifier for the license.

Example: 624cb0356309dc3a543733a4

expiresstring · date-timeOptional

Date and time at which the license expires.

Example: 2027-04-05T00:00:00.000Z

createdstring · date-timeOptional

Timestamp when the license was created.

Example: 2022-04-05T21:10:13.226Z

_integrationIdstring · objectIdOptional

Integration instance created for the licensed user's installation of this connector. Each connector license maps one user's installation to its own integration.

Example: 5f7e39a76bb8d813180a9549

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

422

Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.

application/json

put/v1/connectors/{_id}/licenses/{_licenseId}

PUT /v1/connectors/{_id}/licenses/{_licenseId} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "expires": "2028-04-05T00:00:00.000Z",
  "opts": {
    "connectorEdition": "premium",
    "addonLicenses": [
      {
        "type": "store",
        "licenses": [
          {
            "addOnEdition": "premium"
          }
        ]
      }
    ]
  }
}

{
  "_id": "624cb0356309dc3a543733a4",
  "created": "2022-04-05T21:10:13.226Z",
  "expires": "2028-04-05T00:00:00.000Z",
  "opts": {
    "connectorEdition": "premium",
    "addonLicenses": [
      {
        "type": "store",
        "licenses": [
          {
            "addOnEdition": "premium"
          }
        ]
      }
    ]
  },
  "user": {
    "_id": "624774a6a7574d3ed9f9a5cc",
    "email": "admin@example.com",
    "name": "Account Admin"
  },
  "_integrationId": "5f7e39a76bb8d813180a9549"
}

Delete a license

delete

/v1/connectors/{_id}/licenses/{_licenseId}

Deletes a license for a connector.

Partner-only endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstringRequired

The connector ID.

_licenseIdstringRequired

The license ID.

Responses

204

License deleted.

No content

400

Bad request. The server could not understand the request because of malformed syntax or invalid parameters.

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

delete/v1/connectors/{_id}/licenses/{_licenseId}

DELETE /v1/connectors/{_id}/licenses/{_licenseId} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Install a connector (Integration App)

post

/v1/connectors/{_id}/install

Triggers the install flow for a connector (Integration App). The connector must be associated with an integration that has the install function configured. Templates are installed via POST /v1/integrations/template/{_id} instead.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstring · objectIdRequired

The connector ID.

Body

Optional install configuration.

Other propertiesanyOptional

Responses

200

Connector install initiated.

application/json

Install response.

Other propertiesanyOptional

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Connector not found.

application/json

422

Connector is not associated with an integration that supports the install function.

application/json

post/v1/connectors/{_id}/install

POST /v1/connectors/{_id}/install HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "_integrationId": "5f7e39a76bb8d813180a9549"
}

Preview a connector install

get

/v1/connectors/{_id}/preview

Returns a preview of what installing this connector would produce. The connector must be associated with an integration that has the install function configured.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_idstring · objectIdRequired

The connector ID.

Responses

200

Connector install preview.

application/json

Preview envelope with resource docs.

Other propertiesanyOptional

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

application/json

404

Connector not found.

application/json

422

Connector is not associated with an integration that supports the install function.

application/json

get/v1/connectors/{_id}/preview

GET /v1/connectors/{_id}/preview HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "objects": [
    {
      "model": "Integration",
      "doc": {
        "_id": "6405b9d73496e05ff253d587",
        "name": "Shopify - NetSuite"
      }
    },
    {
      "model": "Connection",
      "doc": {
        "_id": "61f92026dd053843b5d72350",
        "type": "netsuite",
        "name": "NetSuite Connection"
      }
    }
  ],
  "stackRequired": false
}

PreviousConnections

NextEDI Profiles

Last updated 16 days ago

Was this helpful?