Events
Search Events
Searches events using a combination of filters. Returns paginated results.
POST
/
events
/
search
Search Events
curl --request POST \
--url https://api.roostedhr.com/api/1_12/events/search \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"start_date": "2001-01-01",
"end_date": "2001-01-01",
"event_name": "<string>",
"location_name": "<string>",
"tags": [
"<string>"
],
"areas": [
"<string>"
],
"workers": [
"<string>"
],
"clients": [
"<string>"
],
"skillsets": [
"<string>"
],
"unfilled": false,
"unpublished_shifts": false,
"pending_invites": false
}
'import requests
url = "https://api.roostedhr.com/api/1_12/events/search"
payload = {
"start_date": "2001-01-01",
"end_date": "2001-01-01",
"event_name": "<string>",
"location_name": "<string>",
"tags": ["<string>"],
"areas": ["<string>"],
"workers": ["<string>"],
"clients": ["<string>"],
"skillsets": ["<string>"],
"unfilled": False,
"unpublished_shifts": False,
"pending_invites": False
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
start_date: '2001-01-01',
end_date: '2001-01-01',
event_name: '<string>',
location_name: '<string>',
tags: ['<string>'],
areas: ['<string>'],
workers: ['<string>'],
clients: ['<string>'],
skillsets: ['<string>'],
unfilled: false,
unpublished_shifts: false,
pending_invites: false
})
};
fetch('https://api.roostedhr.com/api/1_12/events/search', 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/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start_date' => '2001-01-01',
'end_date' => '2001-01-01',
'event_name' => '<string>',
'location_name' => '<string>',
'tags' => [
'<string>'
],
'areas' => [
'<string>'
],
'workers' => [
'<string>'
],
'clients' => [
'<string>'
],
'skillsets' => [
'<string>'
],
'unfilled' => false,
'unpublished_shifts' => false,
'pending_invites' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.roostedhr.com/api/1_12/events/search"
payload := strings.NewReader("{\n \"start_date\": \"2001-01-01\",\n \"end_date\": \"2001-01-01\",\n \"event_name\": \"<string>\",\n \"location_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"areas\": [\n \"<string>\"\n ],\n \"workers\": [\n \"<string>\"\n ],\n \"clients\": [\n \"<string>\"\n ],\n \"skillsets\": [\n \"<string>\"\n ],\n \"unfilled\": false,\n \"unpublished_shifts\": false,\n \"pending_invites\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.roostedhr.com/api/1_12/events/search")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start_date\": \"2001-01-01\",\n \"end_date\": \"2001-01-01\",\n \"event_name\": \"<string>\",\n \"location_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"areas\": [\n \"<string>\"\n ],\n \"workers\": [\n \"<string>\"\n ],\n \"clients\": [\n \"<string>\"\n ],\n \"skillsets\": [\n \"<string>\"\n ],\n \"unfilled\": false,\n \"unpublished_shifts\": false,\n \"pending_invites\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/events/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start_date\": \"2001-01-01\",\n \"end_date\": \"2001-01-01\",\n \"event_name\": \"<string>\",\n \"location_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"areas\": [\n \"<string>\"\n ],\n \"workers\": [\n \"<string>\"\n ],\n \"clients\": [\n \"<string>\"\n ],\n \"skillsets\": [\n \"<string>\"\n ],\n \"unfilled\": false,\n \"unpublished_shifts\": false,\n \"pending_invites\": false\n}"
response = http.request(request)
puts response.read_body{
"events": [
{
"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>"
}
]
}
],
"total_count": 123
}Searches events using a combination of filters. The response is paginated — use
items_per_page and page query parameters.
start_date is the only required filter. All other filters are optional and combine with AND logic — only events matching every provided filter are returned.Use the boolean filters (
unfilled, unpublished_shifts, pending_invites) to surface events needing attention.Authorizations
Body
application/json
Example:
"2001-01-01"
Example:
"2001-01-01"
Search text for event name
Search text for location name of the event
Array of tag IDs
Array of area IDs
Array of worker IDs
Array of client IDs
Array of skillset IDs
Fetched only events with unfilled shifts
Fetched only events with unpublished shifts
Fetched only events with pending invites
⌘I
Search Events
curl --request POST \
--url https://api.roostedhr.com/api/1_12/events/search \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"start_date": "2001-01-01",
"end_date": "2001-01-01",
"event_name": "<string>",
"location_name": "<string>",
"tags": [
"<string>"
],
"areas": [
"<string>"
],
"workers": [
"<string>"
],
"clients": [
"<string>"
],
"skillsets": [
"<string>"
],
"unfilled": false,
"unpublished_shifts": false,
"pending_invites": false
}
'import requests
url = "https://api.roostedhr.com/api/1_12/events/search"
payload = {
"start_date": "2001-01-01",
"end_date": "2001-01-01",
"event_name": "<string>",
"location_name": "<string>",
"tags": ["<string>"],
"areas": ["<string>"],
"workers": ["<string>"],
"clients": ["<string>"],
"skillsets": ["<string>"],
"unfilled": False,
"unpublished_shifts": False,
"pending_invites": False
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
start_date: '2001-01-01',
end_date: '2001-01-01',
event_name: '<string>',
location_name: '<string>',
tags: ['<string>'],
areas: ['<string>'],
workers: ['<string>'],
clients: ['<string>'],
skillsets: ['<string>'],
unfilled: false,
unpublished_shifts: false,
pending_invites: false
})
};
fetch('https://api.roostedhr.com/api/1_12/events/search', 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/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start_date' => '2001-01-01',
'end_date' => '2001-01-01',
'event_name' => '<string>',
'location_name' => '<string>',
'tags' => [
'<string>'
],
'areas' => [
'<string>'
],
'workers' => [
'<string>'
],
'clients' => [
'<string>'
],
'skillsets' => [
'<string>'
],
'unfilled' => false,
'unpublished_shifts' => false,
'pending_invites' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.roostedhr.com/api/1_12/events/search"
payload := strings.NewReader("{\n \"start_date\": \"2001-01-01\",\n \"end_date\": \"2001-01-01\",\n \"event_name\": \"<string>\",\n \"location_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"areas\": [\n \"<string>\"\n ],\n \"workers\": [\n \"<string>\"\n ],\n \"clients\": [\n \"<string>\"\n ],\n \"skillsets\": [\n \"<string>\"\n ],\n \"unfilled\": false,\n \"unpublished_shifts\": false,\n \"pending_invites\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.roostedhr.com/api/1_12/events/search")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start_date\": \"2001-01-01\",\n \"end_date\": \"2001-01-01\",\n \"event_name\": \"<string>\",\n \"location_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"areas\": [\n \"<string>\"\n ],\n \"workers\": [\n \"<string>\"\n ],\n \"clients\": [\n \"<string>\"\n ],\n \"skillsets\": [\n \"<string>\"\n ],\n \"unfilled\": false,\n \"unpublished_shifts\": false,\n \"pending_invites\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.roostedhr.com/api/1_12/events/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start_date\": \"2001-01-01\",\n \"end_date\": \"2001-01-01\",\n \"event_name\": \"<string>\",\n \"location_name\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"areas\": [\n \"<string>\"\n ],\n \"workers\": [\n \"<string>\"\n ],\n \"clients\": [\n \"<string>\"\n ],\n \"skillsets\": [\n \"<string>\"\n ],\n \"unfilled\": false,\n \"unpublished_shifts\": false,\n \"pending_invites\": false\n}"
response = http.request(request)
puts response.read_body{
"events": [
{
"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>"
}
]
}
],
"total_count": 123
}