Overview
Clients
Payroll Groups
Rate Cards
Time Tracking
Wage Rules
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>'{
"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>"
}
]
}
]
}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
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>'{
"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>"
}
]
}
]
}