Query Tasks
curl --request POST \
--url https://api.virtuoussoftware.com/api/Task/Query \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.virtuoussoftware.com/api/Task/Query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/Task/Query"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/Task/Query");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/Task/Query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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.post("https://api.virtuoussoftware.com/api/Task/Query")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/Task/Query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/Task/Query';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"list": [
{
"id": 123,
"taskType": "<string>",
"task": "<string>",
"description": "<string>",
"dueDateTime": "<string>",
"dueDateTimeUtc": "2023-11-07T05:31:56Z",
"taskStatus": "NotStarted",
"taskStatusDisplayName": "<string>",
"taskKind": "Reminder",
"taskKindDisplayName": "<string>",
"resolutionDateTimeUtc": "2023-11-07T05:31:56Z",
"isResolved": true,
"isPastDue": true,
"contactId": 123,
"contactIndividualId": 123,
"contact": "<string>",
"contactUrl": "<string>",
"createDateTimeUtc": "2023-11-07T05:31:56Z",
"modifiedDateTimeUtc": "2023-11-07T05:31:56Z",
"createdByUser": "<string>",
"createdByAvatarUrl": "<string>",
"modifiedByUser": "<string>"
}
],
"total": 123
}{
"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."
}Tasks
Query Tasks
To see which options can be sent, use the Get Task Query Options endpoint.
If requests are timing out, you may be asking for too many items at once. The max take is 1,000.
To filter by status, use the Task Status parameter with the Is or IsNot operator. Send the status name (for example InProgress) or its display name (for example In Progress) as the value, spelled exactly; this value is case sensitive. To sort by when tasks were completed or dismissed, send ResolutionDate as sortBy. Results with the same sort value are ordered by task id, so paging with skip and take does not skip or repeat tasks.
POST
/
api
/
Task
/
Query
Query Tasks
curl --request POST \
--url https://api.virtuoussoftware.com/api/Task/Query \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.virtuoussoftware.com/api/Task/Query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.virtuoussoftware.com/api/Task/Query"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.virtuoussoftware.com/api/Task/Query");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.virtuoussoftware.com/api/Task/Query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
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.post("https://api.virtuoussoftware.com/api/Task/Query")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.virtuoussoftware.com/api/Task/Query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyconst url = 'https://api.virtuoussoftware.com/api/Task/Query';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"list": [
{
"id": 123,
"taskType": "<string>",
"task": "<string>",
"description": "<string>",
"dueDateTime": "<string>",
"dueDateTimeUtc": "2023-11-07T05:31:56Z",
"taskStatus": "NotStarted",
"taskStatusDisplayName": "<string>",
"taskKind": "Reminder",
"taskKindDisplayName": "<string>",
"resolutionDateTimeUtc": "2023-11-07T05:31:56Z",
"isResolved": true,
"isPastDue": true,
"contactId": 123,
"contactIndividualId": 123,
"contact": "<string>",
"contactUrl": "<string>",
"createDateTimeUtc": "2023-11-07T05:31:56Z",
"modifiedDateTimeUtc": "2023-11-07T05:31:56Z",
"createdByUser": "<string>",
"createdByAvatarUrl": "<string>",
"modifiedByUser": "<string>"
}
],
"total": 123
}{
"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
Query Parameters
Was this page helpful?