List vendor rows
Vendors module
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.
- Requires the capability vendors.vendor.read.
- OAuth scopes: vendors.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| 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_]*)*$ |
| 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).Constraints: 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. |
Response 200: a page of 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 |
{
"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
}Code samples
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