Skip to content

Approval History — Proposed Guide

Planned API — Reference Only

Approval History: Approval history would show assignment changes, delegation and reviewer decisions in sequence. It explains how a review outcome was reached.

Overview

Approval history would show assignment changes, delegation and reviewer decisions in sequence. It explains how a review outcome was reached.

Key concepts

Store actor, action, timestamp and the reviewed resource version. Separate administrative rerouting from an approval decision.

Implementation considerations

Preserve the original decision when a correction creates a new review. Access to reviewer comments needs its own authorization policy.

Proposed API behavior

GET /v1/approvals/{approval_id}/history is an illustrative design for this topic. Path and field names may change before implementation. Access would require an authorized organization context and operation-specific permission; no public API or authorization grant is available here.

Proposed path parameters
NameTypeDescription
approval_idrequiredstringStable fictional approval reference; not a secret and not evidence that a resource exists.

No additional request fields are illustrated; this is not a finalized contract.

Static example requests

Proposed, non-executing request examples
# Proposed request text only; this reserved host is not a live API.
curl -X GET 'https://api.remizen.example/v1/approvals/apr_example_123/history' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Fictional response example

200 (proposed example)Static response fixture

Fictional documentation data only. No request was sent, record created, review performed, payment initiated or provider connection activated.

JSON
{
  "data": {
    "approval_id": "apr_example_123",
    "event_id": "event_example_123",
    "actor_id": "usr_example_123",
    "occurred_at": "2026-01-15T12:00:00Z",
    "id": "approvals_example_123",
    "organization_id": "org_example_123"
  },
  "meta": {
    "request_id": "req_example_123",
    "reference_only": true
  }
}

Illustrative error case

Review this failure case in context: Preserve the original decision when a correction creates a new review. Access to reviewer comments needs its own authorization policy.

422 (illustrative; final error contracts are undecided)Proposed error fixture

Synthetic diagnostic example. Human-readable messages must not be used as stable programmatic contracts.

JSON
{
  "error": {
    "code": "validation_error",
    "message": "The proposed approval history operation requires review of its input or authorization.",
    "request_id": "req_example_123"
  }
}

Proposed data types

Illustrative field dictionary
NameTypeDescription
approval_idstringStable fictional approval reference; not a secret and not evidence that a resource exists.
event_idstringStable fictional event reference; not a secret and not evidence that a resource exists.
actor_idstringStable fictional actor reference; not a secret and not evidence that a resource exists.
occurred_atstring (date-time)Synthetic UTC timestamp. Business occurrence time may differ from delivery or processing time.