Lucid Meetings REST API

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

Resource: Invitees

The invitees resource describes the relationship between Lucid members and the meeting_series in which they participate. Each resource defines a typed association that includes the member's role in the specific meeting series. Invitees for a meeting series identify members who will be added by default to meetings in the series.

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

Properties

#

Field	Type	Notes
invitee_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 series
note_taker	boolean	Can this invitee take shared notes during the meeting
presenter	boolean	Can this invitee upload and present documents
role_id	tuple	role: {role_id, name}
rsvp	tuple	rsvp: {rsvp, name}
meeting_series_id	tuple	meeting: {meeting_series_id, name}
create_ts	timestamp
update_ts	timestamp

Listing Invitees

#

GET /lucid/api/v1/meeting_series/:meeting_series_id/invitees

Query parameter	Notes
fields	See Field Filtering
envelope	See Enveloping

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

GET /lucid/api/v1/meeting_series/:meeting_series_id/facilitators
GET /lucid/api/v1/meeting_series/:meeting_series_id/participants
GET /lucid/api/v1/meeting_series/:meeting_series_id/observers
GET /lucid/api/v1/meeting_series/:meeting_series_id/guests

Sample Request

GET /lucid/api/v1/meeting_series/1214/invitees?fields=member_id,member_name,invitee_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

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

Exporting Invitees

#

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

GET /lucid/api/v1/meeting_series/:meeting_series_id/invitees

Query parameter	Notes
format	One of the following: xlsx

Sample Request

GET /lucid/api/v1/meeting_series/1819/invitees?format=xlsx

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

File Content...

Getting a Single Invitee

#

GET /lucid/api/v1/invitees/:invitee_id

Query parameter	Notes
fields	See Field Filtering
envelope	See Enveloping

Sample Request

GET /lucid/api/v1/invitees/850

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

{
    "id": 850,
    "resource_url": "https:\/\/dev.lucidmeetings.com\/lucid\/api\/v1\/meeting_series\/500\/invitees\/850",
    "invitee_id": 850,
    "representing": null,
    "note_taker": true,
    "presenter": false,
    "member_id": 540,
    "member_name": "Alice Jones",
    "member_email": "ajones@example.org",
    "meeting_series_id": {
        "value": 500,
        "display": "Meeting"
    },
    "role_id": {
        "value": 3,
        "display": "Participant"
    },
    "rsvp": {
        "value": 0,
        "display": "None Yet"
    },
    "create_ts": {
        "value": 1571703980,
        "iso_8601": "2019-10-22T00:26:20Z",
        "pretty": {
            "time": "5:26 PM",
            "date": "October 21, 2019",
            "timezone": "Los Angeles"
        }
    },
    "update_ts": {
        "value": 1571703980,
        "iso_8601": "2019-10-22T00:26:20Z",
        "pretty": {
            "time": "5:26 PM",
            "date": "October 21, 2019",
            "timezone": "Los Angeles"
        }
    }
}

Updating an Invitee via PATCH

#

PATCH /lucid/api/v1/invitees/:invitee_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 meeting series
role_id	no	The role of this member in this meeting series
rsvp	no	The RSVP status of this member in this meeting series.
note_taker	no	Can this invitee take shared notes during meetings in this series
presenter	no	Can this invitee upload and present documents

Sample Request

PATCH /lucid/api/v1/meeting_series/1475/invitees/899
Content-Type: application/json

{
  "representing": "Customer Support",
  "rsvp": 1,
  "role_id": 2
}

200 OK
Content-Type: application/json

{
    "invitee_id": 899,
    "representing": "Customer Support",
    "note_taker": true,
    "presenter": true,
    "member_id": 540,
    "member_name": "Alice Jjones",
    "member_email": "alice.jjones@example.org",
    "meeting_series_id": {
        "value": 594,
        "display": "Recurrence testing, PATCH individual meeting"
    },
    "role_id": {
        "value": 2,
        "display": "Facilitator"
    },
    "rsvp": {
        "value": 1,
        "display": "Yes"
    }
}

Creating a New Invitee From a Room Member

#

Invitees are always created in a specific meeting series context. This allows the creation function to inherit the default permissions for different types of invitees: facilitators, participants, observers, and guests. The invitee is added to future meetings in the series.

POST /lucid/api/v1/meeting_series/:meeting_series_id/invitees

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

POST /lucid/api/v1/meeting_series/:meeting_series_id/facilitators
POST /lucid/api/v1/meeting_series/:meeting_series_id/participants
POST /lucid/api/v1/meeting_series/:meeting_series_id/observers
POST /lucid/api/v1/meeting_series/:meeting_series_id/guests

Field	Required	Notes
member_id	yes	The system-wide member_id for the person being added as an invitee. 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 series. If omitted, the invitee will be assigned their Company field value.
role_id	no	The role of this invitee in this specific meeting series. If omitted, the invitee 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 series. If omitted, the invitee will be assigned a value of "None Yet".
note_taker	no	Can this invitee take shared notes during the meeting
presenter	no	Can this invitee upload and present documents

Sample Request

POST /lucid/api/v1/meeting_series/581/invitees
Content-Type: application/json

{
  "member_id": 540,
  "role_id": 3,
  "note_taker": true,
  "presenter": true,
  "representing": "Bits and Bobs, Ltd."
}

201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/meeting_series/581/invitees/877
Content-Type: application/json

{
    "id": 877,
    "resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meeting_series/581/invitees/877",
    "invitee_id": 877,
    "representing": "Bits and Bobs, Ltd.",
    "note_taker": true,
    "presenter": true,
    "member_id": 540,
    "member_name": "Alice Jones",
    "member_email": "ajones@example.org",
    "meeting_series_id": {
        "value": 581,
        "display": "Meeting Series from API"
    },
    "role_id": {
        "value": 3,
        "display": "Participant"
    },
    "rsvp": {
        "value": 0,
        "display": "None Yet"
    },
    "create_ts": {
        "value": 1572909954,
        "iso_8601": "2019-11-04T23:25:54Z",
        "pretty": {
            "time": "3:25 PM",
            "date": "November 4, 2019",
            "timezone": "Los Angeles"
        }
    },
    "update_ts": {
        "value": 1572909954,
        "iso_8601": "2019-11-04T23:25:54Z",
        "pretty": {
            "time": "3:25 PM",
            "date": "November 4, 2019",
            "timezone": "Los Angeles"
        }
    }
}

Creating a New Invitee From an Email Address

#

Invitees 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. The invitee is added to future meetings in the series.

POST /lucid/api/v1/meeting_series/:meeting_series_id/invitees

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

POST /lucid/api/v1/meeting_series/:meeting_series_id/facilitators
POST /lucid/api/v1/meeting_series/:meeting_series_id/participants
POST /lucid/api/v1/meeting_series/:meeting_series_id/observers
POST /lucid/api/v1/meeting_series/:meeting_series_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 series. If omitted, the invitee will be assigned their Company field value.
role_id	no	The role of this member in this specific meeting series. If omitted, the invitee will be assigned a default GUEST invitee role or a role based on the specific sub-collection.
rsvp	no	The RSVP status of this member in this specific meeting series. If omitted, the invitee will be assigned a value of "None Yet".

Sample Request

POST /lucid/api/v1/meeting_series/1475/invitees
Content-Type: application/json

{
    "email": "bobsmithesq@example.com",
    "role_id": 3,
    "note_taker": true,
    "presenter": true,
    "first_name": "Bob",
    "last_name": "Smith"
}

201 Created
Location: https://site.lucidmeetings.com/lucid/api/v1/meeting_series/581/invitees/878
Content-Type: application/json

{
    "id": 878,
    "resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meeting_series/581/invitees/878",
    "invitee_id": 878,
    "representing": null,
    "note_taker": true,
    "presenter": true,
    "member_id": 551,
    "member_name": "Bob Smith",
    "member_email": "bobsmithesq@example.com",
    "meeting_series_id": {
        "value": 581,
        "display": "Meeting Series from API"
    },
    "role_id": {
        "value": 3,
        "display": "Participant"
    },
    "rsvp": {
        "value": 0,
        "display": "None Yet"
    },
    "create_ts": {
        "value": 1572911321,
        "iso_8601": "2019-11-04T23:48:41Z",
        "pretty": {
            "time": "3:48 PM",
            "date": "November 4, 2019",
            "timezone": "Los Angeles"
        }
    },
    "update_ts": {
        "value": 1572911322,
        "iso_8601": "2019-11-04T23:48:42Z",
        "pretty": {
            "time": "3:48 PM",
            "date": "November 4, 2019",
            "timezone": "Los Angeles"
        }
    }
}

Deleting an Invitee

#

Deleting an invitee automatically removes that person as an attendee from future meetings (but not from past ones).

DELETE /lucid/api/v1/invitees/:invitee_id

Sample Request

DELETE /lucid/api/v1/invitees/2441

204 No Content