Search for resources in the spot

GET /v1/search

Query parameters

page integer | null

The page number in a paginated set of results
limit integer | null

The limit of results to be returned per page
query string Required

The search query to be performed
userId string

The unique identifier of the user performing the search
groupId string

Filters on entities related to this group
searchableTypes[in] array[string]

The types of entities to include in the search

Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.

Responses

200 application/json

Search results
Hide response attributes Show response attributes object
- items array[object] Required
  
  The items found
  
  Any of:
  SearchableTopicApiResponse object SearchableForumApiResponse object SearchableTopicAnswerApiResponse object SearchableSpotMemberApiResponse object SearchableCollectionLinkApiResponse object SearchableCollectionPageApiResponse object SearchableCollectionApiResponse object SearchableLiveApiResponse object SearchableChannelApiResponse object SearchableCourseApiResponse object SearchableCourseStepApiResponse object SearchableLearningPathApiResponse object
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  topicTitle string Required
  
  The title of the topic
  
  topicContent string Required
  
  The content of the topic
  
  forumName string Required
  
  The name of the forum
  
  forumPrivacy string Required
  
  The privacy of the forum
  
  Values are Private or Secret.
  
  topicAuthorPictureUrl string | null Required
  
  The picture url of the author
  
  topicAuthorName string Required
  
  The name of the author
  
  spotId string Required
  
  The spot id of the topic
  
  forumId string Required
  
  The forum id
  
  topicId string Required
  
  The topic id
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  forumName string Required
  
  The name of the forum
  
  forumDescription string Required
  
  The description of the forum
  
  forumPrivacy string Required
  
  The privacy of the forum
  
  Values are Private or Secret.
  
  spotId string Required
  
  The spot id of the forum
  
  forumGroupsIds array[string] Required
  
  The ids of the groups assigned to the forum
  
  forumId string Required
  
  The forum id
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  topicTitle string Required
  
  The title of the topic
  
  topicAnswerContent string Required
  
  The content of the topic answer
  
  forumName string Required
  
  The name of the forum
  
  forumPrivacy string Required
  
  The privacy of the forum
  
  Values are Private or Secret.
  
  topicAnswerAuthorPictureUrl string | null Required
  
  The picture url of the author answer
  
  topicAnswerAuthorName string Required
  
  The name of the author answer
  
  spotId string Required
  
  The spot id of the topic answer
  
  forumId string Required
  
  The forum id of the topic answer
  
  topicId string Required
  
  The topic id of the topic answer
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  firstname string Required
  
  The first name of the member
  
  lastname string Required
  
  The last name of the member
  
  email string | null Required
  
  The email of the member
  
  headline string Required
  
  The headline of the member
  
  pictureUrl string | null Required
  
  The picture url of the member
  
  status string Required
  
  The status of the member
  
  role string Required
  
  The role of the member
  
  tags array[string] Required
  
  The tags of the member
  
  spotId string Required
  
  The spot id of the member
  
  spotMemberId string Required
  
  The member id
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  collectionLinkTitle string Required
  
  The title of the collection document link
  
  collectionLinkUrl string Required
  
  The description of the collection documentlink
  
  collectionLinkTags array[string] Required
  
  The tags of the collection document link
  
  collectionName string Required
  
  The name of the collection
  
  collectionPrivacy string Required
  
  The privacy of the collection
  
  Values are Private or Public.
  
  isDraft boolean Required
  
  is the document is in draft mode
  
  spotId string Required
  
  The spot id of the collection
  
  collectionId string Required
  
  The collection id
  
  linkId string Required
  
  The id of the document link
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  collectionPageTitle string Required
  
  The title of the collection page
  
  collectionPageContent string Required
  
  The content of the collection page
  
  collectionPageTags array[string] Required
  
  The tags of the collection page
  
  collectionName string Required
  
  The name of the collection
  
  collectionPrivacy string Required
  
  The privacy of the collection
  
  Values are Private or Public.
  
  isDraft boolean Required
  
  is the document is in draft mode
  
  spotId string Required
  
  The spot id of the collection
  
  collectionId string Required
  
  The collection id
  
  pageId string Required
  
  The id of the page
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  collectionName string Required
  
  The name of the collection
  
  collectionDescription string Required
  
  The description of the collection
  
  collectionPrivacy string Required
  
  The privacy of the collection
  
  Values are Private or Public.
  
  spotId string Required
  
  The spot id of the collection
  
  collectionGroupsIds array[string] Required
  
  The ids of the groups assigned to the collection
  
  collectionId string Required
  
  The collection id
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  liveTitle string Required
  
  The title of the live
  
  liveDescription string Required
  
  The description of the live
  
  liveStartDate string(date-time) Required
  
  The start date of the live
  
  liveTags array[string] Required
  
  The tags of the live
  
  livePrivacy string Required
  
  The visibility privacy of the live
  
  Values are AnyOne, OnlySpotMembers, or InvitedMembersOnly.
  
  spotId string Required
  
  The spot id of the live
  
  liveGroupsIds array[string] Required
  
  The ids of the groups assigned to the live
  
  liveId string Required
  
  The live id
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  channelName string Required
  
  The name of the channel
  
  channelDescription string Required
  
  The description of the channel
  
  channelPrivacy string Required
  
  The privacy of the channel
  
  Values are Private or Public.
  
  spotId string Required
  
  The spot id of the channel
  
  channelGroupsIds array[string] Required
  
  The ids of the groups assigned to the channel
  
  channelId string Required
  
  The channel id
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  courseTitle string Required
  
  The name of the course
  
  courseDescription string Required
  
  The description of the course
  
  coursePrivacy string Required
  
  The privacy of the course
  
  Values are Secret or Public.
  
  isDraft boolean Required
  
  To know if the course is in draft
  
  spotId string Required
  
  The spot id of the course
  
  courseGroupsIds array[string] Required
  
  The ids of the groups assigned to the course
  
  courseId string Required
  
  The course id
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  courseTitle string Required
  
  The title of the course containing the step
  
  isDraft boolean Required
  
  Indicates if the course is still in draft
  
  stepTitle string Required
  
  The title of the step
  
  stepContent string Required
  
  The content of the step
  
  stepCount number Required
  
  The total number of steps in the course
  
  stepOrder number Required
  
  The order of the step within the course
  
  spotId string Required
  
  The spot id of the course step
  
  courseId string Required
  
  The course id of the course step
  
  stepId string Required
  
  The identifier of the course step
  
  Hide attributes Show attributes
  
  id string Required
  
  Entity unique identifier
  
  type string Required
  
  Entity type
  
  Values are Channel, Collection, CollectionLink, CollectionPage, Course, CourseStep, Forum, LearningPath, Live, SpotMember, Topic, or TopicAnswer.
  
  learningPathId string Required
  
  The learning path id
  
  spotId string Required
  
  The spot id of the learning path
  
  learningPathTitle string Required
  
  The title of the learning path
  
  learningPathDescription string Required
  
  The description of the learning path
  
  learningPathPrivacy string Required
  
  The privacy of the learning path
  
  Values are Public, Private, or Secret.
- total integer Required
  
  The total number of items found
400

Malformed payload

GET /v1/search

curl \
 --request GET 'https://openapi.meltingspot.io/v1/search?query=string'

Response examples (200)

{
  "items": [
    {
      "id": "string",
      "type": "Channel",
      "topicTitle": "string",
      "topicContent": "string",
      "forumName": "string",
      "forumPrivacy": "Private",
      "topicAuthorPictureUrl": "string",
      "topicAuthorName": "string",
      "spotId": "string",
      "forumId": "string",
      "topicId": "string"
    }
  ],
  "total": 42
}