List connected stores

GET/connectors

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT issued by the external IdP via the OAuth 2.0 authorization-code flow (Kinde in production; a simulator in test). The client obtains it and sends it as a Bearer token on every authenticated call. Sarvex's services verify it — issuer, audience, signature (IdP JWKS), expiry — and read identity and tenant from its claims. Sarvex does not issue or revoke these tokens. merchant_id/store_id are read from the verified claims (and the merchant→store mapping), never from the URL. The operator scope is required for /operator/*. Operators acting on a specific merchant pass the X-Operate-As header, which is recorded in the audit log.

Responses

200

Connectors with health.

dataconnector[]required

Show properties

Array of connector

connector_idstring

store_idstring

The store this connector belongs to (merchant → store → connector).

platformplatform

Connectable commerce backends: WooCommerce and Magento. The model and enum extend to further platform types without structural change.

Allowed:woocommercemagento

connector_typeconnector_type

What a connector record is for. commerce is the store's commerce backend and the only kind the checkout path calls. Absent on records written before the discriminator existed, which read as commerce.

Allowed:commerce

statusstring

Allowed:pairinghealthydegradeddown

sync_modelstring

Allowed:realtimepoll

last_signal_atstring<date-time> | null

last_full_sync_atstring<date-time> | null

last_heartbeat_atstring<date-time> | null

freshness_warningboolean

plugin_versionstring | null

profile_servingobject

Health of the plugin's Role 2 — serving /.well-known/ucp at the merchant origin. (The plugin serves only the profile; it does not proxy the UCP API.)

Show properties

profile_route_okboolean

Profile is being served with a 200 at the merchant domain.

last_profile_served_atstring<date-time> | null

serving_from_cacheboolean

Plugin is serving last-known-good because Sarvex was unreachable.

advertised_endpointstring | null

The services.endpoint the profile advertises — points at Sarvex (e.g. https://api.sarvex.example.com/ucp/v1/{store}).

pagepagerequired

Show properties

cursorstring | nullrequired

has_morebooleanrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Request

curl -X GET "https://api.sarvex.example.com/v1/connectors" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.sarvex.example.com/v1/connectors", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.sarvex.example.com/v1/connectors",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "data": [
    {
      "connector_id": "string",
      "store_id": "string",
      "platform": "woocommerce",
      "connector_type": "commerce",
      "status": "pairing",
      "sync_model": "realtime",
      "last_signal_at": "2019-08-24T14:15:22Z",
      "last_full_sync_at": "2019-08-24T14:15:22Z",
      "last_heartbeat_at": "2019-08-24T14:15:22Z",
      "freshness_warning": true,
      "plugin_version": "string",
      "profile_serving": {
        "profile_route_ok": true,
        "last_profile_served_at": "2019-08-24T14:15:22Z",
        "serving_from_cache": true,
        "advertised_endpoint": "string"
      }
    }
  ],
  "page": {
    "cursor": "string",
    "has_more": true
  }
}