Skip to main content

List the topics associated to a category

GET 

/categories/:id/topics

Returns the topics associated to a category.

Topics are sorted by name, in ascending order.

Cost: 1 credit per call.

Request

Path Parameters

    id int32required

    Possible values: >= 1 and <= 2147483647

    The category's id.

Query Parameters

    paginationCursor string

    An opaque string representing the pagination cursor.

    limit int32

    Possible values: >= 1 and <= 100

    Default value: 10

    The maximum number of objects returned per page.

Header Parameters

    X-Exorde-Api-Version stringrequired

    Possible values: [v1]

    The API version.

Responses

OK

Schema
    items object[]required

    Possible values: <= 100

    An array of Topic ressources.

  • Array [
  • id int32required

    Possible values: >= 1 and <= 2147483647

    The topic ID.

    name stringrequired

    The topic name.

    categories object[]required

    Possible values: >= 1

    The list of categories associated to the topic.

  • Array [
  • id int32required

    Possible values: >= 1 and <= 2147483647

    The category ID.

    name stringrequired

    The category name.

  • ]
  • keywords object[]required

    Possible values: >= 1

    The list of keywords associated to the topic.

  • Array [
  • label stringrequired

    The keyword label.

    language stringrequired

    Possible values: [en, zh, ja, ar, hi, ko, th, vi, ru, tr, es, fr, de, fa]

    The keyword language.

  • ]
  • ]
  • pagination object
    self uri

    Pagination link|cursor pointing to the current page.

    prev uri

    Pagination link|cursor pointing to the previous page.

    This link is not present if there is no previous page.

    next uri

    Pagination link|cursor pointing to the next page.

    This link is not present if there is no next page.

    status objectrequired
    cost int32required

    Number of credits that were consumed for this request.

    apiDeprecationNotice object

    Deprecation notice of the API.

    message stringrequired

    A message that tells when the API version will be shut down.

    shutdownDate date-timerequired

    The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Loading...