Workspace API
The workspace itself: members and their roles, invitations, agency sub-accounts beneath this workspace, and tenant-scoped encryption.
On this page
Endpoints#
23 operations, each with its parameters, schemas and an example request on its own page.
- getGet the workspace/api/workspace
- patchUpdate workspace/api/workspace
- getCapability catalogue/api/workspace/capabilitiesThe capabilities an agency may withhold, and the ready-made presets.
- getRead encryption/api/workspace/encryptionWhat this workspace encrypts, and what that costs.
- putSet encryption/api/workspace/encryptionTurns tenant-scoped encryption on or off.
- getWorkspace hierarchy/api/workspace/hierarchyThis workspace and everything beneath it.
- getList invitations/api/workspace/invitations
- postCreate invitation/api/workspace/invitationsInvites somebody into this workspace.
- deleteRevoke invitation/api/workspace/invitations/{invitation_id}Cancels a pending invitation.
- getList members/api/workspace/members
- patchChange member role/api/workspace/members/{user_id}
- deleteRemove member/api/workspace/members/{user_id}
- getRead pool/api/workspace/poolEvery workspace drawing on this agency's pool, and the commitment total.
- getList workspace sessions/api/workspace/sessions
- postEnd workspace sessions/api/workspace/sessions/revokeBulk: chosen sessions, chosen people, or everyone in the workspace (or one sub-account with org_id). The caller's own session is spared.
- deleteEnd workspace session/api/workspace/sessions/{session_id}
- getList sub accounts/api/workspace/sub-accounts
- postCreate sub account/api/workspace/sub-accountsOpens a workspace for a client, beneath this one.
- patchUpdate sub account/api/workspace/sub-accounts/{sub_account_id}
- deleteDelete sub account/api/workspace/sub-accounts/{sub_account_id}
- putSet allocation/api/workspace/sub-accounts/{sub_account_id}/allocationSets one client workspace's ceiling for the current period.
- getRead capabilities/api/workspace/sub-accounts/{sub_account_id}/capabilities
- putSet capabilities/api/workspace/sub-accounts/{sub_account_id}/capabilitiesSets what a client workspace may do inside itself.
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 fieldsHierarchyNode
depthintegerrequiredidstringrequiredis_activebooleanrequirednamestringrequiredplan_tierstringrequiredslugstringrequiredchildrenarray of HierarchyNodeDefault: []
7 fieldsHierarchyNode
depthintegerrequiredidstringrequiredis_activebooleanrequirednamestringrequiredplan_tierstringrequiredslugstringrequiredchildrenarray of HierarchyNodeDefault: []
7 fieldsHierarchyNode
depthintegerrequiredidstringrequiredis_activebooleanrequirednamestringrequiredplan_tierstringrequiredslugstringrequiredchildrenarray of HierarchyNodeDefault: []
7 fieldsHierarchyNode
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_tierstringrequiredslugstringrequiredagent_countintegerDefault: 0
conversation_countintegerDefault: 0
member_countintegerDefault: 0
Something unclear or missing? Tell us and we’ll fix it.