Events
Get Event
Returns details for a single event by ID.
GET
/
events
/
{id}
Get Event
curl --request GET \
--url https://api.roostedhr.com/api/1_12/events/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.roostedhr.com/api/1_12/events/{id}"
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/events/{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://api.roostedhr.com/api/1_12/events/{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 => [
"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/events/{id}"
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/events/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/events/{id}")
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": "<string>",
"date": "2023-12-25",
"event_id": "<string>",
"client_id": "<string>",
"created": "2023-12-25",
"location": {
"id": "<string>",
"location": "<string>",
"addy_street_number": "<string>",
"addy_city": "<string>",
"addy_zip": "<string>",
"location_comments": "<string>",
"default": 0,
"saved": 0,
"color": "#DC136C",
"timezone": {
"id": 123,
"name": "<string>",
"offset": "<string>"
},
"companies_payroll_rulesets_id": "<string>",
"payroll_rule_display": "<string>",
"latitude": "<string>",
"longitude": "<string>",
"default_clients_id": "<string>",
"default_areas": [
"<string>"
]
},
"admin_origin": {
"personnel_id": "<string>",
"name": "<string>"
},
"reviewer": {
"personnel_id": "<string>",
"name": "<string>"
},
"time_tracking_manager": {
"personnel_id": "<string>",
"name": "<string>"
},
"custom_fields": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>",
"options": [
{
"title": "<string>",
"value": "<string>"
}
]
}
],
"areas": [
{
"id": "<string>",
"name": "<string>"
}
]
}Authorizations
Path Parameters
Event ID
Response
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Areas/zones assigned to the event. Null if none.
Show child attributes
Show child attributes
Previous
Edit EventUpdates an existing event. Despite being a PATCH endpoint, `name`, `date`, and `location` are required in every request.
Next
⌘I
Get Event
curl --request GET \
--url https://api.roostedhr.com/api/1_12/events/{id} \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.roostedhr.com/api/1_12/events/{id}"
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/events/{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://api.roostedhr.com/api/1_12/events/{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 => [
"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/events/{id}"
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/events/{id}")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/events/{id}")
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": "<string>",
"date": "2023-12-25",
"event_id": "<string>",
"client_id": "<string>",
"created": "2023-12-25",
"location": {
"id": "<string>",
"location": "<string>",
"addy_street_number": "<string>",
"addy_city": "<string>",
"addy_zip": "<string>",
"location_comments": "<string>",
"default": 0,
"saved": 0,
"color": "#DC136C",
"timezone": {
"id": 123,
"name": "<string>",
"offset": "<string>"
},
"companies_payroll_rulesets_id": "<string>",
"payroll_rule_display": "<string>",
"latitude": "<string>",
"longitude": "<string>",
"default_clients_id": "<string>",
"default_areas": [
"<string>"
]
},
"admin_origin": {
"personnel_id": "<string>",
"name": "<string>"
},
"reviewer": {
"personnel_id": "<string>",
"name": "<string>"
},
"time_tracking_manager": {
"personnel_id": "<string>",
"name": "<string>"
},
"custom_fields": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>",
"options": [
{
"title": "<string>",
"value": "<string>"
}
]
}
],
"areas": [
{
"id": "<string>",
"name": "<string>"
}
]
}