Skip to main content
GET
Count tasks by filter

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Query Parameters

status
enum<string>
Available options:
open,
done
priority
enum<string>
Available options:
low,
normal,
high
entity_type
enum<string>

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.

Available options:
person,
animal,
location_unit,
donation,
campaign,
shift,
volunteer_event,
shift_signup,
adoption_application
entity_id
string

Only the tasks on this one record. Send it with entity_type; on its own it is refused.

assignee_person_id
string

Only tasks assigned to this person (their record ID).

due_before
string<date>

Only tasks with a due date on or before this day.

overdue
enum<string>

true for open tasks due before today. A done task is never overdue. Any other value is ignored.

Available options:
true

Response

The counts.

total
integer
required

How many tasks match every filter you sent.

facets
object
required