Skip to main content
GET
Get a project

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Path Parameters

id
string
required

The project ID

Query Parameters

book_id
string

Filter by book ID

Response

project retrieved

id
string
required

The project ID

Example:

"project123xyz"

name
string
required

The project name

Example:

"Smith Family Onboarding"

status
enum<string>
required

Project status

Available options:
in_progress,
overdue,
completed,
cancelled
book_id
string
required

The book ID

Example:

"book123xyz"

project_milestone
object
required
project_template
object
required
milestone_progress
integer | null

Percent complete for the current milestone

overall_progress
integer | null

Percent complete for the whole project

milestone_updated_at
string<date-time> | null
completed_at
string<date-time> | null
project_template_id
string

The project template ID

Example:

"template123xyz"

project_milestone_id
string

The current project milestone ID

Example:

"milestone123xyz"

assigned_to_id
string | null

Assigned user ID

created_by_id
string | null

Creator user ID

household_id
string | null

Attached household ID for household projects

projectable_type
enum<string> | null

Related record model type, or null for ownerless projects

Available options:
Household,
Contact,
Business
projectable_id
string | null

Related record ID, or null for ownerless projects

description
object
comments_count
integer

Active comment count

milestone_progresses
object[]
visited_project_milestone_ids
string[]
attachments
object[]
household
object | null
projectable
object | null

The related household, contact, or business. Null for ownerless projects.

assigned_to
object | null
created_by
object | null
project_form_field_responses
object[]
created_at
string<date-time>
updated_at
string<date-time>