List sessions
Lists academic sessions, marking the current one.
GEThttps://api.klasstack.com/v1/sessions
- sessions:read
- Billable
- Test key: example response
Authorizations
AuthorizationstringheaderrequiredYour 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
cursorstringqueryThe opaque cursor from the previous page's
meta.pagination.next_cursor.limitintegerqueryRows per page.
Required range: 1 <= x <= 100
Response
200, application/json
dataobject[]requiredShow child attributes of each itemHide child attributes of each item
idnumberrequirednamestringrequiredstartDatestring (date)requiredendDatestring (date)requiredisCurrentbooleanrequiredWhether this is the school's current session.
metaobjectrequiredShow child attributesHide child attributes
request_idstringrequiredAlso returned in the X-Request-ID header.
paginationobjectShow child attributesHide child attributes
limitintegerrequiredRequired range: x <= 100
has_morebooleanrequirednext_cursorstring or nullrequiredSend this back as
cursorfor the next page. Opaque: never parse it.
Errors
- 401invalid_api_keyNo key was presented, or the key is not valid.
- 402insufficient_balanceThe school's service wallet cannot cover this call.
- 403insufficient_scopeThe app does not hold the scope this endpoint needs.
- 404endpoint_not_exposedThis endpoint is not part of the API.
- 429rate_limitedThe rate limit was reached. Retry after the Retry-After header says.
- 503platform_unavailableThe API is not available for this school right now.
What each code means, and what to do about it, is in the errors guide.
Webhook events
This call triggers no webhook event.