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

Resource: Meeting Summaries

Meeting summaries are brief descriptions of scheduled meetings, which can be either actual meeting resources, or placeholders for meetings that will be created later as part of recurring meeting series. They are read-only resources, which can be used to look up meetings.

Typical uses for meeting summaries collections include populating a calendar, and manipulating individual events in a meeting series. To modify an individual event in a meeting series, you can make a request for meeting summaries, then use the appropriate meeting_summary to get the meeting.

Because a Meeting Series may go on indefinitely (no end date), a Meeting Summaries collection is potentially infinite, and some limit must be imposed. Therefore, each request for Meeting Summaries is limited to at most one year (see the after and before parameters).


Properties

#
Field Type Notes
meeting_id integer, null The identifier of the meeting resource summarized by this item.
meeting_series_id integer, null The identifier of the meeting series this item is in, if any.
room_id tuple meeting room: {room_id, name}
state enum One of: pending , started , paused , ended , canceled. See Meeting States.
meeting_url url Network location of the UI for this meeting. This will be populated regardless of whether the meeting_id is present.
resource_url url Network location of the API endpoing for this meeting. This will be populated regardless of whether the meeting_id is present.
name plain text (255)
start_time timestamp
end_time timestamp

Getting a List of My Meeting Summaries

# 
GET /lucid/api/v1/meeting_summaries (must be logged in)
Query parameter Notes
after Summarize meetings scheduled after the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1375450870 or 2013-08-02T13:41:10Z
Default: For my meeting summaries or a room's meeting summaries, the current time ("now"). For a meeting series' meeting summaries, the start time of the first meeting in the meeting series.
before Summarize meetings scheduled before the specified time (should be in UTC and either timestamp or ISO8601 formatted) eg: 1438522870 or 2015-08-02T13:41:10Z
Default: after plus 365 days.
page Page number, starting from 0
per_page Any integer between 0 and 100, inclusive.
Default: 10.
sort One of: start_time , -start_time

Sample Request

GET /lucid/api/v1/meeting_summaries?fields=name,meeting_id,meeting_series_id,meeting_url,resource_url,start_time,end_time&before=2019-11-30&per_page=2

Content-Type: application/json; charset=utf-8
Content-Length: 1646
X-Requestor: afarrell@lucidmeetings.com
X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 98
X-Rate-Limit-Used: 2
X-Rate-Limit-Reset: 60
X-Total-Count: 60
X-Total-Pages: 30
X-Page-Num: 0
X-Per-Page: 2
Link: <https://site.lucidmeetings.com/lucid/api/v1/meeting_summaries?fields=name%2Cmeeting_id%2Cmeeting_series_id%2Cmeeting_url%2Cresource_url%2Cstart_time%2Cend_time&before=1575100800&per_page=2&after=1572481074&sort=ASC&embed=&page=1&z=>; rel="next"

[
    {
        "meeting_id": 5782,
        "meeting_series_id": null,
        "meeting_url": "https://site.lucidmeetings.com/meeting/5782",
        "resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meetings/5782",
        "name": "Project X Review",
        "start_time": {
            "value": 1572480000,
            "iso_8601": "2019-10-31T00:00:00Z",
            "pretty": {
                "time": "5 PM",
                "date": "October 30, 2019",
                "timezone": "Los Angeles"
            }
        },
        "end_time": {
            "value": 1572483300,
            "iso_8601": "2019-10-31T00:55:00Z",
            "pretty": {
                "time": "5:55 PM",
                "date": "October 30, 2019",
                "timezone": "Los Angeles"
            }
        }
    },
    {
        "meeting_id": null,
        "meeting_series_id": 559,
        "meeting_url": "https://site.lucidmeetings.com/meeting_series/559/meeting/1572566400",
        "resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meeting_series/559/meeting_at/1572566400",
        "name": "Recurrence schedule testing",
        "start_time": {
            "value": 1572566400,
            "iso_8601": "2019-11-01T00:00:00Z",
            "pretty": {
                "time": "5 PM",
                "date": "October 31, 2019",
                "timezone": "Los Angeles"
            }
        },
        "end_time": {
            "value": 1572569700,
            "iso_8601": "2019-11-01T00:55:00Z",
            "pretty": {
                "time": "5:55 PM",
                "date": "October 31, 2019",
                "timezone": "Los Angeles"
            }
        }
    }
]

Getting a List of Meeting Summaries in a Room

#

Sample Request

GET /lucid/api/v1/rooms/133/meeting_summaries?fields=name,start_time&before=2019-11-30&per_page=2

X-Total-Count: 5
X-Total-Pages: 2
X-Page-Num: 0
X-Per-Page: 2

[
    {
        "name": "Team check-in",
        "start_time": {
            "value": 1572627600,
            "iso_8601": "2019-11-01T17:00:00Z",
            "pretty": {
                "time": "10 AM",
                "date": "November 1, 2019",
                "timezone": "Los Angeles"
            }
        }
    },
    {
        "name": "Team check-in",
        "start_time": {
            "value": 1572627600,
            "iso_8601": "2019-11-01T17:00:00Z",
            "pretty": {
                "time": "10 AM",
                "date": "November 1, 2019",
                "timezone": "Los Angeles"
            }
        }
    }
]

Getting a List of Meeting Summaries in a Meeting Series

#

The response in this example shows one meeting summary for a meeting that has already been created, followed by one that has not. Note the null meeting_id in the second meeting summary and the different formats of the meeting_url and resource_url in the two meeting summaries. To create the meeting and get the meeting_id for the second meeting summary, see the next section, Getting a Meeting for a Meeting Summary.

Sample Request

GET /lucid/api/v1/meeting_series/559/meeting_summaries?fields=meeting_id,resource_url,name,start_time&before=2019-11-30&per_page=2

X-Total-Count: 5
X-Total-Pages: 2
X-Page-Num: 0
X-Per-Page: 2

[
    {
        "meeting_id": 5746,
        "meeting_series_id": 559,
        "meeting_url": "https://site.lucidmeetings.com/meeting/5746",
        "resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meetings/5746",
        "name": "Recurrence schedule testing",
        "start_time": {
            "value": 1572566400,
            "iso_8601": "2019-11-01T00:00:00Z",
            "pretty": {
                "time": "5 PM",
                "date": "October 31, 2019",
                "timezone": "Los Angeles"
            }
        },
        "end_time": {
            "value": 1572569700,
            "iso_8601": "2019-11-01T00:55:00Z",
            "pretty": {
                "time": "5:55 PM",
                "date": "October 31, 2019",
                "timezone": "Los Angeles"
            }
        }
    },
    {
        "meeting_id": null,
        "meeting_series_id": 559,
        "meeting_url": "https://site.lucidmeetings.com/meeting_series/559/1573174800",
        "resource_url": "https://site.lucidmeetings.com/lucid/api/v1/meeting_series/559/meeting_at/1573174800",
        "name": "Recurrence schedule testing",
        "start_time": {
            "value": 1573174800,
            "iso_8601": "2019-11-08T01:00:00Z",
            "pretty": {
                "time": "5 PM",
                "date": "November 7, 2019",
                "timezone": "Los Angeles"
            }
        },
        "end_time": {
            "value": 1573178100,
            "iso_8601": "2019-11-08T01:55:00Z",
            "pretty": {
                "time": "5:55 PM",
                "date": "November 7, 2019",
                "timezone": "Los Angeles"
            }
        }
    }
]

Getting a Meeting for a Meeting Summary

#

Meetings in a meeting series are generated when needed; typically a few days before the meeting will be held, or when a Lucid user accesses the meeting home. The meeting_url in a meeting summary identifies the meeting home page.

If the meeting_id is non-null, the resource_url is the URL of a meeting resource. If the meeting_id is null, the resource_url is an endpoint that will return a meeting resource for the specified entry in the meeting series, creating the meeting if necessary. The example output above shows both types of meeting summary. 

GET /lucid/api/v1/meeting_series/559/meeting_at/1573174800?fields=meeting_id,name,start_time

X-Rate-Limit-Limit: 100
X-Rate-Limit-Remaining: 97
X-Rate-Limit-Reset: 19
X-Rate-Limit-Used: 1

{
    "meeting_id": 5796,
    "name": "Recurrence schedule testing",
    "start_time": {
        "value": 1573174800,
        "iso_8601": "2019-11-08T01:00:00Z",
        "pretty": {
            "time": "5 PM",
            "date": "November 7, 2019",
            "timezone": "Los Angeles"
        }
    }
}