Do not miss any API changes, ever again

Subscribe to the API changelog to be up to date on recent changes.

RSS
API

3 days ago

main
v1
Compare

API structure has changed

Next change
30 structure changes including:
30 Modifications
Modified 30 Breaking
GET /v1/activities~export
  • Query
  • fromDate[eq], toDate[eq], eventType[eq], eventType[in] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • fromDate, toDate, eventType query parameters Added
GET /v1/channels/{channelId}/spotMembers
  • Query
  • email[in], firstname[in], lastname[in], role[in], registrationDate[before], registrationDate[after] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • email, firstname, lastname, role, registrationDate query parameters Added
GET /v1/collections
  • Query
  • name[eq], name[contains], privacy[eq], privacy[in] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • name, privacy query parameters Added
GET /v1/collections/{collectionId}/documents
  • Query
  • title[eq], title[contains], type[eq], type[in], status[eq], status[in] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • title, type, status query parameters Added
GET /v1/courses
  • Query
  • status[eq], status[in], privacy[eq], privacy[in], moduleName[eq], moduleName[contains] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • status, privacy, moduleName query parameters Added
GET /v1/courses/{courseId}/participants
  • Query
  • firstname[in], lastname[in], email[in], status[eq], status[in] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • firstname, lastname, email, status query parameters Added
GET /v1/courses/{courseId}/participants/{courseParticipantId}/stepCompletions
  • Query
  • completedAt[lt], completedAt[lte], completedAt[gt], completedAt[gte], completedAt[eq], solution[in], solution[eq] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • completedAt, contentType query parameters Added
GET /v1/courses/{courseId}/steps
  • Query
  • title[eq], title[contains], solution[in], solution[eq] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • title, contentType query parameters Added
GET /v1/forums
  • Query
  • name[eq], name[contains] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • name query parameter Added
GET /v1/forums/{forumId}/spotMembers
  • Query
  • email[in], firstname[in], lastname[in], role[in], registrationDate[before], registrationDate[after] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • email, firstname, lastname, role, registrationDate query parameters Added
GET /v1/forums/{forumId}/topics
  • Query
  • name[eq], name[contains] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • name query parameter Added
GET /v1/groups
  • Query
  • name[eq], name[contains] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • name query parameter Added
GET /v1/groups/{groupId}/spotMembers
  • Query
  • email[in], firstname[in], lastname[in], role[in], registrationDate[before], registrationDate[after] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • email, firstname, lastname, role, registrationDate query parameters Added
GET /v1/learningPaths
  • Query
  • privacy[eq], privacy[in] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • privacy query parameter Added
GET /v1/learningPaths/{learningPathId}/participants
  • Query
  • firstname[in], lastname[in], email[in], status[eq], status[in] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • firstname, lastname, email, status query parameters Added
GET /v1/learningPaths/{learningPathId}/participants/{learningPathParticipantId}/stepCompletions
  • Query
  • completedAt[lt], completedAt[lte], completedAt[gt], completedAt[gte], completedAt[eq], contentType[in], contentType[eq] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • completedAt, contentType query parameters Added
GET /v1/learningPaths/{learningPathId}/steps
  • Query
  • contentTitle[eq], contentTitle[contains], contentType[in], contentType[eq] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • contentTitle, contentType query parameters Added
GET /v1/lives
  • Query
  • title[eq], title[contains], status[eq], startDate[lt], startDate[lte], startDate[gt], startDate[gte], startDate[eq], solution[in], solution[eq], replay[eq], builtInType[in], builtInType[eq], averageViewTime[lt], averageViewTime[lte], averageViewTime[gt], averageViewTime[gte], averageViewTime[eq], invited[lt], invited[lte], invited[gt], invited[gte], invited[eq], registrant[lt], registrant[lte], registrant[gt], registrant[gte], registrant[eq], attendee[lt], attendee[lte], attendee[gt], attendee[gte], attendee[eq], attendanceRate[lt], attendanceRate[lte], attendanceRate[gt], attendanceRate[gte], attendanceRate[eq], totalReplayView[lt], totalReplayView[lte], totalReplayView[gt], totalReplayView[gte], totalReplayView[eq] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • title, status, startDate, solution, replay, builtInType, averageViewTime, invited, registrant, attendee, attendanceRate, totalReplayView query parameters Added
GET /v1/lives/{liveId}/participants
  • Query
  • firstname[eq], firstname[contains], lastname[eq], lastname[contains], email[eq], email[contains], type[eq], type[in], status[eq], status[in], hasReplayed[eq], hasParticipated[eq] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • firstname, lastname, email, type, status, hasReplayed, hasParticipated query parameters Added
GET /v1/lives/{liveId}/speakers
  • Query
  • firstname[eq], firstname[contains], lastname[eq], lastname[contains], email[eq], email[contains], status[eq], status[in], hasReplayed[eq], hasParticipated[eq] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • firstname, lastname, email, status, hasReplayed, hasParticipated query parameters Added
GET /v1/reportedResources
  • Query
  • status[in], reason[in], creationDate[before], creationDate[after] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • status, lastReportReason, creationDate query parameters Added
GET /v1/reportedResources/{reportedResourceId}/reports
  • Query
  • status[in], reason[in], creationDate[before], creationDate[after] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • status, reason, creationDate query parameters Added
GET /v1/search
  • Query
  • searchableTypes[in] query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • searchableTypes query parameter Added
GET /v1/spotMemberCustomRole
  • Query
  • label[eq], label[contains], label[in] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • label query parameter Added
GET /v1/spotMembers
  • Query
  • email[in], firstname[in], lastname[in], role[in], customRoleId[eq], status[in], invitationDate[before], invitationDate[after], registrationDate[before], registrationDate[after], updatedAt[before], updatedAt[after] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • email, firstname, lastname, role, customRoleId, status, invitationDate, registrationDate, updatedAt query parameters Added
GET /v1/spotMembers/{spotMemberId}/customFormAnswers
  • Query
  • questionLabel[contains] query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • questionLabel query parameter Added
GET /v1/spotMembers/{spotMemberId}/notifications
  • Query
  • types[in], isRead[eq] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • types, isRead query parameters Added
GET /v1/spotMembers/{spotMemberId}/notifications~unreadCount
  • Query
  • types[in] query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • types query parameter Added
GET /v1/tags
  • Query
  • name[eq], name[contains] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • name query parameter Added
GET /v1/tags/{tagId}/spotMembers
  • Query
  • email[in], firstname[in], lastname[in], role[in], registrationDate[before], registrationDate[after] query parameters Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • email, firstname, lastname, role, registrationDate query parameters Added