Search Access Requests

POST

access-requests

curl --request POST \
  --url https://public.api.serval.com/v2/access-requests/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "requestedRoleId": "<string>",
  "appInstanceId": "<string>",
  "statuses": [],
  "targetUserId": "<string>",
  "requestedByUserId": "<string>",
  "createdAfter": "<string>",
  "createdBefore": "<string>",
  "linkedTicketId": "<string>",
  "pageSize": 123,
  "pageToken": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/access-requests/search"

payload = {
    "teamId": "<string>",
    "requestedRoleId": "<string>",
    "appInstanceId": "<string>",
    "statuses": [],
    "targetUserId": "<string>",
    "requestedByUserId": "<string>",
    "createdAfter": "<string>",
    "createdBefore": "<string>",
    "linkedTicketId": "<string>",
    "pageSize": 123,
    "pageToken": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    teamId: '<string>',
    requestedRoleId: '<string>',
    appInstanceId: '<string>',
    statuses: [],
    targetUserId: '<string>',
    requestedByUserId: '<string>',
    createdAfter: '<string>',
    createdBefore: '<string>',
    linkedTicketId: '<string>',
    pageSize: 123,
    pageToken: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/access-requests/search', 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/access-requests/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'teamId' => '<string>',
    'requestedRoleId' => '<string>',
    'appInstanceId' => '<string>',
    'statuses' => [
        
    ],
    'targetUserId' => '<string>',
    'requestedByUserId' => '<string>',
    'createdAfter' => '<string>',
    'createdBefore' => '<string>',
    'linkedTicketId' => '<string>',
    'pageSize' => 123,
    'pageToken' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://public.api.serval.com/v2/access-requests/search"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"requestedRoleId\": \"<string>\",\n  \"appInstanceId\": \"<string>\",\n  \"statuses\": [],\n  \"targetUserId\": \"<string>\",\n  \"requestedByUserId\": \"<string>\",\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\",\n  \"linkedTicketId\": \"<string>\",\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/access-requests/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"requestedRoleId\": \"<string>\",\n  \"appInstanceId\": \"<string>\",\n  \"statuses\": [],\n  \"targetUserId\": \"<string>\",\n  \"requestedByUserId\": \"<string>\",\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\",\n  \"linkedTicketId\": \"<string>\",\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/access-requests/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"teamId\": \"<string>\",\n  \"requestedRoleId\": \"<string>\",\n  \"appInstanceId\": \"<string>\",\n  \"statuses\": [],\n  \"targetUserId\": \"<string>\",\n  \"requestedByUserId\": \"<string>\",\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\",\n  \"linkedTicketId\": \"<string>\",\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "teamId": "<string>",
      "status": "ACCESS_REQUEST_STATUS_UNSPECIFIED",
      "createdAt": "<string>",
      "targetUserId": "<string>",
      "requestedRoleId": "<string>",
      "expiresAt": "<string>",
      "linkedTicketId": "<string>",
      "timeAllocations": [
        {
          "id": "<string>",
          "status": "ACCESS_REQUEST_TIME_ALLOCATION_STATUS_UNSPECIFIED",
          "createdAt": "<string>",
          "requestedMinutes": 123,
          "approvedMinutes": 123,
          "businessJustification": "<string>",
          "requestedByUserId": "<string>",
          "invalidationReason": "ACCESS_REQUEST_TIME_ALLOCATION_INVALIDATION_REASON_UNSPECIFIED",
          "linkedTicketId": "<string>",
          "approvalRequestId": "<string>"
        }
      ]
    }
  ],
  "nextPageToken": "<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	`settings:read`
Team-scoped API key	`settings:read`
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.

Authorizations

Authorization

string

header

required

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

Body

application/json

teamId

string

The ID of the team. Required.

requestedRoleId

string | null

Filter by requested role ID.

appInstanceId

string | null

Filter by app instance ID.

statuses

enum<string>[]

Filter by statuses (multiple allowed).

AccessRequestStatus represents the overall status of an access request. Used by the public API for SDK consumers.

Available options:

ACCESS_REQUEST_STATUS_UNSPECIFIED,

ACCESS_REQUEST_STATUS_PENDING,

ACCESS_REQUEST_STATUS_APPROVED,

ACCESS_REQUEST_STATUS_DENIED,

ACCESS_REQUEST_STATUS_EXPIRED,

ACCESS_REQUEST_STATUS_REVOKED,

ACCESS_REQUEST_STATUS_CANCELED,

ACCESS_REQUEST_STATUS_FAILED

targetUserId

string | null

Filter by the target user for whom access was requested.

requestedByUserId

string | null

Filter by the user who requested access.

createdAfter

string | null

Filter by requests created after this timestamp (RFC3339 format).

createdBefore

string | null

Filter by requests created before this timestamp (RFC3339 format).

linkedTicketId

string | null

Filter by linked ticket ID.

pageSize

integer<int32> | null

Maximum number of results to return. Default is 1000, maximum is 5000.

pageToken

string | null

Token for pagination. Leave empty for the first request.

Response

200 - application/json

Success

data

AccessRequest · object[]

The list of access requests.

Show child attributes

nextPageToken

string | null

Token for retrieving the next page of results. Empty if no more results.

Search Access Requests

curl --request POST \
  --url https://public.api.serval.com/v2/access-requests/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "requestedRoleId": "<string>",
  "appInstanceId": "<string>",
  "statuses": [],
  "targetUserId": "<string>",
  "requestedByUserId": "<string>",
  "createdAfter": "<string>",
  "createdBefore": "<string>",
  "linkedTicketId": "<string>",
  "pageSize": 123,
  "pageToken": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/access-requests/search"

payload = {
    "teamId": "<string>",
    "requestedRoleId": "<string>",
    "appInstanceId": "<string>",
    "statuses": [],
    "targetUserId": "<string>",
    "requestedByUserId": "<string>",
    "createdAfter": "<string>",
    "createdBefore": "<string>",
    "linkedTicketId": "<string>",
    "pageSize": 123,
    "pageToken": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    teamId: '<string>',
    requestedRoleId: '<string>',
    appInstanceId: '<string>',
    statuses: [],
    targetUserId: '<string>',
    requestedByUserId: '<string>',
    createdAfter: '<string>',
    createdBefore: '<string>',
    linkedTicketId: '<string>',
    pageSize: 123,
    pageToken: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/access-requests/search', 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/access-requests/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'teamId' => '<string>',
    'requestedRoleId' => '<string>',
    'appInstanceId' => '<string>',
    'statuses' => [
        
    ],
    'targetUserId' => '<string>',
    'requestedByUserId' => '<string>',
    'createdAfter' => '<string>',
    'createdBefore' => '<string>',
    'linkedTicketId' => '<string>',
    'pageSize' => 123,
    'pageToken' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://public.api.serval.com/v2/access-requests/search"

	payload := strings.NewReader("{\n  \"teamId\": \"<string>\",\n  \"requestedRoleId\": \"<string>\",\n  \"appInstanceId\": \"<string>\",\n  \"statuses\": [],\n  \"targetUserId\": \"<string>\",\n  \"requestedByUserId\": \"<string>\",\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\",\n  \"linkedTicketId\": \"<string>\",\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public.api.serval.com/v2/access-requests/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"teamId\": \"<string>\",\n  \"requestedRoleId\": \"<string>\",\n  \"appInstanceId\": \"<string>\",\n  \"statuses\": [],\n  \"targetUserId\": \"<string>\",\n  \"requestedByUserId\": \"<string>\",\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\",\n  \"linkedTicketId\": \"<string>\",\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/access-requests/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"teamId\": \"<string>\",\n  \"requestedRoleId\": \"<string>\",\n  \"appInstanceId\": \"<string>\",\n  \"statuses\": [],\n  \"targetUserId\": \"<string>\",\n  \"requestedByUserId\": \"<string>\",\n  \"createdAfter\": \"<string>\",\n  \"createdBefore\": \"<string>\",\n  \"linkedTicketId\": \"<string>\",\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "<string>",
      "teamId": "<string>",
      "status": "ACCESS_REQUEST_STATUS_UNSPECIFIED",
      "createdAt": "<string>",
      "targetUserId": "<string>",
      "requestedRoleId": "<string>",
      "expiresAt": "<string>",
      "linkedTicketId": "<string>",
      "timeAllocations": [
        {
          "id": "<string>",
          "status": "ACCESS_REQUEST_TIME_ALLOCATION_STATUS_UNSPECIFIED",
          "createdAt": "<string>",
          "requestedMinutes": 123,
          "approvedMinutes": 123,
          "businessJustification": "<string>",
          "requestedByUserId": "<string>",
          "invalidationReason": "ACCESS_REQUEST_TIME_ALLOCATION_INVALIDATION_REASON_UNSPECIFIED",
          "linkedTicketId": "<string>",
          "approvalRequestId": "<string>"
        }
      ]
    }
  ],
  "nextPageToken": "<string>"
}

Get started

Authentication

Endpoints

Development

Authentication and permissions

Authorizations

Body

Response

​Authentication and permissions

Authorizations

Body

Response

Authentication and permissions