curl --request GET \
--url https://{organization}.rescueconsole.com/api/tasks/facets \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/tasks/facets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/tasks/facets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"total": 123,
"facets": {
"status": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"priority": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"entity_type": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"overdue": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
]
}
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Count tasks by filter
How many tasks each filter option would give, for the same filters List tasks takes. Each group is counted with its own filter left out and every other filter applied, so the counts answer “how many would I get if I picked this instead”. Narrowed exactly as List tasks is: nothing is counted that your key could not list. The record kinds offered are only the ones your key may read.
curl --request GET \
--url https://{organization}.rescueconsole.com/api/tasks/facets \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/tasks/facets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/tasks/facets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"total": 123,
"facets": {
"status": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"priority": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"entity_type": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
],
"overdue": [
{
"value": "<string>",
"label": "<string>",
"count": 123
}
]
}
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Query Parameters
open, done low, normal, high Only tasks on this kind of record. A kind your key may not read answers 403 rather than an empty list. The kind of record a task is on. person is People; animal, location_unit (a housing location) and adoption_application are Animals; donation and campaign are Fundraising; shift, volunteer_event (a shift schedule) and shift_signup (a booking on a shift) are Shifts.
person, animal, location_unit, donation, campaign, shift, volunteer_event, shift_signup, adoption_application Only the tasks on this one record. Send it with entity_type; on its own it is refused.
Only tasks assigned to this person (their record ID).
Only tasks with a due date on or before this day.
true for open tasks due before today. A done task is never overdue. Any other value is ignored.
true