curl --request GET \
--url https://api.ctrl-hub.com/v3/document-reviewers \
--header 'X-Session-Token: <api-key>'import requests
url = "https://api.ctrl-hub.com/v3/document-reviewers"
headers = {"X-Session-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Session-Token': '<api-key>'}};
fetch('https://api.ctrl-hub.com/v3/document-reviewers', 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.ctrl-hub.com/v3/document-reviewers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Session-Token: <api-key>"
],
]);
$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.ctrl-hub.com/v3/document-reviewers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Session-Token", "<api-key>")
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.ctrl-hub.com/v3/document-reviewers")
.header("X-Session-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/document-reviewers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Session-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "reviewers",
"attributes": {
"email": "john.doe@example.com",
"profile": {
"personal": {
"first_name": "John",
"last_name": "Doe"
}
}
},
"relationships": {
"organisations": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
]
}
}
}
],
"meta": {
"pagination": {
"counts": {
"pages": 1,
"resources": 1
},
"current_page": 1,
"offsets": {
"next": null,
"previous": null
},
"requested": {
"limit": 10,
"offset": 0
}
},
"features": {
"include": {
"options": [
"related.resource"
]
}
}
},
"jsonapi": {
"version": "1.0"
}
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}List reviewers
List users eligible to review or approve a document.
Filter by document_id: the response is the members of the organisation owning
that document, plus the members of organisations on a currently-active share of
the document’s scheme. Shares that have ended, or that have not started yet, do not
contribute anybody.
This is the same set the API enforces on write, so anyone listed here will be accepted as an approver on an approval request for that document.
Each person carries only what choosing a reviewer needs: their id, name and email, and the
organisations they belong to that are party to the work. Their other attributes and
relationships, such as contact details, address and identities, are absent. There is no
include parameter, so included is absent.
Not for notification nominations. An approval request’s notify relationship takes
job roles, not users, because the holders are resolved at approval time rather
than when the request is raised. Submitting a user id from here as a notify target
fails request validation. Nominatable roles come from /v3/job-roles with the
document_id filter, which is a deliberately different set: the roles owned by the
organisation owning the document’s scheme, narrowed to shared roles for a caller
outside it.
curl --request GET \
--url https://api.ctrl-hub.com/v3/document-reviewers \
--header 'X-Session-Token: <api-key>'import requests
url = "https://api.ctrl-hub.com/v3/document-reviewers"
headers = {"X-Session-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Session-Token': '<api-key>'}};
fetch('https://api.ctrl-hub.com/v3/document-reviewers', 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.ctrl-hub.com/v3/document-reviewers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Session-Token: <api-key>"
],
]);
$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.ctrl-hub.com/v3/document-reviewers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Session-Token", "<api-key>")
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.ctrl-hub.com/v3/document-reviewers")
.header("X-Session-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/document-reviewers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Session-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "reviewers",
"attributes": {
"email": "john.doe@example.com",
"profile": {
"personal": {
"first_name": "John",
"last_name": "Doe"
}
}
},
"relationships": {
"organisations": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "organisations"
}
]
}
}
}
],
"meta": {
"pagination": {
"counts": {
"pages": 1,
"resources": 1
},
"current_page": 1,
"offsets": {
"next": null,
"previous": null
},
"requested": {
"limit": 10,
"offset": 0
}
},
"features": {
"include": {
"options": [
"related.resource"
]
}
}
},
"jsonapi": {
"version": "1.0"
}
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Authorizations
Query Parameters
Filters the response data based on the value provided.
Available filters:
document_id: Filter reviewers to those eligible to review or approve the specified document: members of the organisation owning the document, plus members of organisations on a currently-active share of the document's scheme. Preferred, and takes precedence overscheme_id— the organisation owning a document is not always the one owning its scheme, because a partner can upload onto a shared scheme. The same set the API enforces when an approval request names approvers, so anyone offered here will be accepted as an approver on a write. Not for notification nominations:notifytakes job roles, listed via thedocument_idfilter on/v3/job-roles.scheme_id: Filter reviewers to members of organisations on a currently-active share of the specified scheme that the caller can see, plus members of the organisation owning the scheme when the caller belongs to it. A share that has ended, or has not yet started, contributes no one. This assumes the scheme's owner owns the document, and then the list never offers anyone the API would refuse as an approver. When a partner uploaded the document, the list can leave out people the API would accept. Once that partner's share has ended, it also offers members of the scheme's owner, whom the API refuses.document_idis the exact filter. Ignored whendocument_idis given. If neither is supplied, an empty list is returned.org_id: Filter reviewers to members of a specific organisation (own org or a partner org connected via the scheme).name: Filter by name(s) - filters by first and last name (case insensitive)id_not_in: Exclude users whose ID is in the provided list.
For more information on using named filters, see the docs