Sign in

v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB
Integrations

List integrations

List integrations matching the given parameters, paginated.

get/api/integrations

Query parameters

cursorstring
Example:WyJuZXh0IiwgIjIwMjItMDEtMDFUMDE6MDA6MDAiLCAxMjNd

Value indicating your position in the list of all integrations. If omitted, the first integrations of the list will be returned.

limitinteger

Maximum number of integrations to return.

order_by'created_datetime:asc' | 'created_datetime:desc'

Attribute used to order integrations.

type'email' | 'gmail' | 'outlook' | 'app' | 'aircall' | 'facebook' | 'gorgias_chat' | 'phone' | 'sms' | 'twitter' | 'yotpo' | 'whatsapp' | 'http' | 'shopify' | 'recharge' | 'smile' | 'smooch_inside' | 'smooch' | 'magento2' | 'zendesk' | 'klaviyo' | 'bigcommerce' | 'alloy' | 'ecom'
Example:http

Type of integration.

Response

List of integrations according to the given criteria.

objectstring required

Describes the object type of the payload.

uristring url required

Contains the URI of the fetched resource list.

Example response

{
  "meta": {
    "next_cursor": "WyJuZXh0IiwgIjIwMjEtMDEtMDFUMDE6MDA6MDAiLCA1MV0=",
    "prev_cursor": "WyJuZXh0IiwgIjIwMjEtMDEtMDFUMDE6MDA6MDAiLCA1MV0="
  },
  "object": "list",
  "uri": "/api/integrations?limit=100",
  "data": [
    {
      "id": 123,
      "created_datetime": "2021-01-07T13:00:00.123456",
      "http": {
        "id": 987,
        "url": "https://company.com/api/customers?email={{ticket.customer.email}}",
        "method": "GET",
        "form": {
          "hello": "world",
          "ticket_id": "{{ticket.id}}"
        },
        "triggers": {
          "ticket_created": true,
          "ticket_updated": true,
          "ticket_message_created": true,
          "ticket_self_unsnoozed": true,
          "ticket_message_failed": true,
          "ticket_assignee_updated": true,
          "ticket_status_updated": true,
          "ticket_handed_over": true
        },
        "request_content_type": "application/json",
        "response_content_type": "application/json"
      },
      "name": "My HTTP integration",
      "type": "http",
      "updated_datetime": "2021-01-07T13:00:00.123456"
    }
  ]
}