Get the public school profile

• Authorizationstringheaderrequired

  A publishable key as a bearer token, in the form Bearer ks_live_pk_.... It is safe to ship in a browser or app. A secret key works here too. A test key gets the documented example and touches no school data.

200, application/json

• dataobjectrequired

  Show child attributesHide child attributes

  • namestringrequired

  • subdomainstringrequired

    The school subdomain on Klasstack.

  • logoUrlstring or nullrequired

  • primaryColorstring or nullrequired

  • secondaryColorstring or nullrequired

  • accentColorstring or nullrequired

  • addressstring or nullrequired

  • citystring or nullrequired

  • statestring or nullrequired

  • countrystring or nullrequired

  • phonestring or nullrequired

  • emailstring or nullrequired

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