Playground

Playground

Contact

/api/v1/vendor/contacts

A point of contact at a vendor.

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
vendor_id*stringId of the vendor this contact belongs to (e.g. 'sup_01HXABC').
name*stringContact full name (e.g. 'John Doe').
emailemailContact email (e.g. 'john@vendor.com').
phonestringContact phone number (e.g. '+1-555-0123').
rolestringContact role or title (e.g. 'Account Manager').
departmentstringDepartment the contact works in (e.g. 'Sales').
is_primarybooleanWhether this is the primary contact for the vendor. Defaults to false.
statusenumactive | inactiveContact status. Defaults to 'active'.

API

client.vendor.contacts.*
Loading manifest…