List all series

Returns all Mindtickle series created on your learning site.

View as Markdown

Prerequisites

Authentication and setup: A valid access token.

Endpoint

GET /api/v2/series/list

Base URL: the standard REST host for your region. See Base URLs.

Headers: Authorization: Bearer ACCESS_TOKEN.

Request

This endpoint does not require any request parameters.

Response

Field	Type	Description
`totalHits`	Unconfirmed	Total number of series on your learning site.
`hits`	Array[SeriesEntity]	Details on each series.
`hits[].moduleType`	string	Object type, shown as `SERIES` in the example. Confirm the exact casing before using case-sensitive comparisons.
`hits[].description`	string	Description, if available, of the series added on the Mindtickle platform.
`hits[].name`	string	Name of the series.
`hits[].id`	string	Mindtickle ID of the series.

Confirm the type of totalHits with Mindtickle Support before implementing a strict response parser. Do not assume that both strings and numbers are accepted representations.

Response example

{
  "totalHits": 2,
  "hits": [
    {
      "moduleType": "SERIES",
      "description": "<p dir='ltr'>Welcome to Mindtickle! This series introduces the basics of the Mindtickle platform. For questions, contact your customer success manager.</p>",
      "name": "Mindtickle | Product Overview",
      "id": "123456789012345101"
    },
    {
      "moduleType": "SERIES",
      "description": "",
      "name": "Weekly Check-In",
      "id": "123456789012345102"
    }
  ]
}