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

Resource: Action Items

An action item is a special kind of note that includes an assigned owner, a due date, and an open or closed state. Action items are associated with rooms, meetings, and members.


Properties

#
Field Type Notes
action_item_id integer
action_item_url url The network location of the UI for this action item
state tuple action item state: {state, name}
description html description of the action to be completed
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}
member_id tuple assignee: {member_id, name}
due_ts timestamp due date for completion of this action item
close_ts timestamp date this action item was closed
create_ts timestamp
update_ts timestamp

My Action Items

#
GET /lucid/api/v1/action_items (must be logged in)
Query parameter Notes
view One of: created_by_me , assigned_to_me
state One of: any , open , closed
after Any action items due after the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1375450870 or 2013-08-02T13:41:10Z
before Any action items due before the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1438522870 or 2015-08-02T13:41:10Z
updated Any action items updated after the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1438522870 or 2015-08-02T13:41:10Z
assignee member_id (or 0 for unassigned); omit for all
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 , close_ts , -close_ts , due_ts , -due_ts
embed Comma separated list of embeddables: description_clean
fields See Field Filtering
envelope See Enveloping

Before and After Query Parameters

TIP: You can retrieve action items without an assigned Due Date (identified by the due_ts field) by setting both the before and after query parameters to a value of 0 . This works on any of the action item collections.

Sort Query Parameter

The sort query parameter for action items is quite flexible, allowing Ascending and Descending sorting based on several relevant date/time and timestamp-based fields.

  • create_ts: The initial action item creation timestamp
  • update_ts: The action item last modification timestamp
  • close_ts: The timestamp indicating when the action item was closed
  • due_ts: The timestamp indicating when the action item is due

Sample Request

GET /lucid/api/v1/action_items?fields=action_item_id,description,due_ts,state&per_page=2
Content-Type: application/json; charset=utf-8
Content-Length: 499
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 92
X-Rate-Limit-Reset: 6
X-Rate-Limit-Used: 2
X-Requestor: jtkeith@lucidmeetings.com
[
  {
    "action_item_id": 587,
    "state": {
      "value": 0,
      "display": "Open"
    },
    "description": "<p>File taxes before they are due<\/p>\n",
    "due_ts": {
      "value": 1459407600,
      "iso_8601": "2016-03-31T07:00:00Z"
    }
  },
  {
    "action_item_id": 577,
    "state": {
      "value": 1,
      "display": "Closed"
    },
    "description": "<p>Document requirements for followup email<\/p>\n",
    "due_ts": {
      "value": 1457683200,
      "iso_8601": "2016-03-11T08:00:00Z"
    }
  }
]

Action Items from a Meeting

#
GET /lucid/api/v1/meetings/:meeting_id/action_items
Query parameter Notes
state One of: any , open , closed
after Any action items due after the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1375450870 or 2013-08-02T13:41:10Z
before Any action items due before the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1438522870 or 2015-08-02T13:41:10Z
updated Any action items updated after the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1438522870 or 2015-08-02T13:41:10Z
assignee member_id (or 0 for unassigned); omit for all
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 , close_ts , -close_ts , due_ts , -due_ts
embed Comma separated list of embeddables: description_clean
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/meetings/1423/action_items?fields=action_item_id,description,due_ts
Content-Type: application/json; charset=utf-8
Content-Length: 543
X-Requestor: jtkeith@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 94
X-Rate-Limit-Reset: 7
X-Rate-Limit-Used: 2
[
  {
    "action_item_id": 573,
    "description": "<p>Setup new-hire training for Bob and Carol.<\/p>\n",
    "due_ts": {
      "value": 1456732800,
      "iso_8601": "2016-02-29T08:00:00Z"
    }
  },
  {
    "action_item_id": 576,
    "description": "<p>Notify Elise about the new plan<\/p>\n",
    "due_ts": null
  },
  {
    "action_item_id": 575,
    "description": "<p>Schedule a followup meeting to discuss issues<\/p>\n",
    "due_ts": null
  },
  {
    "action_item_id": 572,
    "description": "<p>Invite Alice to our next staff meeting<\/p>\n",
    "due_ts": null
  }
]

Action Items in a Room

#
GET /lucid/api/v1/rooms/:room_id/action_items
Query parameter Notes
state One of: any , open , closed
after Any action items due after the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1375450870 or 2013-08-02T13:41:10Z
before Any action items due before the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1438522870 or 2015-08-02T13:41:10Z
updated Any action items updated after the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1438522870 or 2015-08-02T13:41:10Z
assignee member_id (or 0 for unassigned); omit for all
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 , close_ts , -close_ts , due_ts , -due_ts
embed Comma separated list of embeddables: description_clean
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/rooms/74/action_items?fields=action_item_id,description,due_ts
Content-Type: application/json; charset=utf-8 
Content-Length: 430 
X-Requestor: jtkeith@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 98
X-Rate-Limit-Used: 1
X-Rate-Limit-Reset: 23
[
  {
    "action_item_id": 542,
    "description": "<p>Verify requirements sign-off<\/p>\n",
    "due_ts": null
  },
  {
    "action_item_id": 384,
    "description": "<p>Ask Bob about the proposal status<\/p>",
    "due_ts": null
  },
  {
    "action_item_id": 343,
    "description": "<p>Send a followup email to execs<\/p>",
    "due_ts": null
  },
  {
    "action_item_id": 385,
    "description": "<p>Reach out to John about joining the team<\/p>",
    "due_ts": null
  }
]

Action Items in a Room (Export)

#

The default content-type for retrieving a collection of action items is application/json, which delivers a json representation of the action item model data. The Lucid API also supports alternate, spreadsheet views of an action item collection. To retrieve action items in a different format, specify the format as noted below.

GET /lucid/api/v1/rooms/:room_id/action_items
Query parameter Notes
state One of: any , open , closed
after Any action items due after the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1375450870 or 2013-08-02T13:41:10Z
before Any action items due before the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1438522870 or 2015-08-02T13:41:10Z
updated Any action items updated after the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1438522870 or 2015-08-02T13:41:10Z
assignee member_id (or 0 for unassigned); omit for all
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 , close_ts , -close_ts , due_ts , -due_ts
fields See Field Filtering
format One of the following: xlsx

Sample Request

GET /lucid/api/v1/rooms/74/action_items?format=xlsx
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Content-Disposition: attachment;filename="Engineering Team (action items).xlsx"
Content-Length: 5714
File Content...

Action Items in an Organization

#
GET /lucid/api/v1/organizations/:organization_id/action_items
Query parameter Notes
state One of: any , open , closed
after Any action items due after the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1375450870 or 2013-08-02T13:41:10Z
before Any action items due before the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1438522870 or 2015-08-02T13:41:10Z
updated Any action items updated after the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1438522870 or 2015-08-02T13:41:10Z
assignee member_id (or 0 for unassigned); omit for all
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 , close_ts , -close_ts , due_ts , -due_ts
embed Comma separated list of embeddables: description_clean
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/organizations/50030/action_items?fields=action_item_id,room_id,description,due_ts
Content-Type: application/json; charset=utf-8 
Content-Length: 430 
X-Requestor: jtkeith@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 98
X-Rate-Limit-Used: 1
X-Rate-Limit-Reset: 23
[
  {
    "action_item_id": 600,
    "description": "<p>Send an email to Joey with his start date.<\/p>",
    "room_id": {
      "value": 161,
      "display": "Glance Testing Team"
    },
    "due_ts": null
  },
  {
    "action_item_id": 594,
    "description": "Talk to Sally about the group morale issue",
    "room_id": {
      "value": 74,
      "display": "Engineering Team"
    },
    "due_ts": null
  }
]

Getting a Single Action_Item

#
GET /lucid/api/v1/action_items/:action_item_id
Query parameter Notes
embed Comma separated list of embeddables: description_clean
fields See Field Filtering
envelope See Enveloping

Sample Request

GET /lucid/api/v1/action_items/542
Content-Type: application/json; charset=utf-8 
Content-Length: 620 
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
{
  "action_item_id": 542,
  "state": {
    "value": 0,
    "display": "Open"
  },
  "description": "<p>Verify requirements sign-off<\/p>\n",
  "room_id": {
    "value": 74,
    "display": "Engineering Team"
  },
  "meeting_id": {
    "value": 1103,
    "display": "Testing BC Classic integration"
  },
  "create_id": {
    "value": 1,
    "display": "Bob Smith"
  },
  "update_id": null,
  "member_id": {
    "value": 1,
    "display": "Bob Smith"
  },
  "due_ts": null,
  "close_ts": null,
  "create_ts": {
    "value": 1425574400,
    "iso_8601": "2015-03-05T16:53:20Z"
  },
  "update_ts": {
    "value": 1425574438,
    "iso_8601": "2015-03-05T16:53:58Z"
  }
}

Updating an Action Item via PATCH

#
PATCH /lucid/api/v1/action_items/:action_item_id
Field Required Notes
state no action item state: {state, name}
description no
member_id no assignee: {member_id, name}
due_ts no

Sample Request

PATCH /lucid/api/v1/action_items/542
Content-Type: application/json
{
  "state": 1,
  "description":"Verify requirements sign-off by next Tuesday",
  "due_ts":1461830271,
  "member_id":107
}
200 OK
Content-Type: application/json
{
  "action_item_id": 542,
  "state": {
    "value": 1,
    "display": "Closed"
  },
  "description": "Verify requirements sign-off by next Tuesday",
  "room_id": {
    "value": 74,
    "display": "Engineering Team"
  },
  "meeting_id": {
    "value": 1103,
    "display": "Testing BC Classic integration"
  },
  "create_id": {
    "value": 1,
    "display": "Bob Smith"
  },
  "update_id": {
    "value": 1,
    "display": "Bob Smith"
  },
  "member_id": {
    "value": 107,
    "display": "jtkeith"
  },
  "due_ts": {
    "value": 1461830271,
    "iso_8601": "2016-04-28T07:57:51Z"
  },
  "close_ts": {
    "value": 1461820330,
    "iso_8601": "2016-04-28T05:12:10Z"
  },
  "create_ts": {
    "value": 1425574400,
    "iso_8601": "2015-03-05T16:53:20Z"
  },
  "update_ts": {
    "value": 1461820330,
    "iso_8601": "2016-04-28T05:12:10Z"
  }
}

Creating an Action Item in a Room

#
POST /lucid/api/v1/rooms/:room_id/action_items
Field Required Notes
description yes The description of the action to be completed. The value of this property cannot be empty.
state no The Open or Closed state of this action item. If omitted, the state will be set to Open.
member_id no The system-wide member_id for the person being assigned to this action item. The person must already be a member of the room.
due_ts no The due date for completion of this action item.
close_ts no The date this action item was closed. If omitted and the state is set to Closed, this will be set to the current date.

Sample Request

POST /lucid/api/v1/rooms/74/action_items
Content-Type: application/json
{
  "description": "<p>Buy coffee for the team</p>",
  "member_id":105,
  "state": 1
}
201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/rooms/74/action_items/593
Content-Type: application/json
{
  "action_item_id": 593,
  "state": {
    "value": 1,
    "display": "Closed"
  },
  "description": "<p>Buy coffee for the team<\/p>",
  "room_id": {
    "value": 74,
    "display": "Engineering Team"
  },
  "meeting_id": null,
  "create_id": {
    "value": 1,
    "display": "Bob Smith"
  },
  "update_id": null,
  "member_id": {
    "value": 105,
    "display": "Jack Bronson"
  },
  "due_ts": null,
  "close_ts": {
    "value": 1462026526,
    "iso_8601": "2016-04-30T14:28:46Z"
  },
  "create_ts": {
    "value": 1462026526,
    "iso_8601": "2016-04-30T14:28:46Z"
  },
  "update_ts": {
    "value": 1462026526,
    "iso_8601": "2016-04-30T14:28:46Z"
  }
}

Creating an Action Item in a Meeting

#

Note: action items are added to the first agenda item.

POST /lucid/api/v1/meetings/:meeting_id/action_items
Field Required Notes
description yes The description of the action to be completed. The value of this property cannot be empty.
state no The Open or Closed state of this action item. If omitted, the state will be set to Open.
member_id no The system-wide member_id for the person being assigned to this action item. The person must already be a member of the room.
due_ts no The due date for completion of this action item.
close_ts no The date this action item was closed. If omitted and the state is set to Closed, this will be set to the current date.

Sample Request

POST /lucid/api/v1/meetings/1476/action_items
Content-Type: application/json
{
  "description":"Talk to Sally about the group morale issue",
  "member_id":1
}
201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/meetings/1476/action_items/595
Content-Type: application/json
{
  "action_item_id": 595,
  "state": {
    "value": 0,
    "display": "Open"
  },
  "description": "Talk to Sally about the group morale issue",
  "room_id": {
    "value": 74,
    "display": "Engineering Team"
  },
  "meeting_id": {
    "value": 1476,
    "display": "Team Meeting"
  },
  "create_id": {
    "value": 1,
    "display": "Bob Smith"
  },
  "update_id": null,
  "member_id": {
    "value": 1,
    "display": "Bob Smith"
  },
  "due_ts": null,
  "close_ts": null,
  "create_ts": {
    "value": 1462053729,
    "iso_8601": "2016-04-30T22:02:09Z"
  },
  "update_ts": {
    "value": 1462053729,
    "iso_8601": "2016-04-30T22:02:09Z"
  }
}

Deleting an Action Item

#

This method requires the API caller to have manager permissions for the room containing the action item.

DELETE /lucid/api/v1/action_item/:action_item_id

Sample Request

DELETE /lucid/api/v1/action_items/542


204 No Content