List integrations

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/account/integrations

Costs 1 rate-limit point · Rate limits

Every third-party integration (Klaviyo, Postscript, Shopify Flow, Judge.me, Smile.io, Gorgias, Omnisend, Mailchimp, Meta Pixel, SplitOrder, Shopify customer sync) with its status: not_connected, off, setup_incomplete, needs_attention or connected, and a reason {code, message} unless connected. Each entry has the connection (method oauth, api_key or switch; never a key, only key_hint), selected_for (the channels it sends on, from /account/sending), plan, the setup steps with the endpoint that runs each, its non-secret settings, and links to the dashboard panel and the help article.

Filter with category (marketing, shopify or other: the Integrations page sections) or status. GET /account/integrations/:id reads one. Who sends each notification right now is GET /account/sending. Klaviyo settings.flows is the flow setup mode per campaign type and channel ({ restock: { email, sms }, ... }): automatic, manual, or null before the merchant chose.

Also searched asintegrationsintegration statusklaviyo connectionpostscript connectionomnisendmailchimpcustomer syncis klaviyo connectedwhich integrations are set up

Query parameters

categorystring
One of marketingshopifyother
statusstring
One of not_connectedoffsetup_incompleteneeds_attentionconnected

Errors

401

Missing or invalid X-Auth-Token.

422

The request failed validation.

429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check Retry-After.

Every error has the same shape: see Errors.

Example

GET/account/integrations

curl "https://app.stoqapp.com/api/v2/external/account/integrations" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/account/integrations", {
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.stoqapp.com/api/v2/external/account/integrations",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/account/integrations")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

GET/account/integrations

curl "https://app.stoqapp.com/api/v2/external/account/integrations?category=marketing&status=not_connected" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v2/external/account/integrations?category=marketing&status=not_connected", {
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.stoqapp.com/api/v2/external/account/integrations?category=marketing&status=not_connected",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v2/external/account/integrations?category=marketing&status=not_connected")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

No body

{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}

{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}