Template

A template you can start new work from — one your account saved, or one from Bonsai's library.

  • categories
    Type: array of string
    required

    Category names the template is filed under, drawn from the category rows of /public-api/v1/template_categories?filter[type]=Doc. Your own templates are filed under My Templates.

  • id
    Type: stringFormat: uuid
    required

    Unique identifier for the template. Stable across requests, so you can store it and recognise the same template later.

  • industries
    Type: array of string
    required

    Industry names the template is aimed at, drawn from the industry rows of /public-api/v1/template_categories?filter[type]=Doc.

  • name
    Type: string | null
    required

    Template name, as it appears in the gallery.

  • region
    Type: string | null
    required

    The region whose conventions the template is written for, or null when it applies everywhere.

  • source
    Type: string
    required

    Where the template comes from: own for one your account saved, library for one of Bonsai's. Prefer your own when both match.

  • updated_at
    Type: stringFormat: date-time
    required

    When the template was last changed.

  • url
    Type: string | null
    required

    Absolute link to open the template in the Bonsai app, or null when your account cannot edit it. Library templates are edited by Bonsai, so theirs is null unless your account curates the library; your own is null when your role cannot edit documents.