Topolo Docs Topolo Platform
Open workspace

List approved workspace playbooks

List the latest approved, non-retired playbooks available for new uploads in the selected workspace.

List the latest approved, non-retired playbooks available for new uploads in the selected workspace.

Access

Requires app_topolo_contracts.workspace:read and the intended authenticated organization and workspace. Select the permitted workspace through the supported resource-binding flow; do not add a workspace id to strict action input.

Steps

  1. Select the authorized workspace and read the approved policy library.
  2. Choose the intended contract type and policy identity using its name, purpose/applicability where returned, and exact version.
  3. Pin policyId and policyVersion together for upload when a particular approved revision is required.

Identifiers

  • Read policyId, contractType and version from the returned approved policy; default is a specific policy identity, not an organization-wide template approval.

Request

GET /api/policies

Action: app_topolo_contracts.policies.list.

Use the empty object {}. Resource/workspace selection belongs outside the action input; do not add undeclared fields.

Response and effects

  • Reads/decrypts the most recent approved revision per contract type and policy id, excluding identities marked retired.
  • Drafts and retired playbooks are not upload choices in this list. Historical approvals and captured review snapshots are not erased by retirement.
  • The built-in NDA/order-form and custom playbooks are configurable review aids; availability is not legal suitability or complete document support.

Examples

Example request and response

Request input:

{}

Illustrated response:

{
  "policies": [
    {
      "policyId": "default",
      "contractType": "mutual_nda",
      "version": 1,
      "confidentialityYears": 3,
      "governingLaw": "England and Wales",
      "approvedBy": "user_documentation_fixture",
      "approvedAt": "2026-10-21T00:00:00.000Z"
    }
  ]
}

HTTP 200 illustration. Hypothetical authorized operation only; inspect the action-specific fields and boundaries below.

Refusal or dependency failure

If: Authentication succeeded, but the verified principal has no organization id. The empty action input does not itself cause this; the source refuses before workspace resolution.

Request input:

{}

Source error-code excerpt (HTTP 403):

{
  "error": "organization_context_required"
}

Choose the authorized organization and workspace.

Refusal or dependency failure

If: The workspace grant and storage binding are present, but protection readiness or protected-database initialization fails before the action handler runs.

Request input:

{}

Source error-code excerpt (HTTP 503):

{
  "error": "contracts_protection_unavailable"
}

Restore encrypted-storage readiness; do not fall back to unprotected policy reads.

No approved upload choices

Request input:

{}

Illustrated response:

{
  "policies": []
}

HTTP 200 illustration. An empty approved list does not imply that drafts or historical policy revisions do not exist.

Verify the result

  • Use policy.get for the exact selected type/id/version before retention; compare the captured policy identity returned by the intake.

Recovery

  • 403 organization_context_required: Choose the authorized organization and workspace.
  • 503 contracts_protection_unavailable: Restore encrypted-storage readiness; do not fall back to unprotected policy reads.
  • 401 authentication_required: Outer authentication/authorization contract: Authenticate again or provide a valid Topolo API key. Reconcile uncertain earlier write effects before any retry.
  • 403 permission_denied: Outer authentication/authorization contract: Grant the credential permission workspace:read and the required resource binding. Reconcile uncertain earlier write effects before any retry.
  • 429 rate_limited: Outer authentication/authorization contract: Wait for Retry-After when present, then retry without parallel duplicate calls. Reconcile uncertain earlier write effects before any retry.

Read-only. If selection disappeared, investigate retirement/current permissions with the workspace policy owner rather than silently selecting another policy.

Source and example limits — 21 October 2026: based on reviewed Contracts source 4bfd49a; current serving association is unverified. All requests, responses, approvals and document specimens shown are fictional and unrun. Offline schema/ZIP/XML checks do not prove application acceptance, legal completeness, provider outcomes or human approval.