List sources

Overview

List connected shops and import sources for this account. Use id as source when creating a manual subscription. Includes inactive sources.

gethttps://api.subsail.com/v1/sources/

Request parameters

cursorstring

query

Opaque cursor from the previous response. Omit for the first page.

limitnumber

query

Items per page. Default: 50. Maximum: 200.

Request body

No request body.

Request examples

No request body.

Responses

200Paginated list of sources

has_morebooleanRequired

True if more items are available after this page.

cursorstringRequired

Pass this as cursor to fetch the next page. Null when has_more is false.

itemsSource[]Required

Array (Source):

idstring

Source ID. Pass this as source when creating a subscription.

namestring

Display name (custom name if set, otherwise the platform name).

platformstring

Platform name, e.g. Shopify, WooCommerce, Custom.

is_activeboolean

Inactive sources are hidden from import forms and do not run automatic imports.

Example

JSON

{
  "has_more": "<boolean>",
  "cursor": "<string>",
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "platform": "<string>",
      "is_active": "<boolean>"
    }
  ]
}

401Missing or invalid API key (empty response body).

403Account is inactive (empty response body).