List approval instance rows

Módulo Platform

GET/approval-instancesapprovalInstances.list

An approval in flight for one subject. Returns a cursor page of approval instance rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad inbox.notifications.read.
Alcances de OAuth: inbox.
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

approvalInstances.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 ApprovalInstance

approvalInstances.list: ApprovalInstance
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the approval instance.
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.
approval_policy_id	string (uuid)	Sí	Identifier of the approval policy.
requested_by	string (uuid)	Sí	Identifier of the requester.
approval_state	"In Review" \| "Approved" \| "Rejected" \| "Canceled"	Sí	Approval state.
document_type	"Purchase Order" \| "Change Order" \| "Expense" \| "Invoice Approval" \| "Payroll Run" \| "Requisition"	Sí	Spend document type.
document_id	string (uuid)	Sí	Identifier of the spend document submitted for approval.
subject_table	string	Sí	Table of the document.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
subject_reference	string \| null	Sí	The document's own number or name.Restricciones: length 1 to 300
project_id	string (uuid) \| null	Sí	Identifier of the project of the document.
amount_minor	integer (int64) \| null	Sí	Amount submitted; the approval covers the document while its amount stays at or below it. Never null: an unpriced document is not submitted. Integer minor units of the resource currency; null means unpriced, never zero.
currency_code	string	Sí	ISO 4217 currency of the amount.Restricciones: pattern ^[A-Z]{3}$
current_step	integer	Sí	Step the approval waits on; the last step once decided.Restricciones: range 1 to any
decided_at	string (date-time) \| null	Sí	When it was approved, rejected or canceled.

{
  "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",
      "approval_policy_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "requested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "approval_state": "In Review",
      "document_type": "Purchase Order",
      "document_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "subject_table": "purchase_orders",
      "subject_reference": "17",
      "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "amount_minor": 4000000,
      "currency_code": "USD",
      "current_step": 1,
      "decided_at": "2026-10-08T14:30:00Z"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

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

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

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

xos approval-instances list --all