List approvals visible to the caller

GET

/v1/approvals

curl --request GET \
  --url 'https://example.com/v1/approvals?limit=25&status=pending&requiredRole=standard' \
  --header 'Authorization: Bearer <token>'

• Same-origin — path relative to the deployment root.

Requires the token to carry a reviewerRole. Role-scoped: reviewers only see approvals whose requiredRole rank ≤ their rank (standard < senior < admin).

Authorizations

• bearerAuth

Parameters

Query Parameters

limit

integer

default: 25 >= 1 <= 100

1..100. Default 25.

cursor

string

Opaque cursor from a prior response. Absent → first page.

status

string

Allowed values: pending assigned in_review approved rejected escalated expired withdrawn

Filter by approval status.

requiredRole

Reviewer role class. Hierarchy: standard < senior < admin.

string

Allowed values: standard senior admin

Filter by required reviewer role. Caller must have a rank ≥ the value — else 403.

createdAfter

string format: date-time

ISO 8601 timestamp; return approvals created strictly after this.

Responses

200

Page of approvals.

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string format: uuid

tenantId

required

string format: uuid

projectId

string format: uuid

subjectKind

required

string

subjectRef

required

object

key

additional properties

any

requiredRole

required

Reviewer role class. Hierarchy: standard < senior < admin.

string

Allowed values: standard senior admin

status

required

string

Allowed values: pending assigned in_review approved rejected escalated expired withdrawn

assignedTo

string format: uuid

batchKey

string

title

string

description

string

context

object

key

additional properties

any

provenanceRef

object

runId

required

string format: uuid

provenanceId

string format: uuid

waitTokenId

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

decidedAt

string format: date-time

expiresAt

string format: date-time

nextCursor

Opaque cursor for the next page. ISO timestamp of the tail row internally; treat as opaque on the client.

string

hasMore

required

boolean

Example

{
  "data": [
    {
      "requiredRole": "standard",
      "status": "pending"
    }
  ]
}

400

Malformed query parameter.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

401

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

403

Token lacks a reviewer role or asked for a tier above the caller.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}