Automation connectors

Download OpenAPI spec

Automation connectors let you integrate third-party services and applications into your data analytics workflows. Use this API to discover available connectors and understand billing characteristics.

Use the namespaced API

Use the Automation Connectors API in the Workflows namespace for all new implementations.

This API remains available and fully supported, but consider using the namespaced API for new implementations.

List automation connectors

Deprecated
Replacement available

For new integrations, and when updating your existing integrations, use:

  • GET workflows/automation-connectors

Retrieves a list of automation connectors.

Facts

Rate limit Tier 1 (1000 requests per minute)
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.
Replaced by

Query Parameters

  • cursor string

    Pagination cursor returned from a previous request.

  • filter string

    Filters the result based on the specified criteria: name.

  • limit integer

    The number of automation connectors to retrieve.

    minimum = 1, maximum = 200, default = 100, default = 100

  • sort string

    The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order).

    Can be one of: "id""-id""+id""name""+name""-name"

    default = "id"

Responses

200

OK Response

  • application/json object
    Show application/json properties
    • data array of objects
      Show data properties
      • id string

        format = "uuid"

      • name string

        The name of an automation connector.

      • billable boolean

        Indicates if the connector is billable.

      • logoLarge string

        The URL to the large logo of the connector.

      • logoSmall string

        The URL to the small logo of the connector.

      • logoMedium string

        The URL to the medium logo of the connector.

      • description string

        The description of the automation connector.

      • hasWebhooks boolean

        Indicates if the connector supports webhooks.
    • links object
      Show links properties
      • next object
        Show next properties
        • href string

          The URL to a resource request
      • prev object
        Show prev properties
        • href string

          The URL to a resource request

400

Bad Request

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
        Required

        The unique code for the error

      • title string
        Required

        A summary of what went wrong

      • detail string

        May be used to provide additional details
    • traceId string

      A way to trace the source of the error.

401

Unauthorized

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
        Required

        The unique code for the error

      • title string
        Required

        A summary of what went wrong

      • detail string

        May be used to provide additional details
    • traceId string

      A way to trace the source of the error.

403

Forbidden

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
        Required

        The unique code for the error

      • title string
        Required

        A summary of what went wrong

      • detail string

        May be used to provide additional details
    • traceId string

      A way to trace the source of the error.

500

Internal Server Error

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
        Required

        The unique code for the error

      • title string
        Required

        A summary of what went wrong

      • detail string

        May be used to provide additional details
    • traceId string

      A way to trace the source of the error.

503

Service Unavailable

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
        Required

        The unique code for the error

      • title string
        Required

        A summary of what went wrong

      • detail string

        May be used to provide additional details
    • traceId string

      A way to trace the source of the error.
GET /api/v1/automation-connectors 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.automationConnectors.getAutomationConnectors(
  {},
)
qlik automation-connector ls
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/automation-connectors" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "0d87347d-27c0-11ea-921c-022e6b5ea1e2",
      "name": "Airtable",
      "billable": "true",
      "logoLarge": "https://cdn.qlikcloud.com/automations/logos/a2649cabda63b339ebc68a0c8d028f08.png",
      "logoSmall": "https://cdn.qlikcloud.com/automations/logos/a14638b5bf73f6d360f3c2732cf94bd9.png",
      "logoMedium": "https://cdn.qlikcloud.com/automations/logos/db2e3454fd01a6c3a53c09609a0b504f.png",
      "description": "Airtable is a cloud collaboration service.",
      "hasWebhooks": "true"
    }
  ],
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    }
  }
}