Skip to main content
GET
List projects

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Query Parameters

book_id
string

Filter by book ID

status
enum<string>

Filter by status

Available options:
in_progress,
overdue,
completed,
cancelled
household_id
string

Filter by household ID

projectable_type
enum<string>

Filter by related record type

Available options:
Household,
Contact,
Business
projectable_id
string

Filter by related record ID. Must be used with projectable_type.

project_template_id
string

Filter by project template ID

project_milestone_id
string

Filter by current project milestone ID

assigned_to_id
string

Filter by assigned user ID

updated_since
string<date-time>

Filter by updated timestamp

without_projectable
enum<string>

When true, return only ownerless projects

Available options:
true,
false
include_inactive
enum<string>

When true, include completed and cancelled projects unless a status filter is provided

Available options:
true,
false
page
integer

Page number

per_page
integer

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

Required range: 1 <= x <= 100

Response

inactive projects included

data
object[]
required
pagination
object
required