Skip to content

Get an integration

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

GET/account/integrations/{id}

Costs 1 rate-limit point · Rate limits

One integration's status, as in GET /account/integrations. id is one of: klaviyo, postscript, shopify_flow, judgeme, smile, gorgias, omnisend, mailchimp, meta_pixel, split_order, shopify_customers.

A step with an action names the endpoint that runs it. After the merchant connects or saves a key in the dashboard, read this again to see the result.

Also searched asklaviyo statuspostscript statusgorgias statuswhy is klaviyo not sendingfinish klaviyo setup

Path parameters

Returns

The integration object.

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

404
unknown_integration

The integration id is not one STOQ supports.

422
validation_failed

The request failed validation.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/account/integrations/{id}
curl "https://app.stoqapp.com/api/v2/external/account/integrations/string" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "id": "string",
  "name": "string",
  "category": "string",
  "used_for": [
    "string"
  ],
  "status": "string",
  "reason": {
    "code": "string",
    "message": "string"
  },
  "connection": {
    "method": "string",
    "connected": true,
    "legacy": true,
    "key_hint": null
  },
  "connect": {
    "pending": true,
    "expires_at": null,
    "last_result": null,
    "last_result_at": null
  },
  "selected_for": [
    null
  ],
  "plan": {
    "required": "string",
    "available": true
  },
  "steps": [
    {
      "id": "string",
      "state": "string",
      "required": true,
      "blocked_by": "string"
    }
  ],
  "settings": {
    "account": null,
    "sidebar_ready": true,
    "sync_customers": true,
    "profile_tag": "string",
    "flows": {
      "restock": {
        "email": null,
        "sms": null
      },
      "wishlist_reminder": {
        "email": null,
        "sms": null
      },
      "preorder": {
        "email": null,
        "sms": null
      },
      "signup_thank_you": {
        "email": null,
        "sms": null
      }
    }
  },
  "actions": [
    "string"
  ],
  "links": {
    "dashboard_url": "string",
    "help_url": "string"
  },
  "recent_events": [
    null
  ]
}