Playground

Playground

Scorecard

/api/v1/vendor/scorecards

A periodic performance scorecard for 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 scorecard rates (e.g. 'sup_01HXABC').
period*stringReview period this scorecard covers (e.g. '2026-Q2').
overall_scorenumberComposite score across all dimensions (e.g. 85).
quality_scorenumberQuality dimension score (e.g. 90).
delivery_scorenumberOn-time delivery dimension score (e.g. 80).
responsivenessnumberResponsiveness dimension score (e.g. 85).
notesstringFree-form reviewer notes.
reviewer_iduuidId of the user who authored this scorecard (e.g. 'usr_01HXABC').
statusenumdraft | submitted | approvedLifecycle status. Defaults to 'draft'.

API

client.vendor.scorecards.*
Loading manifest…