List suppliers

List suppliers.

GET/suppliers

Authorization

AuthorizationBearer token (API key) · headerrequired

Organization API key.

Query parameters

limitinteger

Page size (1–5000, default 100).

min 1 · max 5000 · default: 100

Responses

200Suppliers with meta

dataSupplier[]required

Show properties

Array of Supplier

idstring

namestring

externalIdstring

Optional external identifier

companystring

citystring

streetstring

plzstring

organizationIdstring

emailstring

payoutEmailstring

orderEmailstring

phonestring

contactPersonstring

contactPhonestring

dailyMailstring

deletedboolean

supplierMarginnumber

ibanstring

bicstring

bankNamestring

payoutsEnabledboolean

createdatestring<date-time>

metaListMetarequired

List metadata. `returned` is the length of `data`. Soft-deleted catalog rows are omitted from list results, so `returned` may be less than `limit` even when more active items exist. When `nextCursor` is present, more pages may exist — keep paging until `nextCursor` is absent.

Show properties

totalintegerrequired

With product search (`q`) without `store`: estimated match count. With `store`: equals `returned` after store visibility filtering. Otherwise equals `returned`. Soft-deleted items are omitted, so a page may be shorter than `limit` even when more active items exist.

returnedintegerrequired

Number of active items in `data` (soft-deleted rows excluded).

limitintegerrequired

Applied page size.

offsetinteger

Only for product search with `q`.

nextCursorstring

Opaque cursor for the next page. Present when more results may exist. Do not parse; pass unchanged as `cursor`. Under soft-delete filtering, `returned < limit` does not mean the list is finished.

400Bad request

errorValidationErrorrequired

Validation details.

Show properties

formErrorsstring[]required

fieldErrorsobjectrequired

403Unauthorized

statusCodeintegerrequired

HTTP status code

messagestringrequired

Human-readable error message

timestampstring<date-time>required

pathstringrequired

Request path

Request

curl -X GET "https://dashboard.scango.ch/api/v1/suppliers" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://dashboard.scango.ch/api/v1/suppliers", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "externalId": "string",
      "company": "string",
      "city": "string",
      "street": "string",
      "plz": "string",
      "organizationId": "string",
      "email": "string",
      "payoutEmail": "string",
      "orderEmail": "string",
      "phone": "string",
      "contactPerson": "string",
      "contactPhone": "string",
      "dailyMail": "string",
      "deleted": true,
      "supplierMargin": 0,
      "iban": "string",
      "bic": "string",
      "bankName": "string",
      "payoutsEnabled": true,
      "createdate": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "total": 0,
    "returned": 0,
    "limit": 0,
    "offset": 0,
    "nextCursor": "string"
  }
}