List tax form rows

Módulo Gateway

GET/tax-formstaxForms.list

A tax form. Restricted and encrypted; only the last four digits of the identifier are ever displayed. Returns a cursor page of tax form rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad data.restricted.read.tax.
Alcances de OAuth: data.
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

taxForms.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 TaxForm

taxForms.list: TaxForm
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the tax form.
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.
tin_last4	string	Sí	Last four digits of the tax identifier.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
foreign_performer_withholding	boolean	Sí	Foreign performer withholding flag.
person_id	string (uuid) \| null	Sí	Identifier of the payee person, set from the session.
organization_id	string (uuid) \| null	Sí	Identifier of the payee external account.
form_kind	"W-9" \| "W-8BEN" \| "W-8BEN-E"	Sí	Tax form.
signed_at	string (date-time)	Sí	When the payee signed the form, set by the database.

{
  "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",
      "tin_last4": "6789",
      "foreign_performer_withholding": false,
      "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "form_kind": "W-9",
      "signed_at": "2026-10-08T14:30:00Z"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos tax-forms list --all