read_approval_status #
On this page
Generated automatically from the published contract sources.
A script calls this action over HTTPS at POST https://turnzero.ai/api/v1/read_approval_status, with a bearer credential and the action's payload as the JSON body. It also accepts GET. An MCP connection lists this action as the tool read_approval_status.
OAuth access tokens and minted tokens, including the turnzero command's computer token, are bearer credentials. The action determines which kinds, scopes and grants it accepts (Sign-in, sessions, and tokens).
Build metadata: Registered in this build. Registration describes the default dispatcher in this build. It does not guarantee that a caller has the required credential or grant, that a tool is listed for that connection, or that the required service is configured.
Contract description #
Read a pending action, a destructive act waiting for or past its browser approval, with its state and its outcome. The state is requested, approved, executing, completed, failed, declined, or expired. This is how you learn what was decided. Pass brief: true to leave out the description and the outcome's sentences and receipts.
Access and action metadata #
{
"name": "read_approval_status",
"resource": "pending_action",
"tier": "observe",
"surface": "account",
"addresses": [
"tzcloud",
"tztools"
],
"admits": [
"device_sign_in"
],
"summary": "The requesting credential reads the record and its outcome — how the interface reports what the browser decided.",
"annotations": {
"readOnlyHint": true,
"destructiveHint": false,
"openWorldHint": false,
"idempotentHint": true
}
}
MCP catalog entry #
{
"name": "read_approval_status",
"title": "Read approval status",
"tier": "observe",
"scenario": "CHI-L0-10",
"summary": "Read a pending action, a destructive act waiting for or past its browser approval, with its state and its outcome. The state is `requested`, `approved`, `executing`, `completed`, `failed`, `declined`, or `expired`. This is how you learn what was decided. Pass `brief: true` to leave out the description and the outcome's sentences and receipts.",
"owners": [
"MAPI-05"
]
}
request #
| JSON pointer | Description and constraints |
|---|---|
| "" (root) | Type: object Required fields: ["id"] |
| / |
The pending action's id, returned by the destructive call that created it. Type: string |
| / |
Pass true to get the record without its description, and its outcome with only its short values: booleans, numbers, nulls, and texts of at most 100 characters. Leave it out or pass false for the whole record. Over the HTTP route a value other than true or false is refused invalid_request.Type: boolean |
response #
| JSON pointer | Description and constraints |
|---|---|
| "" (root) | Type: object Required fields: ["contract_version","pending_action"] |
| / |
Required value: 1 |
| / |
The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call’s record row. Quote it when you report the call. Type: string Pattern: ^[0-9a-f]{10}$ |
| / |
|
| / |
$ref: #/shapes/pending_action |
| / |
$ref: #/shapes/pending_action_brief |
Complete payload contract #
{
"request": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The pending action's id, returned by the destructive call that created it."
},
"brief": {
"type": "boolean",
"description": "Pass `true` to get the record without its `description`, and its `outcome` with only its short values: booleans, numbers, nulls, and texts of at most 100 characters. Leave it out or pass `false` for the whole record. Over the HTTP route a value other than true or false is refused `invalid_request`."
}
}
},
"response": {
"type": "object",
"required": [
"contract_version",
"pending_action"
],
"properties": {
"contract_version": {
"const": 1
},
"reference": {
"type": "string",
"pattern": "^[0-9a-f]{10}$",
"description": "The short reference the platform recorded your call under: ten lowercase hexadecimal characters, the value in the call’s record row. Quote it when you report the call."
},
"pending_action": {
"oneOf": [
{
"$ref": "#/shapes/pending_action"
},
{
"$ref": "#/shapes/pending_action_brief"
}
]
}
}
}
}
Shared contracts #
- Refusals: every refusal, by surface, with its cause and its remedy
- schemas/wire_error.schema.json
- schemas/wire_errors.json
- schemas/action_payloads.json (includes shared shapes)
- management_api_contract.md