Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 1.31 KB

templates.md

File metadata and controls

40 lines (32 loc) · 1.31 KB

Templates

A templates is a specialized space within Kona that can be used to create additional spaces. This endpoint is specifically for retrieving templates available for a user and optionally limited by account and other criteria. Template management is handled through the spaces endpoint.

Schema 

{
  "templates": [{
    "id": integer, readonly,
    "name": string, required,
    "href": string, readonly,
    "account_id", integer, readonly,
    "details": string, readonly
    "overview": string, readonly
    "updated_at": datetime, readonly,
    "picture_thumb": string, readonly,
    "category": integer, (personal: 0, work: 1 [default]), readonly
    "tags": array of string, readonly,
    "template_date_type": string, readonly ('start_date', 'end_date', 'none')
  }]
}

Get templates

GET /templates will return all available templates.

Filter parameters

GET /templates?account_ids=:ids where :ids is an account_id or comma delimited list of account ids. See accounts

GET /templates??tag=:tag where :tag is a tag.

GET /templates?add_on_type=:type where :type is an add on type. See add ons in accounts

GET /templates/:id will return the specified template. See get response.