Skip to main content

Create a key

On the API’s page, choose Create API Key, then:
  1. Name the system the key is for.
  2. Under Can Read, choose which resources it may read: students, contacts, staff, classes or payments.
  3. Under Expires, choose never, 30 days, 90 days or a year.
  4. Copy the key and the base URL from Copy Your API Key.
The key is shown once. Store it in your system’s secret store before you close the dialog.
A new school may see a message to try again in a few minutes. Its keys become available once SchoolCues finishes setting up the school’s sign-in organization.

Send the key

Send the key as a bearer token with every request:
Use the base URL from Copy Your API Key in place of BASE_URL.

What a key can read

Each resource needs its own permission, such as students:read. A key without the permission for a resource gets a 403 response that names the resource.

Review and revoke keys

The API Keys section lists each key’s name, what it can read, the end of the key, when it was created and last used, and when it expires. Choose Revoke in a key’s row menu to stop it at once.