Get a vendor scorecard
Vendors module
GET/vendor-scorecards/{id}vendorScorecards.get
A vendor scorecard for an engagement or project. Returns one vendor scorecard with its `ETag`. A vendor scorecard the caller may not see returns 404.
- Requires the capability vendors.vendor.read.
- OAuth scopes: vendors.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the vendor scorecard. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: VendorScorecard
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the vendor scorecard. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| vendor_id | string (uuid) | Yes | Identifier of the vendor. |
| project_id | string (uuid) | null | Yes | Identifier of the project. |
| note | string | null | Yes | Internal notes.Constraints: length 1 to 20000 |
| period_end | string (date) | Yes | Last day of the period scored. |
| quality_score | integer | null | Yes | Quality, 1 to 5; null when not scored.Constraints: range 1 to any |
| delivery_score | integer | null | Yes | On-time delivery, 1 to 5; null when not scored.Constraints: range 1 to any |
| safety_score | integer | null | Yes | Safety, 1 to 5; null when not scored.Constraints: range 1 to any |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"note": "On time; one damaged deck.",
"period_end": "2026-10-08",
"quality_score": 4,
"delivery_score": 4,
"safety_score": 4
}Code samples
curl -X GET "$XOS_BASE_URL/vendor-scorecards/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.vendorScorecards.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.vendor_scorecards.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos vendor-scorecards get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f