RHrhythms
tasks

List tasks

Changed on

Returns the tasks the caller can see, newest first, optionally narrowed to one object, owner or set of statuses.

This endpoint supports filtering and pagination through query parameters. Available ransackable attributes: uuid, title, status, owner_uuid, creator_uuid, subject_type, subject_uuid, due_on, created_at, updated_at.

get/tasks

Request

  • Base URL
    https://api.rhythms.ai
  • URL
    https://api.rhythms.ai/tasks
  • Auth
    none required

Query parameters

pagenumber

Page number for pagination (default: 1)

per_pagenumber

Number of records per page (default: 20, max: 100)

limitnumber

Alias for per_page - number of records per page

limit_maxnumber

Maximum number of records per page (overrides limit if not set)

offsetnumber

Number of records to skip, for offset/limit clients such as BI connectors. An offset past the end of the collection returns an empty records array, which is the end-of-data signal. To follow data.pagy.next instead of stepping the offset yourself, send it as page while keeping the same offset.

countstring

Set to 'true' to include total count in pagy metadata (data.pagy.count). Use for count/total queries instead of paginating through all pages.

subject_type'Okrs::Goal'

Only tasks attached to this type of object; use with subject_uuid

subject_uuidstring

Only tasks attached to the object with this UUID

owner_uuidstring

Only tasks owned by this user UUID

statusstring[]

Only tasks in these statuses (open, in_progress, blocked, done, canceled)

closed_sincestring

Only tasks closed (done or canceled) at or after this ISO 8601 time, newest closed first

qobject

Ransack query parameters for filtering. In query strings, use bracket notation: q[name_cont]=john&q[status_eq]=active&q[s]=name+asc. Keys are attribute names with predicates: _cont (contains), _eq (equals), _in (array membership), _gteq (>=), _lteq (<=), _present (not null), _null (is null). The "s" key sorts results (e.g., q[s]=created_at+desc). Example query string: ?q[name_cont]=john&q[s]=name+asc filters names containing "john" sorted by name ascending.

Changes