Zum Hauptinhalt springen
GET
List Suppliers
Das Feld plots enthält die eindeutigen Parzellen des Lieferanten ohne Geometrie, höchstens 1000 Einträge (nach id sortiert); plotsTruncated: true zeigt an, dass es mehr gibt. Die eingebetteten articles[] tragen keine Parzellen — je Artikel liefert sie GET /api/v1/articles/{id}, die Geometrie einer Parzelle GET /api/v1/plots/{id}.

Autorisierungen

Authorization
string
header
erforderlich

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Abfrageparameter

externalSupplierId
string

Filter by the supplier number from your ERP (externalSupplierId): exact, case-sensitive match after trimming whitespace. Returns at most one supplier; your own company and suppliers invited by another supplier are not listed.

limit
integer
Standard:100

Maximum number of results to return (default 100, max 1000).

Erforderlicher Bereich: 1 <= x <= 1000
offset
integer | null
Standard:0

Number of results to skip for pagination.

Erforderlicher Bereich: x >= 0
fields
string

Comma-separated list of the resource's top-level keys to return (per element for a list), e.g. id,name; omit for the full body. Top-level only; whitespace is trimmed and duplicates count once. fields never adds keys: a selected optional key that is absent on a row stays absent. 400 when passed more than once, when empty, or when it names an unknown key (the error names it and lists the allowed ones).

Antwort

List of suppliers

id
string
erforderlich

UUID of the supplier.

name
string
erforderlich

Supplier company name.

contactName
string
erforderlich

Contact person; empty string when none is recorded.

country
string
erforderlich

Country of the supplier as recorded (the value sent on create, e.g. a country name); empty string when unknown.

status
string
erforderlich

Deprecated: legacy data-completeness flag, no longer maintained. Read articles[].complianceResults for the supplier's compliance status. One of: data_incomplete, data_complete, dds_submitted.

externalSupplierId
string | null
erforderlich

External ID from your ERP system

email
string
erforderlich

Contact email; empty string when none is recorded.

articles
object[]
erforderlich

The supplier's articles, without a plot list: plots holds the supplier's distinct plots; per-article plots via GET /articles/{id}.

plots
object[]
erforderlich

Distinct plots of the supplier without geometry, at most 1000 (ordered by id); fetch geometry via GET /plots/{id}.

complianceResults
object[]
erforderlich

Compliance results at supplier level. Compliance results live per article (articles[].complianceResults); expect [] here.

isCompanySelf
boolean
erforderlich

True if this supplier represents your own company (for sale articles)

supplierArticles
object[]
erforderlich

The supplier's links to articles (one supplier article per linked article).

deletedAt
string | null
erforderlich

When the supplier was moved to the trash (ISO 8601, UTC); null for a live supplier.

assignedToUserId
string | null
erforderlich

UUID of the user in your company responsible for this supplier, or null.

otpContactEmail
string | null
erforderlich

The email address the supplier confirmed for one-time security codes in the supplier portal, or null.

otpContactConfirmedAt
string | null
erforderlich

When the supplier confirmed otpContactEmail (ISO 8601, UTC), or null.

otpExemptUntil
string | null
erforderlich

Until when the supplier is exempt from one-time security codes in the supplier portal (ISO 8601, UTC), or null.

plotsTruncated
boolean
erforderlich

true when the supplier has more than 1000 distinct plots and plots holds only the first 1000 by id.

address
object

Postal address; absent when none is recorded.