Sign Customiser

Navigation

Dark mode

Lists the commerce integrations the authenticated Store has connected, in the order they were connected (their id order). Requires integrations:read.

GET/api/v3/integrations
GETList integrations
GET/api/v3/integrations

List integrations

Lists the commerce integrations the authenticated Store has connected, in the order they were connected (their `id` order). Requires `integrations:read`. Follow `links.next` while `pagination.has_more` is true. A Store can have only one enabled integration; the other rows are integrations it disabled. `settings` shows the settings of the integration type, never its credentials, tokens or platform session ids.

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Query parameters

Page size from 1 to 100. Defaults to 20.

The opaque next_cursor from a previous page.

List integrations

Click Send to see the live response.

Overview

Follow links.next while pagination.has_more is true. A Store can have only one enabled integration; the other rows are integrations it disabled. settings shows the settings of the integration type, never its credentials, tokens or platform session ids.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: integrations:read

Query parameters

limitstringquery

Page size from 1 to 100. Defaults to 20.

Example: 20

cursorstringquery

The opaque next_cursor from a previous page.

Example: eyJ2IjoxfQ

List integrations
curl https://web.signcustomiser.com/api/v3/integrations?limit=20&cursor=eyJ2IjoxfQ \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": [
    {
      "object": "integration",
      "id": 12,
      "type": "custom",
      "name": "Workshop system",
      "enabled": true,
      "accepts_writes": true,
      "settings": {
        "create_product_url": "https://workshop.example.com/sign-customiser/products"
      }
    },
    {
      "object": "integration",
      "id": 9,
      "type": "shopify",
      "name": "Main store",
      "enabled": false,
      "accepts_writes": false,
      "settings": {
        "domain": "example.myshopify.com",
        "publication_id": null,
        "default_product_status": "active"
      }
    }
  ],
  "pagination": {
    "has_more": false,
    "next_cursor": null
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/integrations",
    "documentation": "https://www.signcustomiser.com/help/api/",
    "next": null
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.