---
title: "read_approval_status"
description: "Generated reference for the management action read_approval_status: its description, access metadata, payload contract, and registration status."
slug: /reference/actions/read-approval-status
order: 54
visibility: public
redirects_from: ["/reference/actions/read-pending-action"]
---

# read\_approval\_status

Generated automatically from the [published contract sources](/cloud/reference/about/#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](/cloud/concepts/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

```json
{
  "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

```json
{
  "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<br>Required fields: \["id"\] |
| /<wbr>properties/<wbr>id | The pending action's id, returned by the destructive call that created it\.<br><br>Type: string |
| /<wbr>properties/<wbr>brief | 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`\.<br><br>Type: boolean |

## response

| JSON pointer | Description and constraints |
|---|---|
| "" \(root\) | Type: object<br>Required fields: \["contract\_version","pending\_action"\] |
| /<wbr>properties/<wbr>contract\_version | Required value: 1 |
| /<wbr>properties/<wbr>reference | 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\.<br><br>Type: string<br>Pattern: ^\[0\-9a\-f\]\{10\}$ |
| /<wbr>properties/<wbr>pending\_action |  |
| /<wbr>properties/<wbr>pending\_action/<wbr>oneOf/<wbr>0 | $ref: \#/shapes/pending\_action |
| /<wbr>properties/<wbr>pending\_action/<wbr>oneOf/<wbr>1 | $ref: \#/shapes/pending\_action\_brief |

## Complete payload contract

```json
{
  "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](/cloud/reference/refusals/): every refusal, by surface, with its cause and its remedy
- [schemas/wire\_error\.schema\.json](/cloud/reference/sources/schemas/wire-error-schema/)
- [schemas/wire\_errors\.json](/cloud/reference/sources/schemas/wire-errors/)
- [schemas/action\_payloads\.json](/cloud/reference/sources/schemas/action-payloads/) (includes shared shapes)
- [management\_api\_contract\.md](/cloud/reference/sources/management-api-contract/)
