Get Volunteer Opportunity Query Options
curl --request GET \
--url https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions",
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;
}HttpResponse<String> response = Unirest.get("https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions")
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_bodyconst url = 'https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"options": [
{
"parameter": "Volunteer Opportunity Id",
"type": "Int",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Name",
"type": "String",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Contains",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "StartsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "EndsWith",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Description",
"type": "String",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Contains",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "StartsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "EndsWith",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Create Date",
"type": "Date",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Before",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrBefore",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "After",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrAfter",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": [
"180 Days Ago",
"270 Days Ago",
"30 Days Ago",
"60 Days Ago",
"90 Days Ago",
"Last Sunday",
"One week from now",
"One Year Ago",
"Start Of This Month",
"This Calendar Year",
"Today",
"Tomorrow",
"Two Years Ago",
"Yesterday"
]
},
{
"parameter": "Last Modified Date",
"type": "Date",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Before",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrBefore",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "After",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrAfter",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": [
"180 Days Ago",
"270 Days Ago",
"30 Days Ago",
"60 Days Ago",
"90 Days Ago",
"Last Sunday",
"One week from now",
"One Year Ago",
"Start Of This Month",
"This Calendar Year",
"Today",
"Tomorrow",
"Two Years Ago",
"Yesterday"
]
},
{
"parameter": "Start Date",
"type": "Date",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsNotKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Before",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrBefore",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "After",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrAfter",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": [
"180 Days Ago",
"270 Days Ago",
"30 Days Ago",
"60 Days Ago",
"90 Days Ago",
"Last Sunday",
"One week from now",
"One Year Ago",
"Start Of This Month",
"This Calendar Year",
"Today",
"Tomorrow",
"Two Years Ago",
"Yesterday"
]
},
{
"parameter": "End Date",
"type": "Date",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsNotKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Before",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrBefore",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "After",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrAfter",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": [
"180 Days Ago",
"270 Days Ago",
"30 Days Ago",
"60 Days Ago",
"90 Days Ago",
"Last Sunday",
"One week from now",
"One Year Ago",
"Start Of This Month",
"This Calendar Year",
"Today",
"Tomorrow",
"Two Years Ago",
"Yesterday"
]
},
{
"parameter": "Anytime",
"type": "Boolean",
"operatorOptions": [
{
"operator": "IsTrue",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsFalse",
"multipleValuesAllowed": false,
"valueRequired": false
}
],
"valueOptions": []
},
{
"parameter": "Active",
"type": "Boolean",
"operatorOptions": [
{
"operator": "IsTrue",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsFalse",
"multipleValuesAllowed": false,
"valueRequired": false
}
],
"valueOptions": []
},
{
"parameter": "Local Only",
"type": "Boolean",
"operatorOptions": [
{
"operator": "IsTrue",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsFalse",
"multipleValuesAllowed": false,
"valueRequired": false
}
],
"valueOptions": []
},
{
"parameter": "Current Priority",
"type": "List",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsNot",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": [
"High",
"Low",
"Medium"
]
},
{
"parameter": "Current Need",
"type": "Int",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Preferred Number of Hours",
"type": "Decimal",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Location",
"type": "String",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Contains",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "StartsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "EndsWith",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "City",
"type": "String",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Contains",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "StartsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "EndsWith",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "State",
"type": "String",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsNot",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsNotKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "In",
"multipleValuesAllowed": true,
"valueRequired": true
},
{
"operator": "NotIn",
"multipleValuesAllowed": true,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Anywhere",
"type": "Boolean",
"operatorOptions": [
{
"operator": "IsTrue",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsFalse",
"multipleValuesAllowed": false,
"valueRequired": false
}
],
"valueOptions": []
}
],
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsNot",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsNotKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Contains",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "StartsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "EndsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsTrue",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsFalse",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsSet",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsNotSet",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "In",
"multipleValuesAllowed": true,
"valueRequired": true
},
{
"operator": "NotIn",
"multipleValuesAllowed": true,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Before",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "After",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsAnyOf",
"multipleValuesAllowed": true,
"valueRequired": true
},
{
"operator": "IsNoneOf",
"multipleValuesAllowed": true,
"valueRequired": true
},
{
"operator": "Matches",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrBefore",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrAfter",
"multipleValuesAllowed": false,
"valueRequired": true
}
]
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Volunteering
Get Volunteer Opportunity Query Options
Returns the fields, operators, and values you can use when building a volunteer opportunity query. Use it to build the groups and conditions you send to the Query Volunteer Opportunities endpoint.
GET
/
api
/
VolunteerOpportunity
/
QueryOptions
Get Volunteer Opportunity Query Options
curl --request GET \
--url https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions",
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;
}HttpResponse<String> response = Unirest.get("https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions")
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_bodyconst url = 'https://api.virtuoussoftware.com/api/VolunteerOpportunity/QueryOptions';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"options": [
{
"parameter": "Volunteer Opportunity Id",
"type": "Int",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Name",
"type": "String",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Contains",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "StartsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "EndsWith",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Description",
"type": "String",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Contains",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "StartsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "EndsWith",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Create Date",
"type": "Date",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Before",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrBefore",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "After",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrAfter",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": [
"180 Days Ago",
"270 Days Ago",
"30 Days Ago",
"60 Days Ago",
"90 Days Ago",
"Last Sunday",
"One week from now",
"One Year Ago",
"Start Of This Month",
"This Calendar Year",
"Today",
"Tomorrow",
"Two Years Ago",
"Yesterday"
]
},
{
"parameter": "Last Modified Date",
"type": "Date",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Before",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrBefore",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "After",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrAfter",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": [
"180 Days Ago",
"270 Days Ago",
"30 Days Ago",
"60 Days Ago",
"90 Days Ago",
"Last Sunday",
"One week from now",
"One Year Ago",
"Start Of This Month",
"This Calendar Year",
"Today",
"Tomorrow",
"Two Years Ago",
"Yesterday"
]
},
{
"parameter": "Start Date",
"type": "Date",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsNotKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Before",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrBefore",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "After",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrAfter",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": [
"180 Days Ago",
"270 Days Ago",
"30 Days Ago",
"60 Days Ago",
"90 Days Ago",
"Last Sunday",
"One week from now",
"One Year Ago",
"Start Of This Month",
"This Calendar Year",
"Today",
"Tomorrow",
"Two Years Ago",
"Yesterday"
]
},
{
"parameter": "End Date",
"type": "Date",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsNotKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Before",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrBefore",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "After",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrAfter",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": [
"180 Days Ago",
"270 Days Ago",
"30 Days Ago",
"60 Days Ago",
"90 Days Ago",
"Last Sunday",
"One week from now",
"One Year Ago",
"Start Of This Month",
"This Calendar Year",
"Today",
"Tomorrow",
"Two Years Ago",
"Yesterday"
]
},
{
"parameter": "Anytime",
"type": "Boolean",
"operatorOptions": [
{
"operator": "IsTrue",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsFalse",
"multipleValuesAllowed": false,
"valueRequired": false
}
],
"valueOptions": []
},
{
"parameter": "Active",
"type": "Boolean",
"operatorOptions": [
{
"operator": "IsTrue",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsFalse",
"multipleValuesAllowed": false,
"valueRequired": false
}
],
"valueOptions": []
},
{
"parameter": "Local Only",
"type": "Boolean",
"operatorOptions": [
{
"operator": "IsTrue",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsFalse",
"multipleValuesAllowed": false,
"valueRequired": false
}
],
"valueOptions": []
},
{
"parameter": "Current Priority",
"type": "List",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsNot",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": [
"High",
"Low",
"Medium"
]
},
{
"parameter": "Current Need",
"type": "Int",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Preferred Number of Hours",
"type": "Decimal",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Location",
"type": "String",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Contains",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "StartsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "EndsWith",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "City",
"type": "String",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Contains",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "StartsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "EndsWith",
"multipleValuesAllowed": false,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "State",
"type": "String",
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsNot",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsNotKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "In",
"multipleValuesAllowed": true,
"valueRequired": true
},
{
"operator": "NotIn",
"multipleValuesAllowed": true,
"valueRequired": true
}
],
"valueOptions": []
},
{
"parameter": "Anywhere",
"type": "Boolean",
"operatorOptions": [
{
"operator": "IsTrue",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsFalse",
"multipleValuesAllowed": false,
"valueRequired": false
}
],
"valueOptions": []
}
],
"operatorOptions": [
{
"operator": "Is",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsNot",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsNotKnown",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "LessThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "LessThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThan",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "GreaterThanOrEqual",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Contains",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "StartsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "EndsWith",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsTrue",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsFalse",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsSet",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "IsNotSet",
"multipleValuesAllowed": false,
"valueRequired": false
},
{
"operator": "In",
"multipleValuesAllowed": true,
"valueRequired": true
},
{
"operator": "NotIn",
"multipleValuesAllowed": true,
"valueRequired": true
},
{
"operator": "Between",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "Before",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "After",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "IsAnyOf",
"multipleValuesAllowed": true,
"valueRequired": true
},
{
"operator": "IsNoneOf",
"multipleValuesAllowed": true,
"valueRequired": true
},
{
"operator": "Matches",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrBefore",
"multipleValuesAllowed": false,
"valueRequired": true
},
{
"operator": "OnOrAfter",
"multipleValuesAllowed": false,
"valueRequired": true
}
]
}{
"message": "Authorization has been denied for this request."
}{
"message": "You do not have permission to perform this action."
}{
"message": "Rate limit exceeded. Try again later."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Last modified on August 11, 2026
Was this page helpful?
⌘I