Clever
Clever is an education technology platform for school identity management, rostering, single sign-on, and student data integrations.
- Base URL:
https://api.clever.com/v1.2 - Auth: OAuth 2.0 (user-delegated) — attach an InTouch
oauthcredential. Mint one withitcli.py /oauth <provider>(device-code) or/google-auth(Google); the server auto-refreshes the access token before each run, so the connector never handles or stores tokens.
Operations
getcontacts— GET /contacts — Returns a list of student contactsgetcontact— GET /contacts/{id} — Returns a specific student contactgetdistrictforstudentcontact— GET /contacts/{id}/district — Returns the district for a student contactgetstudentforcontact— GET /contacts/{id}/student — Returns the student for a student contactgetdistrictadmins— GET /district_admins — Returns a list of district adminsgetdistrictadmin— GET /district_admins/{id} — Returns a specific district admin
Inputs
- a linked
oauthcredential (no key inputs) — the server injects a freshAuthorization: Bearerfrom it operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: getcontacts
# (attach an 'oauth' credential to the task — no inline secrets)
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
operation |
string | yes | — | One of: getcontacts, getcontact, getdistrictforstudentcontact, getstudentforcontact, getdistrictadmins, getdistrictadmin |
id |
string | no | — | Path parameter id (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |