List pending approvals

Long-polls for manual-approval requests awaiting a decision in the current project. Returns immediately when any are pending, otherwise holds the connection open (up to timeoutSeconds) until one arrives or the poll times out.

Authenticate with a project API key, or an organization key plus an X-Project-Id header. Submit each decision to POST /approvals/{id}/decision.

GET /approvals/pending

List pending approvals

cURL

curl --request GET \
  --url https://api.onecli.sh/v1/approvals/pending \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.onecli.sh/v1/approvals/pending"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.onecli.sh/v1/approvals/pending', 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.onecli.sh/v1/approvals/pending",
  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.onecli.sh/v1/approvals/pending"

	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.onecli.sh/v1/approvals/pending")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/approvals/pending")

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

{
  "requests": [
    {
      "id": "<string>",
      "projectId": "<string>",
      "method": "<string>",
      "url": "<string>",
      "host": "<string>",
      "path": "<string>",
      "headers": {},
      "bodyPreview": "<string>",
      "summary": {},
      "agent": {
        "id": "<string>",
        "name": "<string>",
        "externalId": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  ],
  "timeoutSeconds": 123
}

{
  "error": "<string>"
}

Authorizations

Authorization · string · header · required

API key obtained from the dashboard or GET /user/api-key

Query Parameters

exclude · string

Comma-separated approval IDs to skip (already being handled) so the poll can hold open for genuinely new requests.

Response

200

application/json

Pending approval requests in the project

requests · object[]

Show child attributes

timeoutSeconds · integer

How long the server holds the long-poll open, in seconds.