Get a prequalification
Vendors module
GET/prequalifications/{id}prequalifications.get
A vendor prequalification. Returns one prequalification with its `ETag`. A prequalification 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 prequalification. |
| 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: Prequalification
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the prequalification. |
| 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. |
| valid_to | string (date) | null | Yes | Expiry. |
| scope_note | string | Yes | What the vendor is prequalified for.Constraints: length 1 to 20000 |
| decision | "Approved" | "Rejected" | null | Yes | Decision; null while pending. |
| decided_by | string (uuid) | null | Yes | Identifier of the person who decided. |
| decided_at | string (date-time) | null | Yes | When it was decided. |
{
"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",
"valid_to": "2026-10-08",
"scope_note": "Rigging over 2,000 kg.",
"decision": "Approved",
"decided_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"decided_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/prequalifications/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.prequalifications.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.prequalifications.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos prequalifications get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f