Documents
Get Company Documents
This endpoint serves the purpose of fetching company documents.
GET
/
company
/
documents
Get Company Documents
curl --request GET \
--url https://api.roostedhr.com/api/1_12/company/documents \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.roostedhr.com/api/1_12/company/documents"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.roostedhr.com/api/1_12/company/documents', 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.roostedhr.com/api/1_12/company/documents",
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-API-KEY: <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.roostedhr.com/api/1_12/company/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<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.roostedhr.com/api/1_12/company/documents")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/company/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": 123,
"name": "Weekly Payroll",
"file_name": "Weekly_Payroll_2023",
"location": "https://schedulehead-files.nyc3.digitaloceanspaces.com/Weekly_Payroll_2023.pdf",
"date_added": "Dec 12th",
"type": "application/pdf",
"deleted": 0,
"date_deleted": null
},
{
"id": 321,
"name": "Company Logo",
"file_name": "company_logo",
"location": "https://schedulehead-files.nyc3.digitaloceanspaces.com/company_logo.png",
"date_added": "Dec 15th",
"type": "image/png",
"deleted": 0,
"date_deleted": null
}
]
Authorizations
Response
OK
Unique document identifier
Display name of the document
Original file name
URL to the stored document file
Date the document was uploaded
MIME type of the document (e.g. application/pdf, image/png)
Soft-delete flag (0 = active, 1 = deleted)
Timestamp when the document was soft-deleted, or null if active
⌘I
Get Company Documents
curl --request GET \
--url https://api.roostedhr.com/api/1_12/company/documents \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.roostedhr.com/api/1_12/company/documents"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://api.roostedhr.com/api/1_12/company/documents', 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.roostedhr.com/api/1_12/company/documents",
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-API-KEY: <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.roostedhr.com/api/1_12/company/documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<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.roostedhr.com/api/1_12/company/documents")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/company/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": 123,
"name": "Weekly Payroll",
"file_name": "Weekly_Payroll_2023",
"location": "https://schedulehead-files.nyc3.digitaloceanspaces.com/Weekly_Payroll_2023.pdf",
"date_added": "Dec 12th",
"type": "application/pdf",
"deleted": 0,
"date_deleted": null
},
{
"id": 321,
"name": "Company Logo",
"file_name": "company_logo",
"location": "https://schedulehead-files.nyc3.digitaloceanspaces.com/company_logo.png",
"date_added": "Dec 15th",
"type": "image/png",
"deleted": 0,
"date_deleted": null
}
]