Skip to main content
GET
/
v1
/
projects
List projects
curl --request GET \
  --url https://api.slant.app/v1/projects \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "project123xyz",
      "name": "Smith Family Onboarding",
      "book_id": "book123xyz",
      "project_milestone": {
        "id": "milestone123xyz",
        "title": "Initial Setup",
        "project_template_id": "template123xyz",
        "guid": "milestone-guid",
        "color": "<string>",
        "sort_order": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "project_milestone_outcomes": [
          {
            "id": "outcome123xyz",
            "label": "Ready for accounts",
            "default_comment": "<string>",
            "sort_order": 123,
            "target_project_milestone_id": "<string>"
          }
        ],
        "project_milestone_form_fields": [
          {
            "id": "field123xyz",
            "label": "Custodian",
            "required": true,
            "guid": "field-guid",
            "placeholder": "<string>",
            "sort_order": 123,
            "household_record_source": "<string>",
            "select_options": [
              "<string>"
            ]
          }
        ]
      },
      "project_template": {
        "id": "template123xyz",
        "title": "New Client Onboarding",
        "project_milestones": [
          {
            "id": "milestone123xyz",
            "title": "Initial Setup",
            "project_template_id": "template123xyz",
            "guid": "milestone-guid",
            "color": "<string>",
            "sort_order": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "project_milestone_outcomes": [
              {
                "id": "outcome123xyz",
                "label": "Ready for accounts",
                "default_comment": "<string>",
                "sort_order": 123,
                "target_project_milestone_id": "<string>"
              }
            ],
            "project_milestone_form_fields": [
              {
                "id": "field123xyz",
                "label": "Custodian",
                "required": true,
                "guid": "field-guid",
                "placeholder": "<string>",
                "sort_order": 123,
                "household_record_source": "<string>",
                "select_options": [
                  "<string>"
                ]
              }
            ]
          }
        ],
        "guid": "template-guid",
        "description": "<string>",
        "enable_kanban_view": true,
        "book_id": "<string>",
        "order_index": 123,
        "book_name": "<string>",
        "book_initials": "<string>",
        "attachments": [
          {
            "file_name": "onboarding.pdf",
            "file_type": "application/pdf",
            "file_size": 123456,
            "source": "uploaded",
            "signed_id": "signed-blob-id",
            "download_url": "<string>",
            "view_url": "<string>"
          }
        ],
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "milestone_progress": 123,
      "overall_progress": 123,
      "milestone_updated_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "project_template_id": "template123xyz",
      "project_milestone_id": "milestone123xyz",
      "assigned_to_id": "<string>",
      "created_by_id": "<string>",
      "household_id": "<string>",
      "projectable_id": "<string>",
      "description": {
        "html": "<string>",
        "markdown": "<string>",
        "nodes": null,
        "preferred_format": "<string>"
      },
      "comments_count": 123,
      "milestone_progresses": [
        {}
      ],
      "visited_project_milestone_ids": [
        "<string>"
      ],
      "attachments": [
        {
          "file_name": "onboarding.pdf",
          "file_type": "application/pdf",
          "file_size": 123456,
          "source": "uploaded",
          "signed_id": "signed-blob-id",
          "download_url": "<string>",
          "view_url": "<string>"
        }
      ],
      "household": {
        "id": "<string>",
        "name": "<string>"
      },
      "projectable": {
        "id": "abc123xyz",
        "name": "Smith Household",
        "person": {
          "id": "abc123xyz",
          "book_id": "book123xyz",
          "first_name": "John",
          "last_name": "Doe",
          "household_id": "xyz789abc",
          "contact_id": "cnt456def",
          "role_type": "client",
          "middle_name": "Robert",
          "salutation": "Mr.",
          "suffix": "Jr.",
          "maiden_name": "Smith",
          "gender": "male",
          "designations": "CPA, CFP",
          "household_role": "head_of_household",
          "preferred_name": "Johnny",
          "date_of_birth": "1985-06-15",
          "job_title": "Software Engineer",
          "ssn": "***-**-6789",
          "drivers_license_number": "******7890",
          "email_addresses": [
            {
              "email": "john.doe@example.com",
              "email_type": "personal",
              "is_primary": true
            }
          ],
          "phone_numbers": [
            {
              "phone_number": "+15555551234",
              "phone_type": "mobile",
              "is_primary": true,
              "extension": "1234"
            }
          ],
          "addresses": [
            {
              "address_type": "home",
              "is_primary": true,
              "line1": "123 Main St",
              "line2": "Apt 4B",
              "city": "New York",
              "state": "NY",
              "zip": "10001",
              "country_code": "US"
            }
          ],
          "employments": [
            {
              "business_name": "Acme Corp",
              "id": "emp123xyz",
              "person_id": "abc123xyz",
              "role": "Software Engineer",
              "start_date": "2023-01-15",
              "end_date": "2024-12-31",
              "actively_employed": true
            }
          ],
          "custom_fields": {
            "preferred_contact_method": "Email",
            "risk_tolerance": "Moderate"
          }
        }
      },
      "assigned_to": {
        "id": "abc123xyz",
        "email": "user@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "api_access": {
          "auth_type": "personal_access_token",
          "scope": "read_write"
        }
      },
      "created_by": {
        "id": "abc123xyz",
        "email": "user@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "api_access": {
          "auth_type": "personal_access_token",
          "scope": "read_write"
        }
      },
      "project_form_field_responses": [
        {
          "id": "response123xyz",
          "project_milestone_form_field_id": "field123xyz",
          "value": "<unknown>",
          "display_value": "<string>"
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}

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