Get a vendor class

Módulo Vendors

GET/vendor-classes/{id}vendorClasses.get

An org vendor class, seeded from the Standard Library. Returns one vendor class with its `ETag`. A vendor class the caller may not see returns 404.

Requiere la capacidad vendors.vendor.read.
Alcances de OAuth: vendors.
Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

vendorClasses.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the vendor class.
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Respuesta 200: VendorClass

vendorClasses.get: VendorClass
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the vendor class.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Sí	Vendor class name.Restricciones: length 1 to 300
std_vendor_class_id	string \| null	Sí	Standard Library vendor class adopted.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
description	string \| null	Sí	What the class covers.Restricciones: length 1 to 20000

{
  "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",
  "name": "Staging",
  "std_vendor_class_id": "VC-001",
  "description": "Staging rental houses."
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/vendor-classes/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.vendorClasses.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.vendor_classes.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos vendor-classes get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f