Copy Page
Handwrite Classroom
Handwrite Regular Accounts
Schemas
Error
Principal
Role
Access
ContentType
Language
FileRef
Document
Tombstone
DocumentPage
CreateDocument
UpdateDocument
FileInfo
CommitUpload
Upload
DownloadLink
Extracted
ExtractionFailed
CommittedDocument
ExtractedDocument
SearchHit
SearchPage
Export
Permission
Share
ChangeRole
Invitation
Permissions
ReceivedInvitation
AcceptedInvitation
Me
WebhookEventType
Webhook
CreateWebhook
CreatedWebhook
WebhookDelivery
AudioFormat
Speech
WordTiming
SpeechMarks
AudioLink
Voice
Quota
SettingEntry
Settings
SettingsPatch
PatchedSettings
OAuthToken
OAuthError
Handwrite Team
Schemas
Error
Principal
Access
ContentType
Language
FileRef
Document
Tombstone
DocumentPage
OrgKind
OrgRole
Organisation
CreateOrganisation
RenameOrganisation
Member
AddMember
ChangeMember
InviteMember
OrgInvitation
ReceivedOrgInvitation
Handwrite Classroom
Start here — Classroom for developers
Classroom API specification notes
Classroom socket specification notes
Classroom live socket — README
Classroom identities, credentials and roles
School and student workflows
Classroom policy and data-use notes
Class setup
README — GET /api/v1/orgs
README — POST /api/v1/orgs
README — GET /api/v1/orgs/{id}
README — PATCH /api/v1/orgs/{id}
README — DELETE /api/v1/orgs/{id}
Class setup API — README
Choose a class from the returned organisations
Create an ordinary class
Read the selected class
Rename a class
Delete an ordinary class
Invitations
README — GET /api/v1/orgs/invitations
README — POST /api/v1/orgs/invitations/{inviteId}/accept
README — POST /api/v1/orgs/invitations/{inviteId}/decline
README — GET /api/v1/orgs/{id}/invitations
README — POST /api/v1/orgs/{id}/invitations
README — DELETE /api/v1/orgs/{id}/invitations/{inviteId}
Invitations API — README
Read invitations to the signed-in person
Accept a class invitation
Decline a class invitation
List pending class invitations
Invite a person by email
Cancel a pending invitation
People
README — GET /api/v1/orgs/{id}/members
README — POST /api/v1/orgs/{id}/members
README — PATCH /api/v1/orgs/{id}/members/{principal}
README — DELETE /api/v1/orgs/{id}/members/{principal}
README — POST /api/v1/orgs/{id}/leave
People API — README
Read the visible membership roster
Add an existing person to a class
Change a class member role
Remove an ordinary class membership
Leave an ordinary class
Documents
README — GET /api/v1/orgs/{id}/documents
Documents API — README
List class-owned documents
Plan and usage
README — GET /api/v1/orgs/{id}/billing
README — GET /api/v1/orgs/{id}/usage
README — GET /api/v1/orgs/{id}/usage/live
README — GET /api/v1/orgs/{id}/members/{principal}/usage
README — GET /api/v1/orgs/{id}/insights
Plan and usage API — README
Read classroom plan and seat information
Read classroom usage totals
Read the recent classroom activity window
Read one member usage
Read classroom collaboration insights
Policies
README — GET /api/v1/orgs/{id}/policies
README — PUT /api/v1/orgs/{id}/policies
README — GET /api/v1/orgs/{id}/members/{principal}/policy
README — PUT /api/v1/orgs/{id}/members/{principal}/policy
README — DELETE /api/v1/orgs/{id}/members/{principal}/policy
Policies API — README
Read class-wide policy
Replace class-wide policy rules
Read one member policy
Replace one member policy override
Clear one member override
Managed tokens
README — GET /api/v1/orgs/{id}/members/{principal}/tokens
README — POST /api/v1/orgs/{id}/members/{principal}/tokens
README — DELETE /api/v1/orgs/{id}/members/{principal}/tokens/{tokenId}
Managed tokens API — README
List tokens issued to a member
Issue a managed student token
Revoke a managed token
Schemas
Error
Principal
Access
ContentType
Language
FileRef
Document
Tombstone
DocumentPage
OrgKind
OrgRole
Organisation
CreateOrganisation
RenameOrganisation
Member
AddMember
ChangeMember
InviteMember
OrgInvitation
ReceivedOrgInvitation
ExtractionFailed
Copy Page
{
"error"
:
{
"code"
:
"string"
,
"message"
:
"string"
}
}