Get a time-off request
curl --request GET \
--url https://a-char.com/api/v1/time-off/requests/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://a-char.com/api/v1/time-off/requests/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://a-char.com/api/v1/time-off/requests/{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://a-char.com/api/v1/time-off/requests/{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://a-char.com/api/v1/time-off/requests/{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))
}HttpResponse<String> response = Unirest.get("https://a-char.com/api/v1/time-off/requests/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://a-char.com/api/v1/time-off/requests/{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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "approved",
"policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policy": {
"name": "<string>",
"is_approval_required": true
},
"start_date": "2023-12-25",
"start_date_type": "FULL_DAY",
"end_date": "2023-12-25",
"end_date_type": "FULL_DAY",
"amount": 123,
"note": "<string>",
"requested_at": "<string>",
"approvers": [
{
"approver": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"email": "<string>"
},
"status": "approved",
"level_order": 123,
"decisioned_at": "<string>",
"note": "<string>"
}
],
"time_off_documents": [
{
"name": "<string>",
"file_path": "<string>",
"kind": "request"
}
]
}Time off requests
Get a time-off request
One request, as much of it as the caller may see. An admin, the employee who asked and the current or an earlier approver get all of it — note, approvers, documents. Anyone else gets an approved request without those, the way it appears on the calendar. 404 when the request does not exist or the caller may not see it. Requires the time-off:read scope.
GET
/
time-off
/
requests
/
{id}
Get a time-off request
curl --request GET \
--url https://a-char.com/api/v1/time-off/requests/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://a-char.com/api/v1/time-off/requests/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://a-char.com/api/v1/time-off/requests/{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://a-char.com/api/v1/time-off/requests/{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://a-char.com/api/v1/time-off/requests/{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))
}HttpResponse<String> response = Unirest.get("https://a-char.com/api/v1/time-off/requests/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://a-char.com/api/v1/time-off/requests/{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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "approved",
"policy_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"policy": {
"name": "<string>",
"is_approval_required": true
},
"start_date": "2023-12-25",
"start_date_type": "FULL_DAY",
"end_date": "2023-12-25",
"end_date_type": "FULL_DAY",
"amount": 123,
"note": "<string>",
"requested_at": "<string>",
"approvers": [
{
"approver": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"email": "<string>"
},
"status": "approved",
"level_order": 123,
"decisioned_at": "<string>",
"note": "<string>"
}
],
"time_off_documents": [
{
"name": "<string>",
"file_path": "<string>",
"kind": "request"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
200 - application/json
OK
Available options:
approved, pending, declined, canceled Show child attributes
Show child attributes
Available options:
FULL_DAY, AM, PM Available options:
FULL_DAY, AM, PM Show child attributes
Show child attributes
Show child attributes
Show child attributes