API reference
Workspace API
The workspace itself: members and their roles, invitations, agency sub-accounts beneath this workspace, and tenant-scoped encryption.
Endpoints
15 operations, each with its parameters, schemas and an example request on its own page.
- get/api/workspaceGet the workspace
- patch/api/workspaceUpdate workspace
- get/api/workspace/encryptionRead encryption — What this workspace encrypts, and what that costs.
- put/api/workspace/encryptionSet encryption — Turns tenant-scoped encryption on or off.
- get/api/workspace/hierarchyWorkspace hierarchy — This workspace and everything beneath it.
- get/api/workspace/invitationsList invitations
- post/api/workspace/invitationsCreate invitation — Invites somebody into this workspace.
- delete/api/workspace/invitations/{invitation_id}Revoke invitation — Cancels a pending invitation.
- get/api/workspace/membersList members
- patch/api/workspace/members/{user_id}Change member role
- delete/api/workspace/members/{user_id}Remove member
- get/api/workspace/sub-accountsList sub accounts
- post/api/workspace/sub-accountsCreate sub account — Opens a workspace for a client, beneath this one.
- patch/api/workspace/sub-accounts/{sub_account_id}Update sub account
- delete/api/workspace/sub-accounts/{sub_account_id}Delete sub account
Authentication
Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.
Objects returned
The models these endpoints send back, with every field. Open one to read it.
EncryptionState4 fields
consequencesarray of stringrequiredmodestringrequiredsealingbooleanrequiredkey_created_atany | null
HierarchyNode7 fields
depthintegerrequiredidstringrequiredis_activebooleanrequirednamestringrequiredplan_tierstringrequiredslugstringrequiredchildrenarray of HierarchyNodeDefault: []
7 fields · HierarchyNode
depthintegerrequiredidstringrequiredis_activebooleanrequirednamestringrequiredplan_tierstringrequiredslugstringrequiredchildrenarray of HierarchyNodeDefault: []
7 fields · HierarchyNode
depthintegerrequiredidstringrequiredis_activebooleanrequirednamestringrequiredplan_tierstringrequiredslugstringrequiredchildrenarray of HierarchyNodeDefault: []
7 fields · HierarchyNode
depthintegerrequiredidstringrequiredis_activebooleanrequirednamestringrequiredplan_tierstringrequiredslugstringrequiredchildrenarray of HierarchyNodeDefault: []
7 fields · HierarchyNode
depthintegerrequiredidstringrequiredis_activebooleanrequirednamestringrequiredplan_tierstringrequiredslugstringrequiredchildrenarray of HierarchyNodeDefault: []
InvitationRead8 fields
created_atstring (date-time)requiredemailstringrequiredexpires_atstring (date-time)requiredidstringrequiredrolestringrequiredstatusstringrequiredaccepted_atstring (date-time) | nullinvited_bystringDefault:
Message2 fields
messagestringrequiredokbooleanDefault: true
MemberRead10 fields
emailstringrequiredfull_namestringrequiredis_defaultbooleanrequiredis_verifiedbooleanrequiredjoined_atstring (date-time)requiredmembership_idstringrequiredroleOrgRole | stringrequireduser_idstringrequiredavatar_urlstring | nulllast_login_atstring (date-time) | null
SubAccountRead9 fields
created_atstring (date-time)requiredidstringrequiredis_activebooleanrequirednamestringrequiredplan_tierstringrequiredslugstringrequiredbot_countintegerDefault: 0
conversation_countintegerDefault: 0
member_countintegerDefault: 0
Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.