Skip to content
SarvexDocs
Esc
↑↓navigate↵open⌘Jpreview

List captured manual steps

GET/operator/manual-steps
Authorization
AuthorizationBearer token (JWT) · headerrequired

JWT issued by the external IdP via the OAuth 2.0 authorization-code flow (Kinde in production; a simulator in test). The client obtains it and sends it as a Bearer token on every authenticated call. Sarvex's services verify it — issuer, audience, signature (IdP JWKS), expiry — and read identity and tenant from its claims. Sarvex does not issue or revoke these tokens. merchant_id/store_id are read from the verified claims (and the merchant→store mapping), never from the URL. The operator scope is required for /operator/*. Operators acting on a specific merchant pass the X-Operate-As header, which is recorded in the audit log.

Scopes:operator
Query parameters
cursorstring

Opaque pagination cursor from the previous page's page.cursor.

limitinteger

Maximum items per page.

min 1 · max 100 · default: 25
dispositionmanual_step_disposition
default: "unclassified"
Allowed:unclassifiedautomatetemplatiseaccept_manual
Responses
200

Manual steps.

datamanual_step[]required
Show properties
Array of manual_step
manual_step_idstring
target_merchant_idstring
descriptionstringrequired

What was done by hand.

dispositionmanual_step_disposition
default: "unclassified"
Allowed:unclassifiedautomatetemplatiseaccept_manual
created_atstring<date-time>
pagepagerequired
Show properties
cursorstring | nullrequired
has_morebooleanrequired
403

Authenticated but not permitted (e.g. non-operator on an operator route).

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
detailsobject | null
Try it
Server
Authorization
Parameters
Request
curl -X GET "https://api.sarvex.example.com/v1/operator/manual-steps" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "data": [
    {
      "description": "string",
      "disposition": "unclassified"
    }
  ],
  "page": {
    "cursor": "string",
    "has_more": true
  }
}