Meetings
Returns a paginated list of meetings. Filter by course using the `courseId` parameter
Returns a paginated list of meetings. Filter by course using the courseId parameter.
GET
https://example.thoughtindustries.com/incoming/v2/meetingsExample request
curl "https://example.thoughtindustries.com/incoming/v2/meetings" \
-H 'Authorization: Bearer YOUR_API_KEY'Parameters
| Name | Type | Required | Location | Description |
|---|---|---|---|---|
cursor | string | No | query | Opaque pagination cursor returned by a previous response; use to fetch the next page of results. |
courseId | uuid | No | query | Filters results to meetings belonging to the specified course. |
Example response
{
"pageInfo": {
"total": 0,
"cursor": "string",
"hasMore": true
},
"meetings": [
{
"id": "00000000-0000-0000-0000-000000000000",
"title": "string",
"course": {
"id": "00000000-0000-0000-0000-000000000000",
"title": "string"
},
"location": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string"
},
"instructors": [
"string"
],
"joinUrl": "string",
"attendeeInfo": "string",
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2024-01-01T00:00:00.000Z"
}
]
}Response fields
| Field | Type | Description |
|---|---|---|
pageInfo | CursorPageInfo | Pagination metadata for the current result set. |
pageInfo.total | integer | Total number of meetings across all pages. |
pageInfo.cursor | string | Opaque cursor to pass in the next request to retrieve the following page. |
pageInfo.hasMore | boolean | Indicates whether additional pages of results exist. |
meetings | Meeting[] | Array of meeting objects returned for the current page. |
meetings.id | uuid | Unique identifier for the meeting. |
meetings.title | string | Display title of the meeting. |
meetings.course | Course | Course this meeting belongs to. |
meetings.course.id | uuid | Unique identifier of the course. |
meetings.course.title | string | Title of the course. |
meetings.location | Location | Physical location of the meeting. |
meetings.location.id | uuid | Unique identifier of the location. |
meetings.location.name | string | Name of the location. |
meetings.instructors | string[] | List of instructor names assigned to the meeting. |
meetings.joinUrl | string | URL attendees use to join the meeting. |
meetings.attendeeInfo | string | Additional instructions or notes displayed to meeting attendees. |
meetings.startDate | ISO 8601 timestamp | Date and time the meeting begins, in ISO 8601 format. |
meetings.endDate | ISO 8601 timestamp | Date and time the meeting ends, in ISO 8601 format. |