Subjects

List subjects

Lists the subjects the school teaches.

GEThttps://api.klasstack.com/v1/subjects

  • subjects:read
  • Billable
  • Test key: example response

Authorizations

  • Authorizationstringheaderrequired

    Your secret key as a bearer token, in the form Bearer ks_live_sk_... or Bearer ks_test_sk_.... Keep it on your server. A test key gets the documented example and touches no school data.

Query Parameters

  • cursorstringquery

    The opaque cursor from the previous page's meta.pagination.next_cursor.

  • limitintegerquery

    Rows per page.

    Required range: 1 <= x <= 100

  • searchstringquery

    Example: Math

  • departmentIdintegerquery

    Example: 2

  • academicPeriodIdintegerquery

    Example: 5

Response

200, application/json

  • dataobject[]required

    Show child attributes of each item
    • idnumberrequired

    • namestringrequired

    • codestring or nullrequired

    • departmentIdnumber or nullrequired

    • departmentNamestring or nullrequired

    • isElectivebooleanrequired

    • descriptionstring or nullrequired

  • metaobjectrequired

    Show child attributes
    • request_idstringrequired

      Also returned in the X-Request-ID header.

    • paginationobject

      Show child attributes
      • limitintegerrequired

        Required range: x <= 100

      • has_morebooleanrequired

      • next_cursorstring or nullrequired

        Send this back as cursor for the next page. Opaque: never parse it.

Errors

What each code means, and what to do about it, is in the errors guide.

Webhook events

This call triggers no webhook event.