Get Supplier

Returns a single supplier by ID, including all additional contacts.

Requires scope: suppliers:read

Authentication

API_KEYstring
API Key authentication via header

Path parameters

idUUIDRequired
Supplier ID.

Response

This endpoint returns an object.
idUUID
Unique identifier for the supplier.
businessNamestring
Display name of the supplier business.
additionalContactslist of objects
Additional contacts at this supplier. Empty list if none configured.
businessEmailstring
Primary email address for the supplier business.
contactNamestring
Name of the primary contact person at this supplier.
phoneNumberstring
Primary phone number for the supplier.
addressstring
Street address.
citystring
City.
statestring

State or province code (e.g. TX).

zipCodestring

Postal/ZIP code.

websitestring
Supplier website URL.
notestring
Internal notes about this supplier.
createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error