v1

latestOpenAPI 3.0.12026-07-268028223.9 KB

Project Templates

List project templates

List project templates. Optionally filter by book_id to return templates usable for a specific book, including company-wide templates.

get/v1/project_templates

Query parameters

book_idstring

Filter by book ID

projectable_kind'household' | 'contact' | 'business'

Filter by related record kind

pageinteger

Page number

per_pageinteger

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

Response

project templates retrieved

Example response

{
  "data": [
    {
      "id": "template123xyz",
      "guid": "template-guid",
      "title": "New Client Onboarding",
      "attachments": [
        {
          "file_name": "onboarding.pdf",
          "file_type": "application/pdf",
          "file_size": 123456,
          "source": "uploaded",
          "signed_id": "signed-blob-id"
        }
      ],
      "project_milestones": [
        {
          "id": "milestone123xyz",
          "guid": "milestone-guid",
          "title": "Initial Setup",
          "project_template_id": "template123xyz",
          "project_milestone_outcomes": [
            {
              "id": "outcome123xyz",
              "label": "Ready for accounts"
            }
          ],
          "project_milestone_form_fields": [
            {
              "id": "field123xyz",
              "guid": "field-guid",
              "label": "Custodian"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_count": 100,
    "per_page": 25
  }
}