List a table's rows

Send the key as Authorization: Bearer <key>. Two kinds of key exist.

Organization keys are issued in the portal (Settings, then API keys), each bound to one environment, shaped nx_<environment slug>_<64 hex>. They carry no capabilities and pass every capability check, with one exception: routes under /records, /actions, /operations, /api/v1/engines/{id}/opportunities, /api/v1/graph and /api/v1/catalog/documents accept an organization key only when its environment is live, and refuse any other with 403 scoped_key_required. Revocation takes effect within 60 seconds.

Scoped keys are issued by Nexio on request, shaped nxsk_v1_<24 hex key id>_<43 character secret>. Each is bound to one org, one environment, a set of engines and a set of capabilities. A malformed, unknown or revoked nxsk_ key fails with 401 and is never retried as an organization key. Revocation takes effect on the next request. A scoped key without a route's capability gets 403 insufficient_capability; a scoped key not bound to the engine gets 403 engine_binding_forbidden.

Key-grantable capabilities: engines:read, runs:write, runs:read, runs:defensibility:read, runs:test, catalog:read, catalog:documents:read, webhooks:manage, conversations:use, conversations:export, records:read, records:opportunities:run, actions:write, actions:read, graph:read, records:analyze.

Routes that accept organization keys only (every scoped key gets 403 insufficient_capability): environment management, engine create, update, configuration and publish, and conversation instance authoring. Each operation description names the capability a scoped key needs.

The person the request is for, as your identity provider's stable user id. Unset keeps the org-wide posture the key alone grants. The retired X-Nexio-* identity headers are refused on this route with 400 INVALID_ARGUMENT, reason LEGACY_HEADER.

The acting person's verified sign-in email, lowercased. Ignored without Nexio-Act-As.

The signed assertion over the identity headers (v1..).

A caller-chosen request id, echoed in the Nexio-Request-Id response header.

The caller's remaining budget for this request, in whole milliseconds (1 to 10 digits, greater than zero), relative to receipt. The engine stops work at the shorter of this and the route's own budget, and answers 504 request_timeout when it expires. A value above the route budget is capped to it; a malformed value is ignored.

The connection: one of the organization's connection ids, or sandbox for the sandbox seat's view of it. Any other id answers 404 NOT_VISIBLE_OR_ABSENT.

The table: the system of record's own object name as the registry spells it, lower case. An AMS360 table is its name without the AFW_ prefix (company, custcontact, 146schedequip). An unregistered table answers 404 NOT_VISIBLE_OR_ABSENT.

The policy id, as an instance key. Required on a table whose owner is policy; refused on any other.

The account id, as an instance key. Required on a table whose owner is account; refused on any other.

The claim id, as an instance key. Required on a table whose owner is claim; refused on any other.

Rows whose ATTACHID equals this value, on a table whose match column is ATTACHID (journalmemo, payee).

Rows whose ATTRCODE equals this value, on a table whose match column is ATTRCODE (prstring).

Rows whose BANKCODE equals this value, on a table whose match column is BANKCODE (bankaccount, bankrecstatement, cashdisbursment and 3 more).

Rows whose BROKERCODE equals this value, on a table whose match column is BROKERCODE (broker).

Rows whose BRSID equals this value, on a table whose match column is BRSID (bankreccleared).

Rows whose CHARGECODE equals this value, on a table whose match column is CHARGECODE (commissionie).

Rows whose CHECKLISTNAME equals this value, on a table whose match column is CHECKLISTNAME (agencychecklist).

Rows whose COCODE equals this value, on a table whose match column is COCODE (agent, aptinsurer, benefitcarrier and 13 more).

Rows whose CPNPLISTID equals this value, on a table whose match column is CPNPLISTID (targetlistbpol, targetlistcustomer, targetlistlob and 3 more).

Rows whose CRHID equals this value, on a table whose match column is CRHID (cashreceiptdeposit).

Rows whose CUSTID equals this value, on a table whose match column is CUSTID (generalledgertransaction, onaccountinvoice, pendingcheckglt).

Rows whose DBDHID equals this value, on a table whose match column is DBDHID (directbilldownloaddetail).

Rows whose DBEHID equals this value, on a table whose match column is DBEHID (directbillentrycommission, directbillentrycommissionbuabreakout, directbillentrydetail).

Rows whose DBSHID equals this value, on a table whose match column is DBSHID (directbillstmtdetail).

Rows whose ELFFORMTYPEID equals this value, on a table whose match column is ELFFORMTYPEID (elfformversion).

Rows whose EMPCODE equals this value, on a table whose match column is EMPCODE (benefitemployee, emplicense, employee and 1 more).

Rows whose ENTITYID equals this value, on a table whose match column is ENTITYID (refgroup).

Rows whose GJID equals this value, on a table whose match column is GJID (generaljournalrelation).

Rows whose GLDIVCODE equals this value, on a table whose match column is GLDIVCODE (directbilldownloadheader, directbillentryheader, directbillstmtheader and 3 more).

Rows whose INVID equals this value, on a table whose match column is INVID (directbillstmtautorec, invoicebatch, invoicebillingevent and 7 more).

Rows whose ISTID equals this value, on a table whose match column is ISTID (invoicesplitallocation).

Rows whose LLDID equals this value, on a table whose match column is LLDID (leadlistdefdetail).

Rows whose PLANID equals this value, on a table whose match column is PLANID (equineage, equinebreed, equinecovuse and 8 more).

Rows whose POLID equals this value, on a table whose match column is POLID (invoicesplittemplate).

Rows whose PSHID equals this value, on a table whose match column is PSHID (paystatementdetail).

Rows whose QUEID equals this value, on a table whose match column is QUEID (queidquestions).

Rows whose RELATIONSHIPTYPEID equals this value, on a table whose match column is RELATIONSHIPTYPEID (relationship).

Rows whose RLHID equals this value, on a table whose match column is RLHID (renewallistcc).

Rows whose TTSHID equals this value, on a table whose match column is TTSHID (trusttransferstatementdetail).

Rows whose VENDORCODE equals this value, on a table whose match column is VENDORCODE (vendor, vendorinvoice, vendorinvoicetemplate).

Rows whose VINVID equals this value, on a table whose match column is VINVID (vendorinvoicetransaction, vendorpayment).

Not a filter: refused with 400 INVALID_ARGUMENT, reason FILTER_NOT_TAKEN. A table's match filter is named after its column (cocode, brokercode), as the listing shows it under filter.

Page size. Defaults to 25; a value above 200 is coerced to 200 with a LIMIT_COERCED warning.

The opaque page.next of the previous page. The table and its filters are fixed inside it.