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 |
|---|---|---|---|---|
page | integer | No | query | Page number to retrieve in the paginated result set. |
courseId | uuid | No | query | Filters results to meetings belonging to the specified course. |
Example response
{
"data": {
"Meetings": {
"pageInfo": {
"perPage": 0,
"currentPage": 0,
"total": 0,
"hasMore": true
},
"aggregations": [
{
"key": "string",
"label": "string",
"buckets": [
{
"query": "string",
"value": "string",
"label": "string",
"description": "string",
"count": 0
}
]
}
],
"meetings": [
{
"id": "00000000-0000-0000-0000-000000000000",
"title": "string",
"courseId": "00000000-0000-0000-0000-000000000000",
"course": {
"id": "00000000-0000-0000-0000-000000000000",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"slug": "example-slug",
"status": "draft",
"title": "string",
"sessionIsTitled": true,
"sampleLesson": {
"...": "..."
},
"sampleLessonId": "00000000-0000-0000-0000-000000000000",
"sections": [
{
"...": "..."
}
],
"appearanceBlock": "00000000-0000-0000-0000-000000000000",
"appearanceHash": "string",
"paywallsBlock": "00000000-0000-0000-0000-000000000000",
"termsBlock": "00000000-0000-0000-0000-000000000000",
"confirmationBlock": "00000000-0000-0000-0000-000000000000",
"courseStartDate": "2024-01-01T00:00:00.000Z",
"courseEndDate": "2024-01-01T00:00:00.000Z",
"enrollmentStartDate": "2024-01-01T00:00:00.000Z",
"enrollmentEndDate": "2024-01-01T00:00:00.000Z",
"gracePeriodEndDate": "2024-01-01T00:00:00.000Z",
"seatsLimit": 0,
"waitlistCount": 0,
"seatsLimitMet": true,
"waitlistingEnabled": true,
"waitlistingTriggered": true,
"taxable": true,
"purchasable": true,
"taxCategory": "00000000-0000-0000-0000-000000000000",
"fulfillmentCenter": "00000000-0000-0000-0000-000000000000",
"courseGroup": {
"...": "..."
},
"syllabusTitlesEnabled": true,
"galleryEnabled": true,
"workbookEnabled": true,
"linkedWorkbookEnabled": true,
"linkedWorkbookSkipEnabled": true,
"superquizEnabled": true,
"discussionsEnabled": true,
"resourcesEnabled": true,
"meetingsOverviewEnabled": true,
"recurrenceRule": "string",
"recurrence": {},
"readableRecurrenceString": "string",
"instructorAccessEnabled": true,
"instructorEmails": [
"string"
],
"freeWithRegistration": true,
"priceInCents": 0,
"instructorAccessPriceInCents": 0,
"suggestedRetailPriceInCents": 0,
"alternativePricingType": "membership",
"alternativePricingRef": 0,
"accessDays": 0,
"showProgress": true,
"annotationsEnabled": true,
"forceLinearProgress": true,
"completionTimePerPage": 0,
"askLearnerPassword": true,
"roster": true,
"topicGroupId": "00000000-0000-0000-0000-000000000000",
"sku": "string",
"prerequisiteCourses": [
{
"...": "..."
}
],
"prerequisiteLearningPaths": [
{
"...": "..."
}
],
"parentCourseId": "00000000-0000-0000-0000-000000000000",
"isChild": true,
"hasMultipleCurrencies": true,
"prices": [
{
"...": "..."
}
],
"enrollmentActive": true,
"waitlistActive": true,
"webinarDates": [
{
"...": "..."
}
],
"webinarTimeZone": "string",
"meetings": [
{
"...": "..."
}
],
"inPersonEventInfo": {
"...": "..."
},
"currentUserHasAccess": true,
"location": {
"...": "..."
},
"displayMap": true,
"publishDate": "2024-01-01T00:00:00.000Z",
"isActive": true,
"futurePublishDate": "2024-01-01T00:00:00.000Z",
"balanceRequirement": 0,
"awardClaimingOptions": [
{
"...": "..."
}
],
"availabilityStatus": "string",
"embeddedEnabled": true,
"displayResults": true,
"bulkPurchasingEnabled": true,
"seatTiers": [
{
"...": "..."
}
],
"seatPackages": [
{
"...": "..."
}
],
"lastTierPriceInCents": 0,
"webinarId": "string",
"hasChildren": true,
"customFields": {},
"kind": "microCourse",
"rosterSubmittedDate": "2024-01-01T00:00:00.000Z",
"finalAssessment": "string",
"scormCollectUserDetails": true,
"seatsUsedCount": 0,
"seatsAllocatedCount": 0,
"webinarDetails": {
"...": "..."
},
"showSyllabusWhileUnenrolled": true,
"topicGroup": {
"...": "..."
},
"courseGroupTitle": "string",
"currentUserDueDate": "2024-01-01T00:00:00.000Z"
},
"locationId": "00000000-0000-0000-0000-000000000000",
"location": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"room": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"country": "string",
"timeZone": "string"
},
"joinUrl": "string",
"attendeeInfo": "string",
"instructors": [
"string"
],
"startDate": "2024-01-01T00:00:00.000Z",
"endDate": "2024-01-01T00:00:00.000Z",
"timeZone": "string",
"attendees": [
{
"id": "00000000-0000-0000-0000-000000000000",
"email": "string",
"firstName": "string",
"abbreviatedName": "string",
"asset": "string",
"lastName": "string",
"name": "string",
"lastActiveAt": "2024-01-01T00:00:00.000Z",
"bio": "string",
"twoFactorEnabled": true,
"firstInitial": "string",
"lastInitial": "string",
"invitedByName": "string",
"shouldHighlight": true,
"purchasedCourses": [
{
"...": "..."
}
],
"purchasedBundles": [
{
"...": "..."
}
],
"activeLicense": {
"...": "..."
},
"allocatedLicenses": [
{
"...": "..."
}
],
"allocatedLearningPaths": [
{
"...": "..."
}
],
"attendedMeetings": [
{
"...": "..."
}
],
"waitlistedCourses": [
{
"...": "..."
}
],
"adminClients": [
{
"...": "..."
}
],
"roleKey": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"country": "string",
"telephone": "string",
"stripeCustomerId": "00000000-0000-0000-0000-000000000000",
"externalCustomerId": "00000000-0000-0000-0000-000000000000",
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-01T00:00:00.000Z",
"sfAccountId": "00000000-0000-0000-0000-000000000000",
"sfContactId": "00000000-0000-0000-0000-000000000000",
"shippingName": "string",
"client": {
"...": "..."
},
"clientId": "00000000-0000-0000-0000-000000000000",
"ref1": "string",
"ref2": "string",
"ref3": "string",
"ref4": "string",
"ref5": "string",
"ref6": "string",
"ref7": "string",
"ref8": "string",
"ref9": "string",
"ref10": "string",
"lang": "string",
"preferredCurrency": "string",
"customFields": {},
"recommendedTags": [
{
"...": "..."
}
],
"recommendedSlugs": [
{
"...": "..."
}
],
"accessedFlows": [
"string"
],
"disabled": true,
"learnerUserId": "00000000-0000-0000-0000-000000000000",
"managerUserId": "00000000-0000-0000-0000-000000000000",
"balance": 0,
"mustVerifyEmail": true,
"certificatesCount": 0,
"collaborationsCount": 0,
"availableCoursesCount": 0,
"startedCoursesCount": 0,
"completedCoursesCount": 0
}
]
}
]
}
}
}Response fields
| Field | Type | Description |
|---|---|---|
pageInfo | PageInfo | Pagination metadata for the result set. |
pageInfo.perPage | integer | Number of meetings returned per page. |
pageInfo.currentPage | integer | The current page number in the paginated result set. |
pageInfo.total | integer | Total number of meetings across all pages. |
pageInfo.hasMore | boolean | Indicates whether additional pages of results exist. |
aggregations | Aggregation[] | Aggregated facet data for filtering or summarizing the result set. |
aggregations.key | string | Machine-readable identifier for the aggregation facet. |
aggregations.label | string | Human-readable display name for the aggregation facet. |
aggregations.buckets | AggregationBucket[] | Individual filter options within the aggregation facet, each with a count of matching meetings. |
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.courseId | uuid | Unique identifier of the course this meeting belongs to. |
meetings.course | Course | Full course object associated with this meeting. |
meetings.locationId | uuid | Unique identifier of the meeting's physical location. |
meetings.location | Location | Physical location details for the meeting, including address and time zone. |
meetings.joinUrl | string | URL attendees use to join the meeting. |
meetings.attendeeInfo | string | Additional instructions or notes displayed to meeting attendees. |
meetings.instructors | string[] | List of instructor names assigned to the meeting. |
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. |
meetings.timeZone | string | Time zone in which the meeting start and end dates are expressed. |
meetings.attendees | User[] | List of users registered to attend the meeting. |