Skip to content
Optiwork API Docs
Search
Ctrl
K
Cancel
work.optidata.com
Modules
Optiwork
Overview
Service
Overview
Health check
GET
Read the Drive client configuration
GET
Users
Overview
List users of the tenant
GET
Get a user
GET
Get a user by e-mail
GET
Groups
Overview
Get a group with its members
GET
Dashboard
Overview
List colleagues by presence
GET
List the latest notifications for the dashboard
GET
List pending approvals for the dashboard
GET
List recently accessed documents
GET
Multi-Factor Authentication
Overview
Read a user's MFA settings
GET
Open an MFA challenge
POST
Check that a device is registered
GET
Confirm a registered device
POST
Remove a registered device
POST
Get the caller's newest open challenge
GET
Answer a challenge from a device
POST
Poll whether a challenge was answered
GET
Notifications
Overview
List notifications
GET
Mark notifications as read
PATCH
List notification preferences
GET
Switch one notification channel on or off
PATCH
Mobile Push
Overview
Read the settings bound to a push token
GET
Register a push token
POST
Deactivate a push token
PATCH
Send a silent push notification
POST
Omnisearch
Overview
Quick-search users
GET
Read the omnisearch configuration
GET
Feedback
Overview
Send product feedback
POST
Drive
Overview
Examples
Drive
Overview
List the company folders of the drive
GET
List the company folders of the drive
GET
List reachable company folders
GET
Search company folders
GET
Nodes
Overview
Open a folder
GET
Create a file or folder inside a folder
POST
Move a node to the trash
DELETE
Create a file or folder at the top level
POST
Delete a node permanently
DELETE
Move several nodes to the trash
POST
Delete several nodes permanently
POST
Restore a node from the trash
POST
Rename a node
POST
Move a node to another folder
POST
Duplicate a node in place
POST
Copy a file into another folder
POST
Copy folders and files in the background
POST
Get a node without its children
GET
Get a node with its locks
GET
Get several nodes at once
GET
Get storage usage of a folder
GET
Count what a folder contains
GET
List the subfolders of a folder
GET
List every descendant of a folder
GET
List the children of a folder with permissions
GET
Find a child by name
GET
Get the path of a node
GET
Keep only the ids that still exist
POST
Node Markers
Overview
Add a marker to a node
POST
Remove a marker from a node
DELETE
Toggle a marker on a node
PATCH
Node Content
Overview
Read the bytes of a file
GET
Replace the bytes of a file with an upload
POST
Download a file
GET
Describe the bytes of a file without downloading them
GET
Read the bytes of a file as base64
GET
Replace the bytes of a file with base64 content
POST
Describe the bytes of a file, base64 flavour
GET
Read one stored version of a file
GET
Describe one stored version of a file
GET
Download the file as it was at a history entry
GET
Chunked Upload
Overview
Start a chunked upload at the top level
POST
Start a chunked upload inside a folder
POST
Upload one chunk
POST
Finish a chunked upload
POST
Start a chunked replacement of a file's content
POST
Upload one chunk of a replacement
POST
Finish a chunked replacement
POST
Search
Overview
Search the whole drive
GET
Search inside a folder
GET
Shared With Me
Overview
List folders shared with the caller
GET
Check which of these nodes are shared with the caller
POST
Node History
Overview
List the change log of a node
GET
Get one history entry
GET
Restore a node to an earlier version
POST
Node Locks
Overview
List the locks on a node
GET
Read the locks of several nodes
GET
Lock a file for editing
POST
Release the lock on a file
POST
Release several locks at once
POST
Get one lock
GET
Extend a lock
POST
Node Approvals
Overview
List the approvals on a file
GET
Set the approvals on a file
POST
Resend the approval invitations
POST
Approve a file
POST
Reject a file
POST
Count the approvals waiting on the caller
GET
Search who can be asked for approval
GET
List the approvals of several files
POST
Cancel several approval requests
POST
Node Audit
Overview
Read the audit trail of a node
GET
Sync Journal
Overview
Page through the whole sync journal
GET
Get the newest journal entry
GET
Read journal entries after an id
GET
Read the nodes touched after an id
GET
Read specific nodes in sync form
GET
Shares
Overview
Read how a node is shared
GET
Start sharing a node
POST
Stop sharing a node
DELETE
Grant access to a user or group
POST
Set the whole access list of a node
POST
Check whether the caller may share a node
GET
Revoke one grant
DELETE
Change one grant
PATCH
Publish a share link
POST
Revoke the share link
POST
Drive Users
Overview
List the users of the drive
GET
Create a user
POST
Get a user of the drive
GET
Remove a user
DELETE
Update a user
PATCH
Imports
Overview
List imports
GET
Open an import
POST
Get an import
GET
Delete an import record
DELETE
Report import progress
PATCH
Bundles
Overview
Download a bundle as a zip
GET
Projects
Overview
Service
Overview
Health check
GET
Boards
Overview
List boards the caller is a member of
GET
Create a board
POST
Get the caller's boards as a tree
GET
Reorder the caller's board list
PATCH
Get selected fields for a batch of boards
GET
Get a board with its full working set
GET
Delete a board
DELETE
Update a board
PATCH
Search cards and columns within a board
GET
Archive a board
POST
Unarchive a board
POST
Duplicate a board
POST
Import cards into a board from an external tool
POST
Export a board as a file download
GET
Export a board to Optiwork Drive
POST
Change a board's visibility
PUT
Board Members
Overview
List the members of a board
GET
Search users that could be added to the board
GET
Search users that can be @-mentioned on the board
GET
Set the caller's view mode for this board
PATCH
Set the caller's notification preferences for this board
PATCH
Columns
Overview
List the columns of a board
GET
Create a column
POST
Reorder the board's columns
PATCH
Delete several columns at once
POST
Unarchive several columns at once
POST
Delete a column
DELETE
Update a column
PATCH
List the cards of a column (slim)
GET
Archive a column
POST
Unarchive a column
POST
Sort a column's cards by a predefined criterion
POST
Move / reorder cards within or into a column
PATCH
Cards
Overview
Create a card
POST
Delete several cards at once
POST
Unarchive several cards at once
POST
Get a card
GET
Delete a card
DELETE
Update a card
PATCH
Archive a card
POST
Unarchive a card
POST
Duplicate a card in place
POST
Get selected fields for a batch of cards (cross-board)
GET
Card Files
Overview
List a card's files
GET
Upload a file to a card
POST
Attach an existing Optiwork Drive file to a card
POST
Download a card file
GET
Stream a card file inline
GET
Get a signed view URL for a card file
GET
Delete a card file
DELETE
Card Assignees & Tags
Overview
Attach/detach card assignees
POST
Attach/detach card tags
POST
Card Recurrence
Overview
Get a card's recurrence rule
GET
Create or update a card's recurrence rule
POST
Stop a card's recurrence
DELETE
Comments
Overview
Add a comment to a card
POST
Delete a comment
DELETE
Edit a comment
PATCH
Time Tracking
Overview
Start a timer on a card
POST
Stop the running timer on a card
POST
Delete a time entry
DELETE
Edit a time entry
PATCH
Checklists
Overview
Create a checklist on a card
POST
Reorder the checklists of a card
POST
Reorder checklist items (within and across checklists)
POST
Get a checklist with its items
GET
Delete a checklist
DELETE
Rename a checklist
PATCH
Add an item to a checklist
POST
Get a checklist item
GET
Delete a checklist item
DELETE
Update a checklist item
PATCH
Convert a checklist item into a card
POST
Attach/detach assignees on a checklist item
POST
Custom Fields
Overview
List a card's custom field values
GET
Set several custom field values on a card
PUT
Clear a custom field value from a card
DELETE
Set one custom field value on a card
PATCH
Custom Field Definitions
Overview
List a board's custom field definitions
GET
Create a custom field definition on a board
POST
Reorder a board's custom field definitions
PATCH
Delete a custom field definition
DELETE
Update a custom field definition
PATCH
List global custom field definitions
GET
Create a global custom field definition
POST
Reorder global custom field definitions
PATCH
Delete a global custom field definition
DELETE
Update a global custom field definition
PATCH
Tags
Overview
Create a board tag
POST
Get a board tag
GET
Delete a board tag
DELETE
Update a board tag
PATCH
Create a common (tenant-wide) tag
POST
Get a common tag
GET
Delete a common tag
DELETE
Update a common tag
PATCH
Contact Links
Overview
List contacts linked to a board
GET
Link/unlink contacts on a board
PATCH
List contacts linked to a card
GET
Link/unlink contacts on a card
PATCH
Dashboard
Overview
Get a user's upcoming tasks
GET
Calendar
Overview
Examples
Service
Overview
Health check
GET
Calendars
Overview
List calendars
GET
Create a calendar
POST
List calendars you can create events in
GET
Read a calendar
GET
Delete a calendar
DELETE
Update a calendar
PATCH
Events
Overview
List events
GET
Create an event
POST
Read an event
GET
Cancel an event
DELETE
Update an event
PATCH
Reschedule an event
POST
Invitations
Overview
Accept an invitation
POST
Accept an invitation tentatively
POST
Decline an invitation
POST
Recurring Events
Overview
Make one occurrence differ
POST
Reschedule one occurrence
POST
Video Conferences
Overview
Find events by meeting room
GET
Directory
Overview
Search people you can invite
GET
Resolve e-mail addresses
GET
Distribution Lists
Overview
Read a distribution list
GET
Create a distribution list
POST
Delete a distribution list
DELETE
Update a distribution list
POST
Dashboard
Overview
Read today's schedule
GET
Calendar Feed
Overview
Subscribe to a calendar
GET
Talk
Overview
Service
Overview
Health check
GET
Users
Overview
Read the authenticated user
GET
List the people you can talk to
GET
Search people by name or e-mail
GET
Conversations
Overview
Open the private conversation with a user
GET
List your conversations
GET
Create a conversation
POST
Search your conversations
GET
List archived conversations
GET
List conversations with unread messages
GET
List group conversations
GET
List channels
GET
Read a conversation
GET
Update a conversation
POST
Conversation Preferences
Overview
Pin a conversation
POST
Unpin a conversation
POST
Mute a conversation
POST
Unmute a conversation
POST
Archive a conversation
POST
Unarchive a conversation
POST
Save the unsent draft
PATCH
Participants
Overview
Leave a conversation
POST
Add people to a conversation
POST
Remove someone from a conversation
POST
Make a participant an administrator
POST
Demote an administrator
POST
List people who are not in the conversation
GET
Search people who are not in the conversation
GET
Messages
Overview
Send a direct message to a user
POST
List the messages of a conversation
GET
Send a message
POST
Stream the messages after a given one
GET
Stream the messages before a given one
GET
Mark the conversation as read
POST
Forward messages into other conversations
POST
Delete a message
DELETE
Edit a message
PATCH
Reactions
Overview
List who reacted to a message
GET
React to a message
POST
Remove your reaction
DELETE
Polls
Overview
List who voted on a poll
GET
Vote on a poll
POST
Attachments
Overview
List images and videos shared in a conversation
GET
List audio shared in a conversation
GET
List documents shared in a conversation
GET
Count the attachments of a conversation
GET
Read an attachment inline
GET
Download an attachment
GET
Sync Journal
Overview
Page through a conversation's change journal
GET
Read the newest journal entry
GET
Stream the journal entries after a given one
GET
Search
Overview
Search conversations, messages and people
GET
Dashboard
Overview
Recent conversations of a user
GET
Mail
Overview
Service
Overview
Health check
GET
Account
Overview
Recent mail for a home screen
GET
Update mail preferences
PATCH
Avatar for an address
GET
Folders
Overview
List folders
GET
Create a folder
POST
Empty the trash
DELETE
Get a folder
GET
Delete a folder
DELETE
Rename or recolour a folder
PATCH
Move a folder
POST
Mark a whole folder as read
POST
Conversations
Overview
List conversations in a folder
GET
Delete conversations permanently
DELETE
Unread count for a folder
GET
Read a conversation
GET
Latest message of a conversation
GET
Mark conversations as read
POST
Mark conversations as unread
POST
Move conversations to another folder
POST
Archive conversations
POST
Move conversations to the trash
POST
Tag conversations
POST
Untag conversations
POST
Flag conversations
POST
Unflag conversations
DELETE
Messages
Overview
Send a new message
POST
Get a message for display
GET
Read a single message
GET
Download the original message source
GET
Reply to a message
POST
Forward a message
POST
Send a requested read receipt
POST
Decline a requested read receipt
POST
Message Actions
Overview
Delete messages permanently
DELETE
Mark messages as read
POST
Mark messages as unread
POST
Flag messages
POST
Unflag messages
POST
Move messages to another folder
POST
Move messages to the trash
POST
Archive messages
POST
Tag messages
POST
Untag messages
POST
Attachments
Overview
Download an attachment
GET
Drafts
Overview
Get a draft
GET
Get the draft replying to a message
GET
Create or update a draft
POST
Discard a draft
DELETE
Discard several drafts
DELETE
Scheduled Sending
Overview
List scheduled deliveries
GET
Schedule a draft for later
POST
Get a scheduled delivery
GET
Reschedule a delivery
PUT
Cancel a scheduled delivery
DELETE
Snooze
Overview
Check whether conversations are snoozed
GET
Snooze conversations
POST
Wake conversations up now
DELETE
Change when conversations wake up
PATCH
Conversations that just woke up
GET
How many conversations just woke up
GET
Dismiss a wake-up notice
DELETE
Search
Overview
Search the mailbox
POST
Find addresses to write to
GET
Signatures
Overview
List signatures
GET
Create a signature
POST
Update a signature
POST
Templates
Overview
List templates
GET
Create a template
POST
Get a template
GET
Delete a template
DELETE
Spam
Overview
Report delivered messages as spam
POST
List quarantined messages
GET
Delete quarantined messages
DELETE
Read a quarantined message
GET
Get a quarantined message
GET
Release or reclassify a quarantined message
POST
Invitations
Overview
Answer a calendar invitation
POST
Contacts
Overview
Contacts
Overview
List contacts
GET
Search contacts
GET
Autocomplete contacts
GET
Spaces
Overview
Service
Overview
Health check
GET
Spaces
Overview
List spaces
GET
Create a space
POST
Get a space
GET
Archive a space
DELETE
Update a space
PATCH
Prepare to enter a space
POST
Chat
Overview
Read a space's chat
GET
Avatar
Overview
Get your avatar
GET
Choose your avatar
PUT
Worlds
Overview
List worlds
GET
Create a world
POST
Get the active world
GET
Get a world
GET
Rename a world
PATCH
Save a world
PUT
Make a world the live one
POST
Builders
Overview
List builders
GET
Make someone a builder
POST
Remove a builder
DELETE
AI
Overview
Service
Overview
Health check
GET
Text
Overview
Open a signed single-prompt chat
GET
Chat with a single prompt
POST
Get a signed URL for a single-prompt chat
POST
Open a signed chat with history
GET
Chat with a conversation history
POST
Get a signed URL for a chat with history
POST
Audio
Overview
Transcribe a recording
POST
Images
Overview
Generate an image
POST
Edit an image
POST
Call
Overview
Service
Overview
Health check
GET
Rooms
Overview
List your rooms
GET
Open a new room in the browser
GET
Create a room
POST
List your permanent links
GET
Delete a room
DELETE
Update a room
PATCH
Get a room
GET
Get the room's calendar event
GET
On-demand Calls
Overview
Start a call
POST
Ring more people into a call
POST
Accept a call
POST
Decline a call
POST
Mark a call as missed
POST
Claim the ringtone
POST
Release the ringtone
POST
Recordings
Overview
Upload an in-person meeting
POST
Get a recording
GET
Start recovering a recording
POST
Upload a piece of a recording
POST
Finish recovering a recording
POST
Dashboard
Overview
Get your latest recordings
GET
Papers
Overview
Service
Overview
Health check
GET
Categories
Overview
List categories
GET
Create a category
POST
Get a category
GET
Delete a category
DELETE
Update a category
PATCH
Pages
Overview
Create a page
POST
Get a page
GET
Create a page under a page
POST
Delete a page
DELETE
Update a page
PATCH
Page Content
Overview
Get a page version
GET
Save page content
POST
Publish a draft
POST
Search
Overview
Semantic search
POST
Dashboard
Overview
Recently published pages
GET
Social
Overview
Service
Overview
Health check
GET
Communities
Overview
List communities
GET
Create a community
POST
List the general feed
GET
Read a community
GET
Delete a community
DELETE
Update a community
PATCH
Read a community by slug
GET
List your scheduled posts in a community
GET
List your drafts in a community
GET
Pin a community
POST
Unpin a community
DELETE
List a community's shared members
GET
List a community's per-user permissions (legacy)
GET
Posts
Overview
List a community's posts
GET
Create a post in a community
POST
Read a post in a community
GET
Delete a post in a community
DELETE
Update a post in a community
PATCH
Pin a post in a community
POST
Unpin a post in a community
DELETE
Read a post's publish date
GET
List a post's attachments
GET
Read a post in the general feed
GET
Delete a post in the general feed
DELETE
Update a post in the general feed
PATCH
Pin a post to the general feed
POST
Unpin a post from the general feed
DELETE
Read a post's publish date
GET
List a post's attachments
GET
Create a post in the general feed
POST
List your drafts
GET
List your scheduled posts
GET
Comments
Overview
List a post's comments
GET
Comment on a post
POST
Read a comment
GET
Delete a comment
DELETE
Edit a comment
PATCH
Pin a comment
POST
Unpin a comment
DELETE
List a post's comments
GET
Comment on a post
POST
Read a comment
GET
Delete a comment
DELETE
Edit a comment
PATCH
Pin a comment
POST
Unpin a comment
DELETE
Reactions
Overview
List a post's reactions
GET
React to a post
POST
Remove your reaction from a post
DELETE
List a comment's reactions
GET
React to a comment
POST
Remove your reaction from a comment
DELETE
List a post's reactions
GET
React to a post
POST
Remove your reaction from a post
DELETE
List a comment's reactions
GET
React to a comment
POST
Remove your reaction from a comment
DELETE
Polls
Overview
List a post poll's votes
GET
Read a poll with its votes
GET
Vote on a poll option
POST
Remove your vote from a poll option
POST
Tags
Overview
List tags
GET
Create a tag
POST
Search tags
GET
Delete a tag
DELETE
Delete several tags
POST
People
Overview
Search users
GET
Search members and groups
GET
A member's dashboard feed
GET
Follow a user
POST
Unfollow a user
POST
A member's pinned communities
GET
work.optidata.com
Overview
Contacts
Section titled “Contacts”
Listing, searching and autocompleting the caller’s address book.
Operations
Section titled “ Operations ”
GET
/contacts
GET
/contacts/search
GET
/contacts/autocomplete
