Skip to navigation

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.
businessEmailstringOptional
Primary email address for the supplier business.
contactNamestringOptional
Name of the primary contact person at this supplier.
phoneNumberstringOptional
Primary phone number for the supplier.
addressstringOptional
Street address.
citystringOptional
City.
statestringOptional

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

zipCodestringOptional

Postal/ZIP code.

websitestringOptional
Supplier website URL.
notestringOptional
Internal notes about this supplier.
createdAtdatetimeOptional
ISO 8601 timestamp when the record was created.
updatedAtdatetimeOptional
ISO 8601 timestamp when the record was last updated.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Rate Limit Error