Read one retained intake’s public status, version, source hash and captured policy identity.
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
- Select the authorized workspace and obtain an intake id from retention or the intake list.
- Read status, version, attempts and allowlisted error before choosing any subsequent operation.
- For completed, use reviewId to read the review; for failed/running, follow the explicit analysis recovery guidance.
Identifiers
- Use the UUID assigned by intakes.create or returned by intakes.list. A review id is only the same when analysis completed for that intake.
Request
GET /api/intakes/{intakeId}
Action: app_topolo_contracts.intakes.get.
intakeId: required, UUID.
Response and effects
- Reads/decrypts one organization-and-workspace-scoped intake and removes the private object key and full policy body from its public projection.
- Uploaded means retained, not analyzed. Failed does not mean the original was lost. Completed does not mean human approval or a signed agreement.
- Missing in this workspace is not global absence; do not enumerate ids or switch identity to retrieve another organization’s document.
Examples
Example request and response
Request input:
{
"intakeId": "11111111-1111-4111-8111-111111111111"
}
Illustrated response:
{
"intake": {
"id": "11111111-1111-4111-8111-111111111111",
"title": "Documentation specimen",
"counterparty": "Example Beta",
"contractType": "mutual_nda",
"filename": "documentation-specimen.docx",
"sha256": "6ca130ea78e011afbd4384bbe0ee82ea155a8bb65b7cad0f17932c3b402c6174",
"status": "uploaded",
"version": 1,
"attempts": 0,
"createdAt": "2026-10-21T00:00:00.000Z",
"leaseUntil": null,
"reviewId": null,
"error": null,
"policyId": "default",
"policyVersion": 1,
"policyApprovedBy": "user_documentation_fixture",
"policyApprovedAt": "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: The already authorized workspace has no retained intake row with this intakeId.
Request input:
{
"intakeId": "11111111-1111-4111-8111-111111111111"
}
Source error-code excerpt (HTTP 404):
{
"error": "intake_not_found"
}
Discover a retained intake within the same authorized workspace.
Refusal or dependency failure
If: Workspace/protection checks succeeded, but the intake route receives a non-domain storage failure during its scoped read or persistence work. Its generic catch emits this code; prior write effects are not assumed absent.
Request input:
{
"intakeId": "11111111-1111-4111-8111-111111111111"
}
Source error-code excerpt (HTTP 503):
{
"error": "contract_intake_unavailable"
}
Storage or protection is unavailable; do not interpret the error as absence.
Completed intake read
Request input:
{
"intakeId": "11111111-1111-4111-8111-111111111111"
}
Illustrated response:
{
"intake": {
"id": "11111111-1111-4111-8111-111111111111",
"title": "Documentation specimen",
"counterparty": "Example Beta",
"contractType": "mutual_nda",
"filename": "documentation-specimen.docx",
"sha256": "6ca130ea78e011afbd4384bbe0ee82ea155a8bb65b7cad0f17932c3b402c6174",
"status": "completed",
"version": 3,
"attempts": 1,
"createdAt": "2026-10-21T00:00:00.000Z",
"leaseUntil": null,
"reviewId": "11111111-1111-4111-8111-111111111111",
"error": null,
"policyId": "default",
"policyVersion": 1,
"policyApprovedBy": "user_documentation_fixture",
"policyApprovedAt": "2026-10-21T00:00:00.000Z"
}
}
HTTP 200 illustration. Completed identifies the retained review; it asserts neither approval nor notification delivery.
Verify the result
- Compare id, sha256, policyVersion, status and version with the intended retained upload; preserve its error code without provider trace leakage.
Recovery
- 404
intake_not_found: Discover a retained intake within the same authorized workspace. - 400
invalid_intake_id: Use a syntactically valid returned UUID. - 503
contract_intake_unavailable: Storage or protection is unavailable; do not interpret the error as absence. - 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. Retry after dependency recovery with the same scope/id; invoke analysis only as a separately confirmed current-version write.
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.