ts.apr.list

List approvals for an entity.

List approvals for an entity.

Requires authentication

Description

Lists approval records for a specific entity, newest first. Supports filtering by approver, verdict, and role.

Parameters

NameTypeRequiredDefaultDescription
entity_typestringYesEntity type: task, demand, endeavour, artifact
entity_idstringYesID of the entity
approver_idstringFilter by approver resource ID
verdictstringFilter by verdict: approved, rejected, needs_work
rolestringFilter by role
limitinteger50Max results (default: 50)
offsetinteger0Pagination offset

Response

Returns a paginated list of approvals.

{
  "approvals": [
    {
      "approver_id": "res_x1y2z3a4b5c6",
      "id": "apr_a1b2c3d4e5f6",
      "verdict": "approved"
    }
  ],
  "limit": 50,
  "offset": 0,
  "total": 1
}

Errors

CodeDescription
not_authenticatedNo active login for this session
invalid_inputentity_type or entity_id missing

Examples

List task approvals

Get all approvals for a task.

Request:

{
  "entity_id": "tsk_a1b2c3d4e5f6",
  "entity_type": "task"
}

Response:

{
  "approvals": [
    {
      "id": "apr_a1b2c3d4e5f6",
      "verdict": "approved"
    }
  ],
  "limit": 50,
  "offset": 0,
  "total": 1
}