Skip to main content
https://.thoughtindustries.com

Show Section

Returns the details of a single section by its ID

Returns the details of a single section by its ID.

GEThttps://example.thoughtindustries.com/incoming/v2/sections/:id

Example request

curl "https://example.thoughtindustries.com/incoming/v2/sections/:id" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

NameTypeRequiredLocationDescription
iduuidYespathThe unique identifier of the section to retrieve.

Example response

{
  "data": {
    "APISectionById": {
      "id": "00000000-0000-0000-0000-000000000000",
      "title": "string",
      "slug": "example-slug",
      "status": "draft",
      "releaseAt": "2024-01-01T00:00:00.000Z",
      "parentSectionId": "00000000-0000-0000-0000-000000000000",
      "lessonCount": 0,
      "courseId": "00000000-0000-0000-0000-000000000000",
      "courseTitle": "string"
    }
  }
}

Response fields

FieldTypeDescription
iduuidUnique identifier of the section.
titlestringDisplay title of the section.
slugstringURL-friendly identifier for the section.
statusStatusPublication status of the section (e.g. draft or published).
releaseAtISO 8601 timestampDate and time when the section becomes available to learners, in ISO 8601 format.
parentSectionIduuidUnique identifier of the parent section, if this section is nested.
lessonCountintegerTotal number of lessons contained in the section.
courseIduuidUnique identifier of the course this section belongs to.
courseTitlestringDisplay title of the course this section belongs to.