Skip to main content
GET
Get Supplier by ID
plots lists the supplier’s distinct plots without geometry, at most 1000 entries (ordered by id); plotsTruncated: true means more exist. The embedded articles[] carry no plots — fetch them per article via GET /api/v1/articles/{id}, and a plot’s geometry via GET /api/v1/plots/{id}.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Query Parameters

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).

Response

Supplier details

A supplier as returned by GET /suppliers and GET /suppliers/{id}.

id
string
required

UUID of the supplier.

name
string
required

Supplier company name.

contactName
string
required

Contact person; empty string when none is recorded.

country
string
required

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

status
string
required

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
required

External ID from your ERP system

email
string
required

Contact email; empty string when none is recorded.

articles
object[]
required

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

plots
object[]
required

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

complianceResults
object[]
required

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

isCompanySelf
boolean
required

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

supplierArticles
object[]
required

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

deletedAt
string | null
required

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

assignedToUserId
string | null
required

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

otpContactEmail
string | null
required

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

otpContactConfirmedAt
string | null
required

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

otpExemptUntil
string | null
required

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

plotsTruncated
boolean
required

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.