Records API

Full CRUD on process records — list, get, update, approve, reject, request info, and download attachments.

Overview

The Records API provides full CRUD access to process records. Use it to query records, update field values, perform approval actions, and retrieve attachments programmatically.

List Records

  • GET /v1/records — list records across all processes.
  • GET /v1/processes/{process_id}/records — list records for a specific process.

Approval Actions

  • POST /v1/records/{record_id}/approve — approve the current stage.
  • POST /v1/records/{record_id}/reject — reject the current stage. Requires a reason field in the body.
  • POST /v1/records/{record_id}/request-info — request more information from the submitter.

Attachments

  • GET /v1/records/{record_id}/attachments/{attachment_id}/download — download a specific attachment. Returns a signed URL valid for 60 seconds.
Processes API Users API
Back to API Reference