Get Access Profile Grant - Serval Documentation

GET

/

v2

/

access-profile-grants

/

{id}

Get Access Profile Grant

curl --request GET \
  --url https://public.api.serval.com/v2/access-profile-grants/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public.api.serval.com/v2/access-profile-grants/{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/access-profile-grants/{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/access-profile-grants/{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/access-profile-grants/{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/access-profile-grants/{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": {
    "id": "<string>",
    "accessProfileId": "<string>",
    "workflowId": "<string>",
    "appResourceRoleId": "<string>",
    "formId": "<string>",
    "knowledgeItemId": "<string>",
    "excluded": true,
    "tracksTeamDefaultAccessProfile": true,
    "createdAt": "2025-01-15T01:30:15.000Z"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

id

string

required

The ID of the access profile grant.

Response

200 - application/json

Success

data

data · object

The kind of resource an access profile grant attaches to. One access-profile-to-resource attachment. For workflows and app resource roles the profile grants access; for forms it narrows the audience (a form with no grants is open to anyone in the org). Exactly one of the resource id fields is set; the field itself carries the resource kind, so cross-team tooling can resolve each id against its own resource type.

Show child attributes

Get Access Profile Grant

curl --request GET \
  --url https://public.api.serval.com/v2/access-profile-grants/{id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://public.api.serval.com/v2/access-profile-grants/{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/access-profile-grants/{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/access-profile-grants/{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/access-profile-grants/{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/access-profile-grants/{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": {
    "id": "<string>",
    "accessProfileId": "<string>",
    "workflowId": "<string>",
    "appResourceRoleId": "<string>",
    "formId": "<string>",
    "knowledgeItemId": "<string>",
    "excluded": true,
    "tracksTeamDefaultAccessProfile": true,
    "createdAt": "2025-01-15T01:30:15.000Z"
  }
}