Get an integration
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/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
idstringRequiredThe integration, by the id
GET /account/integrationslists (klaviyo, postscript …).
Returns
The integration object.
Errors
not_foundThe path is valid but nothing with that id exists in this store.
unknown_integrationThe integration id is not one STOQ supports.
validation_failedThe 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.
curl "https://app.stoqapp.com/api/v2/external/account/integrations/string" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/account/integrations/string", {
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/string",
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/string")
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){
"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
]
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Offer not found"
],
"code": "not_found",
"details": [
{
"code": "not_found",
"message": "Offer not found",
"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
}
]
}