Shopify and Gorgias connection status (identifiers, never tokens)

Connection status for Shopify, Gorgias and the knowledge base. Tokens are reduced to booleans and never returned.

GET /api/v1/integrations

cURL

curl --request GET \
  --url 'https://response.stateset.com/api/v1/integrations' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY"

200

{
  "object": "integrations",
  "shopify": {
    "connected": true,
    "shop": "string",
    "scopes": "string",
    "connect_url": "string"
  },
  "gorgias": {
    "connected": true,
    "domain": "string",
    "username": "string",
    "connect_url": "string"
  },
  "knowledge_base": {
    "configured": true
  },
  "next_action": "string"
}

Response

object

object · string · required

shopify · object · required

Show shopify

connected · boolean · required

True when both a shop handle and an access token are stored.

shop · string,null · required

The myshopify handle.

scopes · string,null · required

Comma-separated granted scopes, when known.

connect_url · string,null · required

The OAuth path (/api/shopify/login) for a human to complete in a browser; null once connected.

gorgias · object · required

Show gorgias

connected · boolean · required

True when both a domain and an API key are stored.

domain · string,null · required

The Gorgias account handle.

username · string,null · required

The agent email the API key belongs to.

connect_url · string,null · required

The OAuth path (/api/gorgias/login-router) for a human to complete in a browser; null once connected.

knowledge_base · object · required

Show knowledge_base

configured · boolean · required

Whether a knowledge-base collection has been provisioned for the org.

next_action · string · required

A one-sentence suggestion: connect Shopify, connect Gorgias, or refresh store knowledge.

Status codes

Code	Meaning
200	Connection status for Shopify, Gorgias and the knowledge base. Tokens are reduced to booleans and never returned.
401	Missing, invalid, or expired API key.
403	The key lacks a required scope.
429	Rate limit exceeded.

Access

Required scope	agents:read
Rate limit	120 requests per minute

cURL

curl --request GET \
  --url 'https://response.stateset.com/api/v1/integrations' \
  --header "Authorization: Bearer $RESPONSECX_API_KEY"

200

{
  "object": "integrations",
  "shopify": {
    "connected": true,
    "shop": "string",
    "scopes": "string",
    "connect_url": "string"
  },
  "gorgias": {
    "connected": true,
    "domain": "string",
    "username": "string",
    "connect_url": "string"
  },
  "knowledge_base": {
    "configured": true
  },
  "next_action": "string"
}