Copy Page
Handwrite Team
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
Teams
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}
Your teams and classes
Create a team or class
One of your organisations
Rename a team (owner or admin)
Delete with its memberships, invitations, documents and shares (owner)
Membership
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}/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
README — GET /api/v1/orgs/{id}/invitations
README — POST /api/v1/orgs/{id}/invitations
README — DELETE /api/v1/orgs/{id}/invitations/{inviteId}
Organisation invitations to your verified email
Join with the invited role
Decline an organisation invitation
Members (students see teachers and themselves)
Add a person (managers)
Change a role; owner transfers a team
Remove a member (managers) or yourself
Leave (not the owner)
Pending email invitations (managers)
Invite an email (managers)
Withdraw an invitation (managers)
Documents
README — GET /api/v1/orgs/{id}/documents
Documents the organisation owns
Billing 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, status and seats per role (billing.read)
Usage per day and member (admins, managers, billing)
The last 60 minutes per member (admins, managers, billing)
One member's usage (usage.read, or yourself)
How people collaborate on the org's documents
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
Org-wide policy rules (policies.read)
Replace the org-wide rules (admins)
A member's override and what applies to them
Replace a member's override (admins; managers for members)
Remove a member's 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 issued to a member (tokens.read)
Issue a managed fine-grained token (admins, billing)
Revoke a managed token (admins, billing)
Guides
Start here — Team app integration
Team API specification notes
Team socket specification notes
Team live socket — README
Team roles and access model
Team credentials and developer setup
Team SSO and portal workflows
Team policies, plans and seats
Team usage and collaboration insights
Team webhook delivery — README
Schemas
Error
Principal
Access
ContentType
Language
FileRef
Document
Tombstone
DocumentPage
OrgKind
OrgRole
Organisation
CreateOrganisation
RenameOrganisation
Member
AddMember
ChangeMember
InviteMember
OrgInvitation
ReceivedOrgInvitation
Handwrite Classroom
Schemas
Error
Principal
Access
ContentType
Language
FileRef
Document
Tombstone
DocumentPage
OrgKind
OrgRole
Organisation
CreateOrganisation
RenameOrganisation
Member
AddMember
ChangeMember
InviteMember
OrgInvitation
ReceivedOrgInvitation
Language
Copy Page
A BCP 47 language tag.
"en"