Skip to main content

[API Endpoint] Templates

Samantha L Cook
Updated 
https://teachboost.com/api/v1/templates
  • 15 requests are allowed every 60 seconds.

Options

None, all Templates are always returned.

Sample Object

{
    id: 320,
    name: 'Informal Observation',
    type: 'custom',
    category: 'Coaching',
    form_types: [
        'informal_obs',
        'classroom_walk',
        'peer_obs'
    ],
    is_cycle: false,
    self_eval: false
}

Dictionary

  • id: Integer, internal ID for the object
  • name: String, name of the Template
  • type: String, can be one of 'sketch', 'custom', 'video', and 'pdf'
  • category: String, optional category group
  • form_types: Array of Strings, list of allowed Form types for Forms utilizing this Template. This is the set of Form types presented to the staff members when creating Forms utilizing this Template.
  • is_cycle: Bool, if the Template is a Cycle. A Cycle is a collection of non-Cycle Templates. For example, a Formal Observation Cycle may include a Pre-Observation, Formal Evaluation, and Post-Observation, each of which are separate Templates collected into one bundle.
  • is_self: Bool, if Forms utilizing this Template are to be designated as "self" Forms. This is a special designation that automatically adds the creator/scheduler as both the Topic and the Author of the Form.

Related articles