This article covers REST API fields that are only applicable to integration apps.

Integration app fields

Field	Description
mode	The integrator.io user interface uses this as a read-only field. Valid values are: install - Indicates that the integration is still being installed by the user. settings - Indicates that the integration has finished installation, and that the user has access to the settings page for the integration. uninstall - Indicates that the integration is being uninstalled.
settings	This field stores the settings (i.e. the configuration) for the integration app integration. For example, when a user opens the settings page for an integration app integration running in their account, and they change a setting, this field is updated and propagates to the integration app's backend to adjust the integration accordingly.
version	This field stores the version of an integration running in the user's integrator.io account. Always increment the version field as a final step whenever you push any managed updates to a user's integrator.io account.
updateInProgress	This field is automatically set to true whenever you push a managed update to a user's integrator.io account. You must explicitly set this field back to false when your update is complete. While updateInProgress is true, the user can't change any settings or mappings in their integration.
install	Use this array field to specify all of the steps that are needed to install the integration app integration in a user's integrator.io account. You can also use this to track the state of each step so that the integrator.io UI knows which steps are complete and which steps the user should perform next.

Integration app examples

Get a specific DIY integration.

GET /v1/integrations/554155c853bb53af2900000b HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

{
    "_id":"554155c853bb53af2900000b",
    "lastModified":"2017-08-07T18:34:07.786Z",
    "name":"Licensing and Usage",
    "readme":"This integration is mission critical and keeps the licensing data..."
}

Get a specific integration app integration.

Notice all the extra fields related to integration apps.

GET /v1/integrations/57974ed227a82a3475cecb15 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

{
    "_id":"57974ed227a82a3475cecb15",
    "lastModified":"2017-09-15T10:55:15.675Z",
    "name":"BigCommerce - NetSuite Connector",
    "_connectorId":"57179182e0a908200c2781d9",
    "install":[
        {
            "name":"NetSuite Connection",
            "description":"Configure NetSuite account credentials",
            "imageURL":"/images/company-logos/netsuite.png",
            "completed":false,
            "installerFunction":"verifyNetSuiteConnection",
            "uninstallerFunction":"deleteNetSuiteConnection",
            "_connectionId":"57974ed21d2e4ab87ae46d99"
        },
        {
            "name":"BigCommerce Connection",
            "description":"Configure BigCommerce store credentials",
            "imageURL":"/images/company-logos/BigCommerce.png",
            "completed":false,
            "installerFunction":"verifyBigCommerceConnection",
            "uninstallerFunction":"deleteBigCommerceConnection",
            "_connectionId":"57974ed227a82a3475cecb17"
        },
        {
            "name":"Integrator Bundle",
            "description":"Install Integrator Bundle in NetSuite",
            "imageURL":"/images/company-logos/netsuite.png",
            "installURL":"",
            "completed":false,
            "installerFunction":"verifyIntegratorBundleInstallation",
            "uninstallerFunction":"uninstallVerifyIntegratorBundle"
        },
        {
            "name":"BigCommerce Bundle",
            "description":"Install BigCommerce Bundle in NetSuite",
            "imageURL":"/images/company-logos/netsuite.png",
            "installURL":"",
            "completed":false,
            "installerFunction":"verifyBigCommerceBundleInstallation",
            "uninstallerFunction":"uninstallVerifyBigCommerceBundle"
        }
    ],
    "mode":"install",
    "settings":{
        "sections":[
            {
                "temp":"remove_me"
            }
        ],
        "commonresources":{
            "genericExportApiIdentifier":"e7654358b7",
            "bigcommerceConnectionId":"57974ed227a82a3475cec222",
            "netsuiteConnectionId":"57464ed11d2e4ab87ae46d99"
        }
    },
    "version":"1.0.1"
}

State

State is an API only resource type that can store arbitrary JSON data (associated with a custom key). Typically the state API is used to persist data about a flow's last execution, and then to use that same data to parameterize the next execution of the flow (for example, the next time it runs).

Note: Documentation on state is also available at Celigo's state github repository.

State API

This generic key value storage API has many use cases. The most popular use case is storing state information about the execution of a flow, and then loading that state information before running the flow to parameterize the behavior of the flow. For example, every time a flow runs increment a sequence counter so that files uploaded to an FTP site can include a unique sequence id in the data so that the system processing the files can reject accidental duplicate files, or flag missing files.

State API endpoints

Relative URI	Method	Success Code	Description
/state	GET	200	Get all global keys.
/state/{key}	GET	200	Get the value associated with the key.
/state/{key}	PUT	200	Create/update the value associated with the key.
/state/{key}	DELETE	204	Delete the key and value.
/state	DELETE	204	Delete all global keys and values. Be careful with this API!
/{resource_type}/{_id}/state	GET	200	Get all keys stored underneath a specific resource in your account.
/{resource_type}/{_id}/state/{key}	GET	200	Get the resource specific value associated with the key.
/{resource_type}/{_id}/state/{key}	PUT	200	Create/update the resource specific value associated with the key.
/{resource_type}/{_id}/state/{key}	DELETE	200	Delete the resource specific key and value.
/{resource_type}/{_id}/state	DELETE	200	Delete all keys and values stored underneath the resource. Be careful with this API!

State API examples

Get all keys.

GET /v1/state HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

{
    "keys":[
        "apple",
        "banana"
    ]
}

Get the value for the key "banana".

GET /v1/state/banana HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

{
    "message":"Don't slip!"
}

Update the value for the key "banana".

PUT /v1/state/banana HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

{
    "message":"Don't slip!",
    "reply":"i didn't!"
}

Sample Response:

OK

Get the value for the key "banana" (again).

GET /v1/state/banana HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

{
    "message":"Don't slip!",
    "reply":"i didn't!"
}

Create a value to track a sequence number for an EDI data import (that would be updated every time the import is run).

Note: This state value is stored underneath the related import resource.

PUT /v1/imports/55cca9d6f7dc37597700005d/state/sequenceNumber HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

{
    "counter":1
}

Sample Response:

Created

Get the value just created above.

GET /v1/imports/55cca9d6f7dc37597700005d/state/sequenceNumber HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

{
    "counter":1
}

Get all keys (again).

Note: The key stored underneath the import (that we just created above) was not returned. Only global keys are returned by the top level GET /state API. To return all keys underneath a specific resource, use the more specific state API for that resource. For example, GET /imports/55cca9d6f7dc37597700005d/state

GET /v1/state HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

{
    "keys":[
        "apple",
        "banana"
    ]
}

GET /v1/imports/55cca9d6f7dc37597700005d/state HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

{
    "keys":[
        "sequenceNumber"
    ]
}

Less common resource types

iClient

Integration apps use iClients to store the authentication data required to connect with a specific API (on behalf of the integration app). For example, if you are building a integration app for Salesforce you are required (by Salesforce) to register your app, and Salesforce provides you with a client id, token, etc... You can use an iClient to store this data and also make it available ONLY to your integration app install base.

Note: Documentation on iClient is also available at Celigo's state github repository.

iClient API

The integrator.io UI does not support creating and/or editing iClient resources, and using the API is the only way to work with this resource type.

iClient API endpoints

Relative URI	Method	Success Code	Description
/iclients	GET	200	Get all iClients.
/iclients/{_id}	GET	200	Get a specific iClient.
/iclients	POST	201	Create a new iClient.
/iclients/{_id}	PUT	200	Update a specific iClient.
/iclients/{_id}	DELETE	204	Delete a specific iClient.

iClient API fields

Field	Description
Provider	Supported providers include the following: google, salesforce, azureoauth, windowslive, shopify, integrator, zendesk, bigcommerce, netsuite, ebay, amazonmws, ebay-xml, asana, box, dropbox, clover, servicenow, jobvite, twilio, certify, dropbox, squareup, docusign, and woocommerce
oauth2.clientId oauth2.clientSecret oauth2.scope oauth2.scopeDelimiter oauth2.redirectUri netsuite.consumerKey netsuite.consumerSecret salesforce.clientId salesforce.clientSecret salesforce.apiToken salesforce.privateKey salesforce.publicKey amazonmws.accessKeyId amazonmws.secretKey ebay.appId ebay.devId ebay.certId ebay.ruName

iClient API examples

Get all iClients.

GET /v1/iclients HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

[
    {
        "_id":"58c40879c13f547763bf2ffe",
        "name":"Amazon - North America",
        "lastModified":"2017-03-15T10:07:54.070Z",
        "provider":"amazonmws",
        "amazonmws":{
            "accessKeyId":"abcdef12345",
            "secretKey":"******"
        }
    },
    {
        "_id":"58d91651a81cfe09ec94a996",
        "name":"eBay Sandbox",
        "lastModified":"2017-04-12T07:50:56.863Z",
        "provider":"ebay-xml",
        "ebay":{
            "appId":"Celigo-XXXX",
            "devId":"abcdef12345",
            "certId":"******",
            "ruName":"Celigo-ABC"
        }
    },
    {
        "_id":"58d95676544a250f82e1e6a8",
        "name":"eBay",
        "lastModified":"2017-04-12T07:51:17.839Z",
        "provider":"ebay-xml",
        "ebay":{
            "appId":"Celigo-YYYY",
            "devId":"zyxwvu12345",
            "certId":"******",
            "ruName":"Celigo-XYZ"
        }
    },
    {
        "_id":"58f9dfc4a7d2ca9998e19c89",
        "name":"NetSuite",
        "lastModified":"2017-04-21T10:32:37.100Z",
        "provider":"netsuite",
        "netsuite":{
            "consumerKey":"******",
            "consumerSecret":"******"
        }
    },
    {
        "_id":"54fa0c93a7044f9252483038",
        "lastModified":"2015-12-09T11:17:23.235Z",
        "provider":"Shopify",
        "oauth2":{
            "clientId":"c12345",
            "clientSecret":"******",
            "scope":[
                "read_products",
                "write_products",
                "read_customers",
                "read_orders",
                "write_orders"
            ],
            "scopeDelimiter":","
        }
    }
]

Connector + License

The connector resource type represents the integration app solutions you build and list in the integrator.io marketplace. This resource type has basic listing type fields to help market your solution, and developer type fields to specify which functions on your server stack should be invoked when the connector is installed, uninstalled, etc... A license resource type is also available (within the context of a connector) to formally provision your solution to an end user. Using the related licensing APIs, you can fully automate provisioning of your solution with an external subscription and/or recurring payments platform. You can also use an integrator.io account to manage the data flows between those apps (for example, integrator.io and subscription/payment platform).

Note: Connector documentation is also available at Celigo's connector github repository.

Connector API

The primary use case for using this API is to automate provisioning and de-provisioning of your integration app product (based on your website sign-ups, web store purchases, or subscription management platform).

For example, you can allow users to register on your website for a free trial. When they click the submit button, your server backend can use this API to create a 30 day trial license. If you are using a formal subscription management platform, and a user's subscription ends, or a user does not submit a payment on time, you can use this API to automatically expire their license (thus shutting off their integration).

Connector API endpoints

Relative URI	Method	Success Code	Description
/connectors	GET	200	Get all connectors.
/connectors/{_id}	GET	200	Get a specific connector.
/connectors	POST	201	Create a new connector.
/connectors/{_id}	PUT	200	Update a specific connector.
/connectors/{_id}	DELETE	204	Delete a specific connector.
/connectors/{_id}/installBase	GET	200	Get the install base for a specific connector.
/connectors/{_id}/update	PUT	200	Push update to _integrationIds[].
/connectors/{_id}/licenses	GET	200	Get all licenses for a specific connector.
/connectors/{_id}/licenses	POST	201	Create new license for a specific connector.
/connectors/{_id}/licenses/{_id_of_license}	GET	200	Get a specific license.
/connectors/{_id}/licenses/{_id_of_license}	PUT	200	Update a specific license.
/connectors/{_id}/licenses/{_id_of_license}	DELETE	204	Delete a specific license.

Connector API examples

Get a specific connector.

GET /v1/connectors/54fa0b38a7044f9252000036 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

{
    "_id":"54fa0b38a7044f9252000036",
    "name":"Shopify - NetSuite Connector",
    "description":"Shopify - NetSuite Connector helps retailers combine the powerful Shopify eCommerce platform with the proven back-office features of NetSuite and keep the orders, customers, fulfillments, billings, items & inventory levels in sync.",
    "imageURL":"/images/company-logos/shopify-netsuite.png",
    "websiteURL":"http://www.celigo.com/products/netsuite-shopify-connector/",
    "contactEmail":"sales@celigo.com",
    "handle":"sc4n",
    "published":true,
    "managed":true,
    "_integrationId":"551c7be9accca83b3e00000c",
    "_stackId":"5593228187085d362c000009",
    "installerFunction":"installConnector",
    "updateFunction":"updateConnector",
    "preUninstallFunction":"preUninstallFunction",
    "uninstallerFunction":"uninstallConnector",
    "externalInstallerFunction":"installConnectorFromExternalApp",
    "lastModified":"2017-09-12T11:47:25.957Z",
    "_sharedImportIds":[

    ],
    "_sharedExportIds":[

    ],
    "_iClientIdMap":[
        {
            "_id":false,
            "_iClientIds":[
                "58f9dfc4a7d2ca3238e19c89"
            ],
            "connection":{
                "type":"netsuite"
            }
        }
    ],
    "applications":[
        "netsuite",
        "shopify"
    ],
    "oAuthServerFlow":{
        "_iClientId":"54fa0c93a7044f9252000038"
    }
}

Get all licenses for a specific connector.

GET /v1/connectors/54fa0b38a7044f9252000036/licenses HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

[
    {
        "_id":"59ef03a31ce1f53606837667",
        "expires":"2018-11-16T18:29:59.999Z",
        "created":"2017-10-24T09:10:59.408Z",
        "opts":{
            "addonLicenses":[
                {
                    "licenses":[
                        {
                            "addOnEdition":"standard"
                        }
                    ],
                    "type":"store"
                }
            ],
            "connectorEdition":"standard"
        },
        "user":{
            "email":"Jane.Doe@celigo.com",
            "_id":"585222eb73409e646b7375ed",
            "name":"John Doe"
        },
        "_integrationId":"59ef03c4b62d305b3c4534d5"
    },
    {
        "_id":"59dc541a93d54c44a7840220",
        "expires":"2025-07-01T00:00:00.000Z",
        "created":"2017-10-10T05:01:14.178Z",
        "opts":{
            "addonLicenses":[
                {
                    "licenses":[
                        {
                            "addOnEdition":"enterprise"
                        }
                    ],
                    "type":"store"
                }
            ],
            "connectorEdition":"enterprise"
        },
        "user":{
            "email":"John.Doe@celigo.com"
        }
    }
]

Create a new license for a specific connector.

Important: The API to create a new license (versus update an existing license) is unique in that you need to supply the email address of the integrator.io user in the post body, and then the integrator.io backend will use the email to dynamically find the correct user. Assuming the email is a valid user, you will see a read-only "user" property in the response, and then once the user clicks the install button from within their integrator.io account you will then see their "_id" and "name" values as well if you do another GET on the license resource (or just view it in your integrator.io account UI).

POST /v1/connectors/54fa0b38a7044f9252000036/licenses HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

{
    "email":"test@celigo.com",
    "expires":"2017-11-01T18:29:59.999Z",
    "opts":{
        "addonLicenses":[
            {
                "licenses":[
                    {
                        "addOnEdition":"standard"
                    }
                ],
                "type":"store"
            }
        ],
        "connectorEdition":"standard"
    }
}

Sample Response:

{
    "_id":"59ef68b384b38c7986d54549",
    "expires":"2017-11-01T18:29:59.999Z",
    "created":"2017-10-24T16:22:11.448Z",
    "opts":{
        "connectorEdition":"standard",
        "addonLicenses":[
            {
                "type":"store",
                "licenses":[
                    {
                        "addOnEdition":"standard"
                    }
                ]
            }
        ]
    },
    "user":{
        "email":"test@celigo.com"
    }
}

Update the license created above to change the expires date and also provision the enterprise version of the connector.

Note: Unlike the API to create new licenses (detailed above), you do NOT need to send "email" to update existing license records.

PUT /v1/connectors/54fa0b38a7044f9252000036/licenses/59ef68b384b38c7986d54549 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

{
    "expires":"2020-11-01T18:29:59.999Z",
    "opts":{
        "addonLicenses":[
            {
                "licenses":[
                    {
                        "addOnEdition":"enterprise"
                    }
                ],
                "type":"store"
            }
        ],
        "connectorEdition":"enterprise"
    }
}

Sample Response:

{
    "_id":"59ef68b384b38c7986d54549",
    "expires":"2020-11-01T18:29:59.999Z",
    "created":"2017-10-24T16:22:11.448Z",
    "opts":{
        "connectorEdition":"enterprise",
        "addonLicenses":[
            {
                "type":"store",
                "licenses":[
                    {
                        "addOnEdition":"enterprise"
                    }
                ]
            }
        ]
    },
    "user":{
        "email":"test@celigo.com",
        "_id":"585222eb73409e646b7375ff",
        "name":"Celigo Tester"
    },
    "_integrationId":"59ef03c4b62d305b3c45f4ee"
}

Create a license for someone that has not signed up for integrator.io yet.

POST /v1/connectors/54fa0b38a7044f9252000036/licenses HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

{
    "email":"does_not_exist@celigo.com",
    "expires":"2017-11-01T18:29:59.999Z",
    "opts":{
        "addonLicenses":[
            {
                "licenses":[
                    {
                        "addOnEdition":"standard"
                    }
                ],
                "type":"store"
            }
        ],
        "connectorEdition":"standard"
    }
}

Sample Response:

{
    "errors":[
        {
            "code":"invalid_user",
            "message":"We were not able to find any user with the provided email address. Please ask the user to first create an integrator.io account."
        }
    ]
}

Template

This is the listing record for Templates in the integrator.io marketplace. Templates are different than integration apps in that they are completely un-managed once installed by end users.

Note: Template documentation is also available at Celigo's template github repository.

Template API

No use cases currently exist for the template API resource type. This is just a placeholder for future use if a good use case is ever discovered.

Template API endpoints

Relative URI	Method	Success Code	Description
/templates	GET	200	Get all templates.
/templates/{_id}	GET	200	Get a specific template.
/templates	POST	201	Create a new template.
/templates/{_id}	PUT	200	Update a specific template.
/templates/{_id}	DELETE	204	Delete a specific template.

Template API examples

Get all templates in my account.

GET /v1/template HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

[
    {
        "_id":"58f109e8927af74d60801fff",
        "name":"Send GitHub Notifications to Slack",
        "description":"This is a very simple integration that listens for commit events in GitHub, and then posts messages to Slack so that people can use Slack to monitor developer activity. The benefit of using this integration vs the free integration provided by Slack is that you can customize how the messages post to Slack. For example, you might want messages to post as if they were sent by the user that triggered the event in GitHub (vs a generic bot type user).",
        "imageURL":"https://secure.gravatar.com/avatar/33895cc016e520a2a07131c3753d8d4f?d=mm&s=55",
        "websiteURL":"http://www.celigo.com/",
        "contactEmail":"template@celigo.com",
        "published":true,
        "lastModified":"2017-04-24T16:54:25.186Z",
        "applications":[
            "github",
            "slack"
        ]
    },
    {
        "_id":"58f10e49927af74d608022ac",
        "name":"Send Travis Build Notifications to Slack",
        "description":"This integration listens for build notifications in Travis CI and posts messages to Slack. Very similar to the native integration that Slack has in their integration marketplace, except now you can completely customize how the messages appear in Slack. For example, you might want to minimize the message content that gets sent to Slack to only show the repository, user, and build status.",
        "imageURL":"https://secure.gravatar.com/avatar/33895cc016e520a2a07131c3753d8d4f?d=mm&s=55",
        "websiteURL":"http://www.celigo.com/",
        "contactEmail":"template@celigo.com",
        "published":true,
        "lastModified":"2017-04-24T16:57:55.663Z",
        "applications":[
            "slack",
            "travis"
        ]
    },
    {
        "_id":"58f12659c468a47a9489242c",
        "name":"Send Zendesk Tickets to Slack",
        "description":"This integration routes Zendesk tickets into Slack. This integration is used by Celigo's engineering and QA department to keep an eye on all support tickets being logged throughout the day (i.e. without having to login to Zendesk).",
        "imageURL":"https://secure.gravatar.com/avatar/33895cc016e520a2a07131c3753d8d4f?d=mm&s=55",
        "websiteURL":"http://www.celigo.com/",
        "contactEmail":"template@celigo.com",
        "published":true,
        "lastModified":"2017-04-24T16:58:00.199Z",
        "applications":[
            "slack",
            "zendesk"
        ]
    }
]

Update a specific template in my account.

PUT /v1/template/58f12659c468a47a9489242c HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

{
    "name":"Give your template a really great name!",
    "description":"A good description helps a lot too.",
    "imageURL":"https://secure.gravatar.com/avatar/33895cc016e520a2a07131c3753d8d4f?d=mm&s=55",
    "websiteURL":"http://www.celigo.com/",
    "contactEmail":"template@celigo.com",
    "published":true,
    "applications":[
        "slack",
        "zendesk"
    ]
}

Sample Response:

{
    "_id":"58f12659c468a47a9489242c",
    "name":"Give your template a really great name!",
    "description":"A good description helps a lot too.",
    "imageURL":"https://secure.gravatar.com/avatar/33895cc016e520a2a07131c3753d8d4f?d=mm&s=55",
    "websiteURL":"http://www.celigo.com/",
    "contactEmail":"template@celigo.com",
    "published":true,
    "lastModified":"2017-10-24T15:03:45.140Z",
    "applications":[
        "slack",
        "zendesk"
    ]
}

Job

Jobs represent the state of a flow while it is running (start time, status, percentage complete, etc...) and the final stats for a flow when it has finished running (num success, num error, end time, etc...).

Note: Job documentation is also available at Celigo's job github repository.

Job API

This API has many use cases. For example, you can extract stats about running integrations, and submit those stats to an anlytics platform. You can also extract all errors and process them in an external database. The integrator.io UI is always evolving to better support new use cases, but this API allows you to extract raw data for processes that aren't yet supported by the integrator.io UI.

Job API endpoints

Relative URI	Method	Success Code	Description
/jobs	GET	200	Get all jobs. The following query parameters are supported: _integrationId, _exportId, _importId, _flowId, _flowJobId, _bulkJobId, _flowId_in, createdAt_lte, createdAt_gte, status, numSuccess_lte, numSuccess_gte, numExport_lte, numExport_gte, numIgnore_lte, numIgnore_gte, retriable, type, and type_in
/jobs/{_id}	GET	200	Get a specific job.
/jobs/{_id}/joberrors	GET	200	If a job has <= 1000 errors use this API to retrieve the errors directly.
/jobs/{_id}/errorFile/signedURL	GET	200	If a job has > 1000 errors, or you prefer to get a file, use this API to get a signed URL that can then be used to download an error file directly from S3.

Job API examples

Get all jobs where type is "import" and status is "running".

GET /v1/jobs?type=import&status=running HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

[
    {
        "_id":"59ee8f9503785d04d846a88e",
        "type":"import",
        "_importId":"537d1ff57ab1870200000002",
        "_flowJobId":"59ee8f80e41d93365ef1b9a9",
        "startedAt":"2017-10-24T00:55:49.128Z",
        "status":"running",
        "numError":0,
        "numSuccess":1,
        "numIgnore":0,
        "numPagesProcessed":1,
        "oIndex":1,
        "retriable":false,
        "createdAt":"2017-10-24T00:55:49.128Z",
        "lastModified":"2017-10-24T00:55:49.642Z"
    }
]

Get job errors for a specific import job.

GET /v1/jobs/59ee8cad03785d04d8469918/jobErrors HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token

Sample Response:

[
    {
        "resolve":false,
        "retry":false,
        "createdAt":"2017-10-24T00:43:30.434Z",
        "code":"422",
        "extract":"",
        "generate":"",
        "extracted":"",
        "generated":"",
        "message":"'{\"errors\":[{\"field\":\"expires\",\"code\":\"missing_required_field\"}]}'",
        "source":"integrator.io",
        "exportDataURI":"",
        "importDataURI":"",
        "_retryId":"59ee8cb203785d04d8469919",
        "_jobId":"59ee8cad03785d04d8469918"
    }
]

Integration app only REST API fields

Contents

Integration app fields

Integration app examples

State

State API

State API endpoints

State API examples

Less common resource types

iClient

iClient API

iClient API endpoints

iClient API fields

iClient API examples

Connector + License

Connector API

Connector API endpoints

Connector API examples

Template

Template API

Template API endpoints

Template API examples

Job

Job API

Job API endpoints

Job API examples

Comments

Contents

Integration app fields

Integration app examples

State

State API

State API endpoints

State API examples

Less common resource types

iClient

iClient API

iClient API endpoints

iClient API fields

iClient API examples

Connector + License

Connector API

Connector API endpoints

Connector API examples

Template

Template API

Template API endpoints

Template API examples

Job

Job API

Job API endpoints

Job API examples

Related articles