Filestage API Documentation
This is the complete API documentation for connecting to the Filestage API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Filestage: Review and approval workspace for managing Filestage projects, files, reviewer groups, reviews, and comments. Keep reading to get started.
Quickstart
Before you run your first Filestage request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Filestage connection — create or choose one in Connections. Note its
connectionId.
Every Filestage action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/filestage/latest/actions/{actionSlug}You need a MindCloud API Key and a Filestage connection. Then call an action such as Download Comment Attachment:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/filestage/latest/actions/download-comment-attachment" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Filestage account that should run the action. MindCloud stores and refreshes the Filestage credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
Filestage actions
All 81 published actions for this Filestage version. Each page documents the endpoint, arguments, and response controls.
- POSTAdd Collaborators to Project
- POSTAdd New Section
- POSTAdd New Webhook
- POSTAdd Reviewer Group to Project
- POSTAdd Reviewer Group to Project Template
- POSTAdd Reviewers to Reviewer Group
- POSTAdd Section to Project Template
- POSTApprove a Version
- POSTApprove a Version With Changes
- PUTArchive or Unarchive Project by ID
- POSTCopy Comments Between Versions or Reviews
- POSTCreate Comment Reply
- POSTCreate Folder
- POSTCreate New Project Template
- POSTCreate Project
- POSTCreate Review Comment
- GETDownload Comment Attachment
- GETDownload File Version
- GETDownload Review Report of File
- GETDownload Review Report of Review
- POSTGenerate Presigned Upload URL
- GETGet Comment
- GETGet File by ID
- GETGet File URL
- GETGet Folder by ID
- GETGet Project by ID
- GETGet Review by ID
- GETGet Review Decision Count
- GETGet Reviewer Group by ID
- POSTImport Website
- POSTInvite Team Member
- POSTInvite Team Members
- GETList Comments by Review
- GETList File Reviews
- GETList File Reviews by Parameters
- GETList Files by Parameters
- GETList Files by Project
- GETList Files in Section
- GETList Folders
- GETList Mention Suggestions
- GETList Project Templates
- GETList Projects
- GETList Reviewer Groups by Project
- GETList Reviews for a Reviewer Group
- GETList Team Members
- GETList Team Roles
- GETList Webhooks
- PUTMove File to a Section
- PUTMove Project to a Folder
- PUTMove Section
- PUTPin or Unpin a Comment
- POSTReject a Version
- DELETERemove Collaborator
- DELETERemove Comment
- DELETERemove File
- DELETERemove File by External ID
- DELETERemove Project by ID
- DELETERemove Project Template
- DELETERemove Reviewer Group
- DELETERemove Reviewers from Reviewer Group
- DELETERemove Section
- DELETERemove Team Member by Email or IdP ID
- DELETERemove Team Member by Member ID
- DELETERemove Webhook by ID
- PUTRename Project by ID
- PUTRename Project Template
- PUTRename Reviewer Group
- PUTRename Section
- POSTRequest Changes
- PUTSet Review Due Date
- POSTStart a Review
- POSTSubmit a Review Decision
- DELETEUndo Review Decision
- PUTUpdate Comment
- PUTUpdate Comment Resolution
- PUTUpdate Review Status
- PUTUpdate Reviewer Group Settings
- PUTUpdate Role of Team Member
- PUTUpdate Team Member
- PUTUpdate Webhook by ID
- POSTUpload File
Related apps
More Content & Files apps on the Universal API, behind the same REST shape. Or browse all apps.