List vendor rows

Módulo Vendors

GET/vendorsvendors.list

An organization in the vendor relationship with this org, with its counterparty type. Returns a cursor page of vendor rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad vendors.vendor.read.
Alcances de OAuth: vendors.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

vendors.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de Vendor

vendors.list: Vendor
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the vendor.
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.
counterparty_type	CounterpartyType \| null	Sí
vendor_state	"Prospect" \| "Onboarded" \| "Active" \| "Blocked" \| "Canceled"	Sí	Vendor state.
counterparty_id	string (uuid)	Sí	Identifier of the counterparty the vendor facet belongs to.
payment_terms_days	integer \| null	Sí	Days after invoice the vendor is paid.Restricciones: range 0 to any
default_currency_code	string \| null	Sí	ISO 4217 currency the vendor bills in by default.Restricciones: pattern ^[A-Z]{3}$
default_account_code	GlAccountCode \| null	Sí
default_cost_center_id	string (uuid) \| null	Sí	Identifier of the cost center (dimension 1) the vendor's costs post to unless a line says otherwise.
bank_account_last4	string \| null	Sí	Last four digits of the vendor's most recent bank account; null when none is on file.Restricciones: pattern ^[0-9]{4}$; length 1 to 4

{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/vendors" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.vendors.listAll()) {
  console.log(row);
}

for row in xos.vendors.list_all():
    print(row)

xos vendors list --all