Get a vendor
Vendors module
GET/vendors/{id}vendors.get
An organization in the vendor relationship with this org, with its counterparty type. Returns one vendor with its `ETag`. A vendor 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. |
| 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: Vendor
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the vendor. |
| 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. |
| counterparty_type | CounterpartyType | null | Yes | |
| vendor_state | "Prospect" | "Onboarded" | "Active" | "Blocked" | "Canceled" | Yes | Vendor state. |
| counterparty_id | string (uuid) | Yes | Identifier of the counterparty the vendor facet belongs to. |
| payment_terms_days | integer | null | Yes | Days after invoice the vendor is paid.Constraints: range 0 to any |
| default_currency_code | string | null | Yes | ISO 4217 currency the vendor bills in by default.Constraints: pattern ^[A-Z]{3}$ |
| default_account_code | GlAccountCode | null | Yes | |
| default_cost_center_id | string (uuid) | null | Yes | Identifier of the cost center (dimension 1) the vendor's costs post to unless a line says otherwise. |
| bank_account_last4 | string | null | Yes | Last four digits of the vendor's most recent bank account; null when none is on file.Constraints: pattern ^[0-9]{4}$; length 1 to 4 |
{
"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",
"counterparty_type": "AV Integrator",
"vendor_state": "Prospect",
"counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"payment_terms_days": 30,
"default_currency_code": "USD",
"default_account_code": "5400",
"default_cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"bank_account_last4": "4321"
}Code samples
curl -X GET "$XOS_BASE_URL/vendors/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.vendors.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.vendors.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos vendors get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f