Get Approval Request

GET

approval-requests

{approval_request_id}

curl --request GET \
  --url https://public.api.serval.com/v2/approval-requests/{approval_request_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public.api.serval.com/v2/approval-requests/{approval_request_id}"

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

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

print(response.text)

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

fetch('https://public.api.serval.com/v2/approval-requests/{approval_request_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://public.api.serval.com/v2/approval-requests/{approval_request_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://public.api.serval.com/v2/approval-requests/{approval_request_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))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/approval-requests/{approval_request_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

{
  "data": {
    "accessRequestTimeAllocationId": "<string>",
    "id": "<string>",
    "result": "APPROVAL_REQUEST_RESULT_UNSPECIFIED",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "updatedAt": "2025-01-15T01:30:15.000Z",
    "approverJustificationMode": "<string>"
  }
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Team-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	Access-request approvals: `settings:read` Workflow-run approvals: `workflows:read` Change-set review approvals, Approvals started by another Serval service: Unsupported
Team-scoped API key	Access-request approvals: `settings:read` Workflow-run approvals: `workflows:read` Change-set review approvals, Approvals started by another Serval service: Unsupported
User-based token (OAuth)	Supported, subject to permissions

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Team keys must allow every team checked by the request. OAuth access depends on the user’s roles and resource access.

Change-set review approvals: Applies to approvals that gate a Catalyst change-set review.
Approvals started by another Serval service: Only the approval’s requester and its approvers may read it. Any other caller receives not found. API keys cannot read these approvals.

Authorizations

Authorization

string

header

required

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

Path Parameters

approval_request_id

string

required

The ID of the approval request.

Response

200 - application/json

Success

data

data · object

A runtime approval request tracking the approval workflow for an access request or workflow run.

data
data

Show child attributes

Get Approval Request

curl --request GET \
  --url https://public.api.serval.com/v2/approval-requests/{approval_request_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public.api.serval.com/v2/approval-requests/{approval_request_id}"

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

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

print(response.text)

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

fetch('https://public.api.serval.com/v2/approval-requests/{approval_request_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://public.api.serval.com/v2/approval-requests/{approval_request_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://public.api.serval.com/v2/approval-requests/{approval_request_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))

}

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/approval-requests/{approval_request_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

{
  "data": {
    "accessRequestTimeAllocationId": "<string>",
    "id": "<string>",
    "result": "APPROVAL_REQUEST_RESULT_UNSPECIFIED",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "updatedAt": "2025-01-15T01:30:15.000Z",
    "approverJustificationMode": "<string>"
  }
}

Get started

Authentication

Endpoints

Development

Authentication and permissions

Authorizations

Path Parameters

Response

​Authentication and permissions

Authorizations

Path Parameters

Response

Authentication and permissions