List Approvals

GET /approvals

List Approvals

cURL

curl --request GET \
  --url https://api.example.com/approvals \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/approvals"

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', 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",
  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"

	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")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

200

{
  "data": [
    {
      "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
    }
  ],
  "meta": {
    "page": 0,
    "limit": 20,
    "total_pages": 0,
    "total_count": 0,
    "search_time_ms": 0
  }
}

{
  "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.

Query Parameters

status · enum<string> | null

Available options: pending, approved, rejected, expired, cancelled

source_type · string | null

approval_type · enum<string> | null

Available options: required, audit

pause_type · string | null

agent_id · string | null

team_id · string | null

workflow_id · string | null

user_id · string | null

schedule_id · string | null

run_id · string | null

limit · integer · default: 100

Required range: 1 <= x <= 1000

page · integer · default: 1

Required range: x >= 1

Response

200

application/json

Successful Response

data · ApprovalResponse · object[] · required

List of items for the current page

Show child attributes

meta · PaginationInfo · object · required

Pagination metadata

Show child attributes