Skip to content

List spend authority limit rows

Settings module

GET/spend-authorityspendAuthorityLimits.list

A spend limit by role or person and document type, enforced in the approval RPCs. Returns a cursor page of spend authority limit rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requires the capability org.settings.read.
  • OAuth scopes: org.
  • Cursor-paginated: limit, cursor, fields, sort and filter apply.
  • Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

spendAuthorityLimits.list: Path and query parameters
FieldTypeRequiredDescription
limitLimitNoPage size. Default 50, maximum 200.Constraints: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort 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_]*)*$
filterFilterNoFilter 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 SpendAuthority

spendAuthorityLimits.list: SpendAuthority
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the spend authority.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
role_idstring (uuid) | nullYesIdentifier of the role.
document_type"Purchase Order" | "Change Order" | "Expense" | "Invoice Approval" | "Contract" | "Payroll Run" | "Requisition"YesDocument type the limit applies to.
limit_minorinteger (int64) | nullYesSingle-approver limit in the org currency. Integer minor units of the resource currency; null means unpriced, never zero.
dual_approval_above_minorinteger (int64) | nullYesAmount above which two approvers are required. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringYesISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
membership_idstring (uuid) | nullYesIdentifier of the membership of the one person the limit applies to; null when it applies to a role.
account_codestring | nullYesGL account the limit is scoped to; null for every account.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
cost_center_idstring (uuid) | nullYesIdentifier of the cost center the limit is scoped to; null for every cost center.
valid_fromstring (date-time)YesWhen the limit starts.
valid_tostring (date-time) | nullYesWhen the limit ends; null while open-ended.
{
  "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",
      "role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "document_type": "Purchase Order",
      "limit_minor": 2500000,
      "dual_approval_above_minor": 10000000,
      "currency_code": "USD",
      "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "account_code": "5100",
      "cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "valid_from": "2026-10-08T14:30:00Z",
      "valid_to": "2026-10-08T14:30:00Z"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/spend-authority" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.spendAuthorityLimits.listAll()) {
  console.log(row);
}
for row in xos.spend_authority_limits.list_all():
    print(row)
xos spend-authority-limits list --all