Please see the full REST API documentation for API implementation details.

Resource: Templates

A template contains all the information necessary for creating an online meeting. Templates are associated with a room, and used to initialize meetings created in that room.


Properties

#
Field Type Notes
template_id integer
name plain text (64)
description plain text A short description about the template
group_size_min integer recommended minimum number of participants
group_size_max integer recommended maximum number of participants
facilitator_guide_text html Text instructions for the facilitator
participant_guide_text html Text instructions for the participant
meeting_name plain text (255) The proposed name for meetings created by this template
meeting_goal plain text The proposed goal statement for meetings created by this template
meeting_outcomes plain text The proposed outcomes for meetings created by this template
duration integer The proposed duration, in seconds, for meetings created by this template
create_ts timestamp
update_ts timestamp

Listing Templates in a Room

# 
GET /lucid/api/v1/rooms/:room_id/templates
Query parameter Notes
embed Comma separated list of embeddables: attendees , facilitators , participants , guests
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/rooms/74/templates?fields=template_id,name

Content-Type: application/json; charset=utf-8 
Content-Length: 246 
X-Requestor: jtkeith@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 97
X-Rate-Limit-Used: 1
X-Rate-Limit-Reset: 40

[
  {
    "template_id": 192,
    "name": "Quick discussion"
  },
  {
    "template_id": 114,
    "name": "Basic Agenda"
  },
  {
    "template_id": 5,
    "name": "Remote Team Check-In"
  },
  {
    "template_id": 6,
    "name": "Cross-Functional Weekly Update"
  }
]

Getting a Single Template

# 
GET /lucid/api/v1/templates/:template_id
Query parameter Notes
embed Comma separated list of embeddables: attendees , facilitators , participants , guests
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/templates/114

Content-Type: application/json; charset=utf-8 
Content-Length: 527 
X-Requestor: jtkeith@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 99
X-Rate-Limit-Used: 1
X-Rate-Limit-Reset: 60

{
  "template_id": 114,
  "name": "Basic Agenda",
  "description": "Select our basic three-step agenda to get started quickly.",
  "group_size_min": 2,
  "group_size_max": 50,
  "facilitator_guide_text": "",
  "participant_guide_text": "",
  "meeting_name": null,
  "meeting_goal": "",
  "meeting_outcomes": "",
  "duration": 3300,
  "create_ts": {
    "value": 1418940049,
    "iso_8601": "2014-12-18T22:00:49Z"
  },
  "update_ts": {
    "value": 1418940049,
    "iso_8601": "2014-12-18T22:00:49Z"
  }
}