Templates

Reusable starting points for projects, budgets, deals, and pages. Each template wraps a real entity (its target) created with template semantics; the target_type discriminator determines the per-target shape required when creating a new template.

Attributes

color_id integer
Response Nullable

Color label assigned to the template.

copy_attributes object
Request

Form-only copy-behavior flags applied when target_id is supplied. See the create endpoint for per-target options.

created_at string
Response Parameter `sort`

Timestamp of when the template was created.

creator person
Response

Person who created the template.

deal deal
Response

Deal target when target_type is deal.

deleted_at string
Response Nullable

Timestamp marking soft deletion. Non-null values mean the template is in Trash and recoverable via the /deleted_items endpoint.

description string
Response Request Nullable

Free-text note attached to the template.

id integer
Parameter `filter` Parameter `sort`

Numeric identifier of the template.

model_attributes object
Request

Form-only polymorphic input bag. Required keys depend on target_type — see the create endpoint description for the per-target schema.

name string
Response Request

Display name of the template. Required on create. Updates also rename the wrapped target.

page page
Response

Page target when target_type is page.

project project
Response

Project this template was scoped under (denormalized via the wrapped target).

project_id integer
Parameter `filter` Parameter `sort`

Project identifier — filterable to scope templates to a specific project context.

query string
Parameter `filter`

Free-text query — matches against the wrapped target name.

target_id integer
Response Request Parameter `filter` Parameter `sort`

Id of the wrapped target.

target_type string
Response Request Parameter `filter` Parameter `sort` Enum

Identifies which entity type the template wraps. On create, selects the per-target model_attributes shape. task is read-only.

Enum Values (5 values)

  • budget
    Budget
  • deal
    Deal
  • project
    Project
  • page
    Page
  • task
    Task
task task
Response

Task target when target_type is task.

task_project_id integer
Parameter `filter`

Filter-only field — limits task templates (target_type=task) to those whose underlying task belongs to the given project.

updated_at string
Response Parameter `sort`

Timestamp of the most recent change to the template.

Examples

Loading example