Skip to main content
GET
/
approvals
/
{approval_id}
Get Approval
curl --request GET \
  --url https://api.example.com/approvals/{approval_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/approvals/{approval_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/approvals/{approval_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/approvals/{approval_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/approvals/{approval_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/approvals/{approval_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/approvals/{approval_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "run_id": "<string>",
  "session_id": "<string>",
  "status": "<string>",
  "source_type": "<string>",
  "approval_type": "<string>",
  "pause_type": "<string>",
  "tool_name": "<string>",
  "tool_args": {},
  "expires_at": 123,
  "agent_id": "<string>",
  "team_id": "<string>",
  "workflow_id": "<string>",
  "user_id": "<string>",
  "schedule_id": "<string>",
  "schedule_run_id": "<string>",
  "source_name": "<string>",
  "requirements": [
    {}
  ],
  "context": {},
  "resolution_data": {},
  "resolved_by": "<string>",
  "resolved_at": 123,
  "created_at": 123,
  "updated_at": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

approval_id
string
required

Response

Successful Response

Response model for a single approval.

id
string
required
run_id
string
required
session_id
string
required
status
string
required
source_type
string
required
approval_type
string | null
pause_type
string | null
tool_name
string | null
tool_args
Tool Args · object | null
expires_at
integer | null
agent_id
string | null
team_id
string | null
workflow_id
string | null
user_id
string | null
schedule_id
string | null
schedule_run_id
string | null
source_name
string | null
requirements
Requirements · object[] | null
context
Context · object | null
resolution_data
Resolution Data · object | null
resolved_by
string | null
resolved_at
integer | null
created_at
integer | null
updated_at
integer | null
run_status
enum<string> | null

State of the main run response

Available options:
PENDING,
RUNNING,
COMPLETED,
PAUSED,
CANCELLED,
ERROR