younifyd
Menu

List Integrations

List integrations

GET/api/integrations

Use it in a workflow

  1. Add a step and choose the Gorgias connector.
  2. Pick the List Integrations action (under Integrations).
  3. Fill in the fields below, then reference the result from later steps as {{listIntegrations.response.data}}.

Request

Query parameters

cursorstring

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.

Default 30

order_bystring

Attribute used to order integrations.

One ofcreated_datetime:asccreated_datetime:descDefault "created_datetime:desc"

typestring

Type of integration.

One ofemailgmailoutlookappaircallfacebookgorgias_chatphonesmstwitteryotpowhatsapphttpshopifyrechargesmilesmooch_insidesmoochmagento2zendeskklaviyobigcommercealloyecom

Response

Returns 200 with an object. Read it in later steps with {{listIntegrations.response.data.<field>}}.

metaobject

Pagination metadata for the list.

next_cursorstring | nullrequired

Value indicating a cursor for the next page.

prev_cursorstring | nullrequired

Value indicating a cursor for the previous page.

objectany

Describes the object type of the payload.

Default "list"

uristring (url)

Contains the URI of the fetched resource list.

dataarray<object>
idinteger

ID of the integration.

created_datetimestring | null

When the integration was created.

deactivated_datetimestring | null

When the integration was deactivated.

descriptionstring | null

Description about the integration.

httpobject7 fields

Only available for HTTP integrations, defines the configuration of the integration.

namestringrequired

Name of the integration. Usually the email address, Facebook page name, etc.

typestring

Type of integration.

One ofhttp

updated_datetimestring | null

When the integration was last updated.

userobject1 fields

User which created this integration.

uristring

URI of the integration.

application_idstring | null

ID of the related application.

managedboolean

Whether integration is managed by Gorgias.

Default false

business_hours_idinteger | null

The ID of the business hour the phone integration is associated with. If null, the integration will use the default business hours.

json
{
  "meta": {
    "next_cursor": "WyJuZXh0IiwgIjIwMjEtMDEtMDFUMDE6MDA6MDAiLCA1MV0=",
    "prev_cursor": "WyJuZXh0IiwgIjIwMjEtMDEtMDFUMDE6MDA6MDAiLCA1MV0="
  },
  "object": "list",
  "uri": "/api/integrations?limit=100",
  "data": [
    {
      "name": "My HTTP integration",
      "id": 123,
      "created_datetime": "2021-01-07T13:00:00.123456",
      "deactivated_datetime": "2025-01-01T00:00:00Z",
      "description": "string",
      "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"
      },
      "type": "http",
      "updated_datetime": "2021-01-07T13:00:00.123456",
      "user": {
        "id": 0
      },
      "uri": "string",
      "application_id": "string",
      "managed": false
    }
  ]
}

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.