Sign in

v1

latestOpenAPI 3.0.12026-07-268028223.9 KB
Project Templates

Get a project template

Retrieve a project template by ID, including milestones, outcomes, and form fields.

get/v1/project_templates/{id}

Query parameters

book_idstring

Filter by book ID

Response

project template retrieved

idstring required

The project template ID

guidstring

The project template GUID

titlestring required

The template title

descriptionstring nullable
projectable_kind'household' | 'contact' | 'business'

The related record kind this template supports

enable_kanban_viewboolean
book_idstring nullable

The owning book ID, or null for company-wide templates

order_indexinteger
book_namestring nullable
book_initialsstring nullable
created_atstring date-time
updated_atstring date-time

Example response

{
  "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"
        }
      ]
    }
  ]
}