Articles in this section

Integration API endpoints

Kathyana Queeman
Updated

Download Postman collection

Understand and create integrations

Relative URI

Method

Success code

Description

/integrations

GET

200

Get all integrations.

POST

201

Create an integration.

/integrations/<_id>

GET

200

Get a specific integration.

PUT

200

Update a specific integration.

PATCH

204

Update part of a specific integration.

DELETE

204

Delete a specific integration.

/integrations/<_id>/clone

POST

201

Clone a specific integration.

/integrations/<_id>/flows

GET

200

Get flows associated with an integration.

/integrations/<_id>/connections

GET

200

Get connections associated with an integration.

/integrations/<_id>/connections/register

PUT

200

Register multiple connections at one time to an integration.

/integrations/<_id>/connections/<_connectionId>/register

PUT

200

Register a connection to an integration.

DELETE

204

Unregister a connection from an integration.

/integrations/<_id>/exports

GET

200

Get exports associated with an integration.

/integrations/<_id>/imports

GET

200

Get imports associated with an integration.

/integrations/<_id>/ashares

GET

200

Get users associated with an integration.

/integrations/<_id>/revisions/create

POST

201

Create a snapshot of a specific integration.

/integrations/<_id>/revisions/create?ignoreIfNoChanges

POST

201

Create a snapshot automatically, regardless of any changes to the integration. This snapshot always occurs, even if there are no changes to your integration. The ignoreIfNoChanges query parameter must be set to false.

POST

201

Create an automated snapshot only if you make new changes to your integration. The ignoreIfNoChanges query parameter must be set to true.

POST

204

Skip creating a snapshot when you don’t make changes. The ignoreIfNoChanges query parameter must be set to true.

/integrations/<_id>/audit

GET

200

Get a log for a specific integration.

/integrations/<_id>/template

GET

200

Download an integration.

/integrations/<_id>/dependencies

GET

200

Get all resources using or used by this integration.

The following fields are available to update using PATCH. You must use the following format to update the fields:

[
    {
        "op": "replace",
        "path": "/fieldname",
        "value": "newvalue"
    }
]

Field

Sub-field

Data type

settings

mixed

version

string

tag

string

updateInProgress

boolean

flowGroupings[*]

settings

mixed

aliases

mixed

Integration API examples

Register multiple connections at one time to an integration

PUT /v1/integrations/8s3••••••••5k4/connections/register HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Request body

[
  "<_connectionId>","<_connectionId>",...
]

Download an integration

Request body

POST /v1/integrations/8s3••••••••5k4/template HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Sample body
{
"signedURL":"https://integrator-templates.s3.amazonaws.com/8s3••••••••5k4.zip?AWSAccessKeyId=XXXXXXX&Expires=1707272837&Signature=XXXXXXXXX",
"key":"<integrationId>.zip"
}