v1

latestOpenAPI 3.0.12026-07-268028223.9 KB

Tasks

List tasks

List all tasks. Optionally filter by book_id to scope to a specific book.

get/v1/tasks

Query parameters

pageinteger

Page number

per_pageinteger

Items per page (1-100, default: 25). Values over 100 will be clamped to 100.

book_idstring

Filter by book ID

status'todo' | 'done'

Filter by status

priority'low_priority' | 'medium_priority' | 'high_priority' | 'urgent_priority'

Filter by priority

household_idstring

Filter by household ID

contact_idstring

Filter by contact ID

assigned_to_idstring

Filter by assigned user ID from the relevant book users list

Response

successful

Example response

{
  "data": [
    {
      "id": "abc123xyz",
      "title": "Follow up with client"
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}