Lucid Meetings REST API

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

Resource: Attendees

The attendees resource describes the relationship between Lucid members and the meetings in which they participate. Each resource defines a typed association that includes the member's role in the specific meeting.

• Properties
• Listing Attendees
• Exporting Attendees
• Getting a Single Attendee
• Updating an Attendee via PATCH
• Creating a New Attendee From a Room Member
• Creating a New Attendee From an Email Address
• Deleting an Attendee

Properties

#

Field	Type	Notes
attendee_id	integer
member_id	integer
member_name	plain text
member_email	email address
representing	plain text (64)	The company or organization this person represents in this specific meeting
attended	boolean	Did this invitee actually attend this meeting
note_taker	boolean	Can this attendee take shared notes during the meeting
presenter	boolean	Can this attendee upload and present documents
role_id	tuple	role: {role_id, name}
rsvp	tuple	rsvp: {rsvp, name}
meeting_id	tuple	meeting: {meeting_id, name}
create_ts	timestamp
update_ts	timestamp

Listing Attendees

#

GET /lucid/api/v1/meetings/:meeting_id/attendees

Query parameter	Notes
fields	See Field Filtering
envelope	See Enveloping

The Lucid Meetings API also provides subsets of attendees via the following collections.

GET /lucid/api/v1/meetings/:meeting_id/facilitators
GET /lucid/api/v1/meetings/:meeting_id/participants
GET /lucid/api/v1/meetings/:meeting_id/observers
GET /lucid/api/v1/meetings/:meeting_id/guests

Sample Request

GET /lucid/api/v1/meetings/1214/attendees?fields=member_id,member_name,attendee_id,rsvp

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

[
  {
    "attendee_id": 1952,
    "member_id": 1,
    "member_name": "Bob Smith",
    "rsvp": {
      "value": 1,
      "display": "Yes"
    }
  }
]

Exporting Attendees

#

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

GET /lucid/api/v1/meetings/:meeting_id/attendees

Query parameter	Notes
format	One of the following: xlsx

Sample Request

GET /lucid/api/v1/meetings/1819/attendees?format=xlsx

Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Content-Disposition: attachment;filename="Staff meeting 2018-01-07 (attendees).xlsx"
Content-Length: 4833

File Content...

Getting a Single Attendee

#

GET /lucid/api/v1/attendees/:attendee_id

Query parameter	Notes
fields	See Field Filtering
envelope	See Enveloping

Sample Request

GET /lucid/api/v1/attendees/1952

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

{
  "attendee_id": 1952,
  "member_id": 1,
  "member_name": "Bob Smith",
  "member_email": "bsmith@example.com",
  "representing": "Turing Machines",
  "attended": false,
  "note_taker": true,
  "presenter": false,
  "role_id": {
    "value": 2,
    "display": "Facilitator"
  },
  "rsvp": {
    "value": 1,
    "display": "Yes"
  },
  "meeting_id": {
    "value": 1214,
    "display": "Meeting"
  },
  "create_ts": {
    "value": 1438712059,
    "iso_8601": "2015-08-04T18:14:19Z"
  },
  "update_ts": {
    "value": 1438712059,
    "iso_8601": "2015-08-04T18:14:19Z"
  }
}

Updating an Attendee via PATCH

#

PATCH /lucid/api/v1/attendees/:attendee_id

Field	Required	Notes
email	no	Member: The email address of the person
first_name	no	Member: The first name of this person
last_name	no	Member: The last name of this person
company	no	Member: The company this person represents
title	no	Member: The company or job title of this person
representing	no	The company or organization this person represents in this specific meeting
role_id	no	The role of this member in this specific meeting
rsvp	no	The RSVP status of this member in this specific meeting. If omitted, the attendee will be assigned a value of "None Yet".
attended	no	Did this invitee actually attend this meeting
note_taker	no	Can this attendee take shared notes during the meeting
presenter	no	Can this attendee upload and present documents

Sample Request

PATCH /lucid/api/v1/meetings/1475/attendees/2439
Content-Type: application/json

{
  "first_name":"Fran",
  "last_name": "Ocelot",
  "role_id":3,
  "rsvp": 2,
  "representing":"My company"
}

200 OK
Content-Type: application/json

{
  "attendee_id": 2439,
  "member_id": 106,
  "member_name": "George Featherstone",
  "member_email": "george.featherstone@example.com",
  "representing": "My company",
  "attended": false,
  "note_taker": true,
  "presenter": false,
  "role_id": {
    "value": 3,
    "display": "Participant"
  },
  "rsvp": {
    "value": 2,
    "display": "No"
  },
  "meeting_id": {
    "value": 1475,
    "display": "Monthly project review"
  },
  "create_ts": {
    "value": 1461273647,
    "iso_8601": "2016-04-21T21:20:47Z"
  },
  "update_ts": {
    "value": 1461711018,
    "iso_8601": "2016-04-26T22:50:18Z"
  }
}

Creating a New Attendee From a Room Member

#

Attendees are always created in a specific meeting context. This allows the creation function to inherit the default permissions for different types of attendees: facilitators, participants, observers, and guests.

POST /lucid/api/v1/meetings/:meeting_id/attendees

The Lucid Meetings API also provides the ability to POST directly to aliased sub-collections of attendees. This is mostly a convenience function that sets the attendee's meeting role implicitly via the sub-collection purpose.

POST /lucid/api/v1/meetings/:meeting_id/facilitators
POST /lucid/api/v1/meetings/:meeting_id/participants
POST /lucid/api/v1/meetings/:meeting_id/observers
POST /lucid/api/v1/meetings/:meeting_id/guests

Field	Required	Notes
member_id	yes	The system-wide member_id for the person being added as an attendee. This person must already be listed as a room member for the meeting's associated room.
representing	no	The company or organization this person represents in this specific meeting. If omitted, the attendee will be assigned their Company field value.
role_id	no	The role of this attendee in this specific meeting. If omitted, the attendee will be assigned a default role based on the person's room role or on the specific sub-collection.
rsvp	no	The RSVP status of this member in this specific meeting. If omitted, the attendee will be assigned a value of "None Yet".
attended	no	Did this invitee actually attend this meeting
note_taker	no	Can this attendee take shared notes during the meeting
presenter	no	Can this attendee upload and present documents

Sample Request

POST /lucid/api/v1/meetings/1475/attendees
Content-Type: application/json

{
  "member_id": 60,
  "role_id": 3
}

201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/meetings/1475/attendees/2443
Content-Type: application/json

{
  "attendee_id": 2443,
  "member_id": 60,
  "member_name": "Fred Keith",
  "member_email": "fred@example.com",
  "attended": false,
  "note_taker": true,
  "presenter": false,
  "role_id": {
    "value": 3,
    "display": "Participant"
  },
  "rsvp": {
    "value": 0,
    "display": "None Yet"
  },
  "meeting_id": {
    "value": 1475,
    "display": "Meeting"
  },
  "create_ts": {
    "value": 1461274299,
    "iso_8601": "2016-04-21T21:31:39Z"
  },
  "update_ts": {
    "value": 1461274299,
    "iso_8601": "2016-04-21T21:31:39Z"
  }
}

Creating a New Attendee From an Email Address

#

Attendees may also be created based on their email address. This will either use or create a system-wide member account for the person, then add them to the meeting with the specified role. This is most commonly used when adding per-meeting guests, but can be used generally as well.

POST /lucid/api/v1/meetings/:meeting_id/attendees

The Lucid Meetings API also provides the ability to POST directly to aliased sub-collections of attendees. This is mostly a convenience function that sets the attendee's meeting role implicitly via the sub-collection purpose.

POST /lucid/api/v1/meetings/:meeting_id/facilitators
POST /lucid/api/v1/meetings/:meeting_id/participants
POST /lucid/api/v1/meetings/:meeting_id/observers
POST /lucid/api/v1/meetings/:meeting_id/guests

Field	Required	Notes
email	yes	Member: The email address of the person to either find or create
first_name	no	Member: The first name of this new person
last_name	no	Member: The last name of this new person
company	no	Member: The company this new person represents
title	no	Member: The company or job title of this new person
representing	no	The company or organization this person represents in this specific meeting. If omitted, the attendee will be assigned their Company field value.
role_id	no	The role of this member in this specific meeting. If omitted, the attendee will be assigned a default GUEST attendee role or a role based on the specific sub-collection.
rsvp	no	The RSVP status of this member in this specific meeting. If omitted, the attendee will be assigned a value of "None Yet".

Sample Request

POST /lucid/api/v1/meetings/1475/attendees
Content-Type: application/json

{
  "email": "fred@example.com",
  "first_name": "Fred",
  "last_name": "Keith",
  "role_id": 3
}

201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/meetings/1475/attendees/2443
Content-Type: application/json

{
  "attendee_id": 2443,
  "member_id": 60,
  "member_name": "Fred Keith",
  "member_email": "fred@example.com",
  "attended": false,
  "note_taker": true,
  "presenter": false,
  "role_id": {
    "value": 3,
    "display": "Participant"
  },
  "rsvp": {
    "value": 0,
    "display": "None Yet"
  },
  "meeting_id": {
    "value": 1475,
    "display": "Meeting"
  },
  "create_ts": {
    "value": 1461274299,
    "iso_8601": "2016-04-21T21:31:39Z"
  },
  "update_ts": {
    "value": 1461274299,
    "iso_8601": "2016-04-21T21:31:39Z"
  }
}

Deleting an Attendee

#

DELETE /lucid/api/v1/attendees/:attendee_id

Sample Request

DELETE /lucid/api/v1/attendees/2441

204 No Content