Lucid Meetings REST API

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

Resource: Rooms

Rooms are dedicated spaces within an organization for team or topic-centered groups to conduct meetings. Rooms also contain room members who may manage or participate in meetings or Action Item followup.

• Properties
• Getting a List of My Rooms
• Getting a Single Room
• Updating a Room via PATCH
• Creating a Room
• Deleting a Room
• Related Collections

Properties

#

Field	Type	Notes
room_id	integer
room_url	url	The network location of the UI for this room
organization_id	tuple	owning organization: {organization_id, name}
name	plain text (64)
description	plain text (255)
private	boolean	Is membership in this room by invitation only?
create_ts	timestamp
update_ts	timestamp

Getting a List of My Rooms

#

GET /lucid/api/v1/rooms (must be logged in)

Query parameter	Notes
manager	One of: true or false
embed	Comma separated list of embeddables: room_members , managers , members , observers , guests
fields	See Field Filtering
envelope	See Enveloping

Sample Request

GET /lucid/api/v1/rooms?embed=managers&fields=room_id,name,create_ts

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

[
  {
    "room_id": 201,
    "name": "QA Team",
    "create_ts": {
      "value": 1432331981,
      "iso_8601": "2015-05-22T21:59:41Z"
    },
    "managers": [
      {
        "room_member_id": 382,
        "member_id": {
          "value": 1,
          "display": "Bob Smith"
        }
      }
    ]
  },
  {
    "room_id": 199,
    "name": "Project X",
    "create_ts": {
      "value": 1432323260,
      "iso_8601": "2015-05-22T19:34:20Z"
    },
    "managers": [
      {
        "room_member_id": 380,
        "member_id": {
          "value": 1,
          "display": "Bob Smith"
        }
      }
    ]
  }
]

Getting a Single Room

#

GET /lucid/api/v1/rooms/:room_id

Query parameter	Notes
embed	Comma separated list of embeddables: room_members , managers , members , guests
fields	See Field Filtering
envelope	See Enveloping

Sample Request

GET /lucid/api/v1/rooms/74?embed=organization

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

{
  "room_id": 74,
  "name": "Engineering Team",
  "organization_id": {
    "value": 50030,
    "display": "Customer Projects"
  },
  "description": "General meeting room for engineering team meetings",
  "private": true,
  "create_ts": {
    "value": 1387166101,
    "iso_8601": "2013-12-16T03:55:01Z"
  },
  "update_ts": {
    "value": 1434576208,
    "iso_8601": "2015-06-17T21:23:28Z"
  }
}

Updating an Room via PATCH

#

PATCH /lucid/api/v1/room/:room_id

Field	Required	Notes
name	no	Must not be an empty value
description	no
private	no	If omitted, the default value is true

Sample Request

PATCH /lucid/api/v1/rooms/74
Content-Type: application/json

{
  "name":"Engineering Team",
  "description":"Our motto: It Just Works"
}

200 OK
Content-Type: application/json

{
  "room_id": 74,
  "name": "Engineering Team",
  "organization_id": {
    "value": 50030,
    "display": "Customer Projects"
  },
  "description": "Our motto: It Just Works",
  "private": true,
  "create_ts": {
    "value": 1387166101,
    "iso_8601": "2013-12-16T03:55:01Z"
  },
  "update_ts": {
    "value": 1462239715,
    "iso_8601": "2016-05-03T01:41:55Z"
  }
}

Creating a Room

#

Note: the current organization owner will be added to the room as the initial room manager.

POST /lucid/api/v1/organizations/:organization_id/rooms

Field	Required	Notes
name	no	Must not be an empty value
description	no
private	no	If omitted, the default value is true

Sample Request

POST /lucid/api/v1/organizations/50093/rooms
Content-Type: application/json

{
  "name" : "Product management"
}

201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/organizations/50093/rooms/229
Content-Type: application/json

{
  "room_id": 229,
  "name": "Product management",
  "organization_id": {
    "value": 50093,
    "display": "Acme Sales"
  },
  "description": null,
  "private": true,
  "create_ts": {
    "value": 1462335155,
    "iso_8601": "2016-05-04T04:12:35Z"
  },
  "update_ts": {
    "value": 1462335155,
    "iso_8601": "2016-05-04T04:12:35Z"
  }
}

Deleting a Room

#

DELETE /lucid/api/v1/organizations/:organization_id/room/:room_id

Sample Request

DELETE /lucid/api/v1/organizations/50093/rooms/229

204 No Content

Related Collections

#

An individual room resource contains a set of collections that are managed in context: room_members , meetings , Action Items , and templates .

Room Members

Please see the room members resource for more information.

GET /lucid/api/v1/rooms/:room_id/room_members
GET /lucid/api/v1/rooms/:room_id/room_members/:room_member_id

The Lucid Meetings API provides collection shortcuts for interacting with subsets of the room members: managers , members , observers , and guests .

GET /lucid/api/v1/rooms/:meeting_id/managers
GET /lucid/api/v1/rooms/:meeting_id/managers/:room_member_id

GET /lucid/api/v1/rooms/:meeting_id/members
GET /lucid/api/v1/rooms/:meeting_id/members/:room_member_id

GET /lucid/api/v1/rooms/:meeting_id/observers
GET /lucid/api/v1/rooms/:meeting_id/observers/:room_member_id

GET /lucid/api/v1/rooms/:meeting_id/guests
GET /lucid/api/v1/rooms/:meeting_id/guests/:room_member_id

Meetings

The meeting listing for rooms supports pagination and sorting.
Please see the meetings resource for more information.

GET /lucid/api/v1/rooms/:room_id/meetings
GET /lucid/api/v1/rooms/:room_id/meetings/:meeting_id

Action Items

Please see the Action Items resource for more information.

GET /lucid/api/v1/rooms/:room_id/action_items
GET /lucid/api/v1/rooms/:room_id/action_items/:action_item_id

Notes

Please see the notes resource for more information.

GET /lucid/api/v1/rooms/:room_id/notes
GET /lucid/api/v1/rooms/:room_id/notes/:note_id

Templates

Please see the templates resource for more information.

GET /lucid/api/v1/rooms/:room_id/templates
GET /lucid/api/v1/rooms/:room_id/templates/:template_id

Meeting Summaries

Please see the meeting_summaries resource for more information.

GET /lucid/api/v1/rooms/:room_id/meeting_summaries