Get the school

• 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.

200, application/json

• dataobjectrequired

  Show child attributesHide child attributes

  • idnumberrequired

  • namestringrequired

  • subdomainstringrequired

    The school subdomain on Klasstack.

  • addressstring or nullrequired

  • citystring or nullrequired

  • statestring or nullrequired

  • countrystring or nullrequired

  • countryCodestring or nullrequired

    ISO 3166-1 alpha-2.

  • phonestring or nullrequired

  • emailstring or nullrequired

  • logoUrlstring or nullrequired

  • timezonestring or nullrequired

    IANA time zone.

  • currencystringrequired

    ISO 4217.

  • primaryDomainstring or nullrequired

    The school's verified custom domain, when it has one.

• metaobjectrequired

  Show child attributesHide child attributes

  • request_idstringrequired

    Also returned in the X-Request-ID header.

  • paginationobject

    Show child attributesHide 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.

• 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.

This call triggers no webhook event.