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

Resource: Notes

Notes are generally associated with meetings as part of the shared meeting record, but may also be added directly to a room between meetings.


Properties

#
Field Type Notes
note_id integer
description html
room_id tuple associated room: {room_id, name}
meeting_id tuple associated meeting: {meeting_id, name}
create_id tuple creator: {member_id, name}
update_id tuple updater: {member_id, name}
create_ts timestamp
update_ts timestamp

Notes From a Meeting

# 
GET /lucid/api/v1/meetings/:meeting_id/notes
Query parameter Notes
page Page number, starting from 0
per_page Any integer between 0 and 100, inclusive
sort One of: create_ts , -create_ts , update_ts , -update_ts
embed Comma separated list of embeddables: tags
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/meetings/1476/notes?fields=note_id,description

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

[
  {
    "note_id": 588,
    "description": "<p>Now is the time for the deep code refactoring project.<\/p>\n"
  },
  {
    "note_id": 589,
    "description": "<p>It is all <em>different<\/em> this time!<\/p>\n"
  },
  {
    "note_id": 590,
    "description": "<p>And time to adjourn?<\/p>\n\n<ol><li>Yes<\/li>\n\t<li>No<\/li>\n<\/ol>"
  }
]

Notes In a Room

#

Note: you must have room access permission to retrieve all notes from a room. The implication here it that guests are excluded from retrieving notes from meetings to which they were not invited. 

GET /lucid/api/v1/rooms/:room_id/notes
Query parameter Notes
tag Restrict list to notes with this tag (text)
page Page number, starting from 0
per_page Any integer between 0 and 100, inclusive
sort One of: create_ts , -create_ts , update_ts , -update_ts
embed Comma separated list of embeddables: tags
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/rooms/74/notes?fields=note_id,description

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

[
  {
    "note_id": 588,
    "description": "<p>Now is the time for the deep code refactoring project.<\/p>\n"
  },
  {
    "note_id": 589,
    "description": "<p>It is all <em>different<\/em> this time!<\/p>\n"
  },
  {
    "note_id": 590,
    "description": "<p>And time to adjourn?<\/p>\n\n<ol><li>Yes<\/li>\n\t<li>No<\/li>\n<\/ol>"
  }
]

Notes In an Organization

#

Note: you must have organization administrator permissions to retrieve notes across all rooms in the organization. The implication here is that members of one room cannot access notes from another private room in which they are not a member. 

GET /lucid/api/v1/organizations/:organization_id/notes
Query parameter Notes
tag Restrict list to notes with this global tag (text)
page Page number, starting from 0
per_page Any integer between 0 and 100, inclusive
sort One of: create_ts , -create_ts , update_ts , -update_ts
embed Comma separated list of embeddables: tags
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/organizations/50030/notes?fields=note_id,description

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

[
  {
    "note_id": 588,
    "description": "<p>Now is the time for the deep code refactoring project.<\/p>\n"
  },
  {
    "note_id": 589,
    "description": "<p>It is all <em>different<\/em> this time!<\/p>\n"
  },
  {
    "note_id": 590,
    "description": "<p>And time to adjourn?<\/p>\n\n<ol><li>Yes<\/li>\n\t<li>No<\/li>\n<\/ol>"
  }
]

Getting a Single Note

# 
GET /lucid/api/v1/notes/:note_id
Query parameter Notes
embed Comma separated list of embeddables: tags
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/notes/588

Content-Type: application/json; charset=utf-8 
Content-Length: 513
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

{
  "note_id": 588,
  "description": "<p>Now is the time for the deep code refactoring project.<\/p>\n",
  "room_id": {
    "value": 74,
    "display": "Engineering Team"
  },
  "meeting_id": {
    "value": 1476,
    "display": "Team Meeting"
  },
  "create_id": {
    "value": 1,
    "display": "Bob Smith"
  },
  "update_id": null,
  "create_ts": {
    "value": 1461874670,
    "iso_8601": "2016-04-28T20:17:50Z"
  },
  "update_ts": {
    "value": 1461874670,
    "iso_8601": "2016-04-28T20:17:50Z"
  }
}

Updating a Note via PATCH

# 
PATCH /lucid/api/v1/notes/:note_id
Field Required Notes
description no The note! The value of this property cannot be empty.

Sample Request

PATCH /lucid/api/v1/notes/588
Content-Type: application/json

{
  "description": "Mysterious things are afoot!"
}

200 OK
Content-Type: application/json

{
  "note_id": 588,
  "description": "Mysterious things are afoot!",
  "room_id": {
    "value": 74,
    "display": "Engineering Team"
  },
  "meeting_id": {
    "value": 1476,
    "display": "Team Meeting"
  },
  "create_id": {
    "value": 1,
    "display": "Bob Smith"
  },
  "update_id": {
    "value": "1",
    "display": "Bob Smith"
  },
  "create_ts": {
    "value": 1461874670,
    "iso_8601": "2016-04-28T20:17:50Z"
  },
  "update_ts": {
    "value": 1461879885,
    "iso_8601": "2016-04-28T21:44:45Z"
  }
}

Creating a Note for a Meeting

#

Note: notes are added to the first agenda item. 

POST /lucid/api/v1/meetings/:meeting_id/notes
Field Required Notes
description yes The note! The value of this property cannot be empty.

Sample Request

POST /lucid/api/v1/meetings/1476/notes
Content-Type: application/json

{
  "description":"Elise reports that the new API fully exceeds her expectations!"
}

201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/meetings/1476/notes/596
Content-Type: application/json

{
  "note_id": 596,
  "description": "Elise reports that the new API fully exceeds her expectations!",
  "room_id": {
    "value": 74,
    "display": "Engineering Team"
  },
  "meeting_id": {
    "value": 1476,
    "display": "Team Meeting"
  },
  "create_id": {
    "value": 1,
    "display": "Bob Smith"
  },
  "update_id": null,
  "create_ts": {
    "value": 1462055599,
    "iso_8601": "2016-04-30T22:33:19Z"
  },
  "update_ts": {
    "value": 1462055599,
    "iso_8601": "2016-04-30T22:33:19Z"
  }
}

Deleting a Note

#

This method requires the API caller to have facilitator permissions for the meeting containing the note. 

DELETE /lucid/api/v1/notes/:note_id

Sample Request

DELETE /lucid/api/v1/meetings/1476/notes/588




204 No Content