Get a Topic

PropertyDescription
MethodGET
Path/open/v1/spaces/$me/topics/{topicId}
Accept-
Content-Typeapplication/json
DescriptionRetrieves a topic by its ID.
  • Request
    • Query
      (empty)
    • Body
      // (empty)
      
  • Response
    type TopicView = {
      topic: Topic
    }
    

Batch Get a Topic

PropertyDescription
MethodGET
Path/open/v1/spaces/$me/topics/batch
Accept-
Content-Typeapplication/json
DescriptionRetrieves multiple topics by IDs. Can fetch up to 25 topics at once.
  • Request

    • Query

      ParamRequired?DefaultTypeDescriptionExample
      ids[]O-string[]IDs of topics to fetch.?ids[]=42&ids[]=37
    • Body

      // (empty)
      
  • Response

    type TopicsView = {
      topics: Topic[]
    }
    

List Topics of a Space

PropertyDescription
MethodGET
Path/open/v1/spaces/$me/topics
Accept-
Content-Typeapplication/json
DescriptionRetrieves a paginated list of topics, ordered by update timestamp.
  • Request

    • Query

      ParamRequired?DefaultTypeDescriptionExample
      limitX25numberUsed for pagination25
      sinceXstringUsed for pagination1707017182188
      orderXasc‘asc’ | 'desc'Sort orderasc
    • Body

      // (empty)
      
  • Response

    type TopicsListView = {
      topics: Topic[]
      next?: string
    }
    

Search Topics of a Space

PropertyDescription
MethodGET
Path/open/v1/spaces/$me/topics/search
Accept-
Content-Typeapplication/json
DescriptionSearch for a topic within a space.

- You must provide a search term (query).
- The search will cover all topics in the space, and any matching Topic.name in any language will be included in the search results.
- Can fetch up to 10 topics.

  • Request

    • Query

      ParamRequired?DefaultTypeDescriptionExample
      queryOstringSearch termapple
    • Body

      // (empty)
      
  • Response

    type TopicsSearchView = {
      topics: Topic[]
    }