EmberlyEmberly Docs

File Collaboration

Share files with specific users and collaborate with role-based edit permissions.

Emberly lets you share individual files with other users as collaborators. Collaborators can view, edit, or suggest changes depending on their role.


Adding a Collaborator

From the file detail page:

  1. Open the file in your dashboard
  2. Click ShareInvite Collaborator
  3. Enter the collaborator's email address or profile URL ID
  4. Choose a role: Editor or Viewer
  5. Click Invite

The collaborator receives an email notification and the file appears in their Shared with Me view.

Owner only

Only the file owner can add or remove collaborators.


Collaborator Roles

RoleViewDownloadSuggest EditsEdit Directly
Viewer
Editor

Edit Suggestions

When Allow Suggestions is enabled on a file, Editor-role collaborators can submit proposed edits that the owner can review and accept or reject.

Submitting a Suggestion

Editors can propose changes to a file's content. A suggestion is queued as PENDING until the owner acts on it.

Reviewing Suggestions

As the file owner:

  1. Open the file
  2. Go to the Suggestions tab
  3. Preview each suggestion
  4. Click Approve or Reject

Approved suggestions replace the file content. Rejected suggestions are dismissed.


Shared With Me

All files shared with you appear at embrly.ca/dashboard/files under the Shared filter. Each entry shows:

  • File name and type
  • Owner name and avatar
  • Your role (VIEWER / EDITOR)
  • Number of pending suggestions (Editors only)

API Reference

List Shared Files

GET /api/files/shared
Authorization: Bearer YOUR_UPLOAD_TOKEN

Query parameters:

ParameterTypeDefaultDescription
pagenumber1Page number
limitnumber20Items per page

Response:

{
  "data": [
    {
      "id": "clxyz...",
      "name": "design-brief.pdf",
      "urlPath": "/johndoe/design-brief.pdf",
      "mimeType": "application/pdf",
      "size": 204800,
      "visibility": "PRIVATE",
      "uploadedAt": "2026-01-10T14:00:00Z",
      "isPaste": false,
      "role": "EDITOR",
      "owner": {
        "id": "cluser...",
        "name": "Jane Smith",
        "urlId": "janesmith",
        "image": "https://..."
      },
      "pendingSuggestions": 2
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "pageCount": 1
  }
}

Get File Collaborators

GET /api/files/{id}/collaborators
Authorization: Bearer YOUR_UPLOAD_TOKEN

Returns the list of collaborators and whether suggestions are enabled. Only the file owner can call this endpoint.

Response:

{
  "collaborators": [
    {
      "role": "EDITOR",
      "user": {
        "id": "cluser...",
        "name": "Alex Johnson",
        "email": "[email protected]",
        "image": "https://...",
        "urlId": "alexj"
      }
    }
  ],
  "allowSuggestions": true
}

Add a Collaborator

POST /api/files/{id}/collaborators
Authorization: Bearer YOUR_UPLOAD_TOKEN
Content-Type: application/json

Body:

{
  "userEmail": "[email protected]",
  "role": "EDITOR"
}

You can use either userEmail or userUrlId. At least one is required.

FieldTypeRequiredDescription
userEmailstringone ofCollaborator's email address
userUrlIdstringone ofCollaborator's profile URL ID
rolestringnoEDITOR (default) or VIEWER

The collaborator receives an email notification upon being added.


Remove a Collaborator

DELETE /api/files/{id}/collaborators/{userId}
Authorization: Bearer YOUR_UPLOAD_TOKEN

Removes the specified user as a collaborator. Only the file owner can do this.


Get Suggestions

GET /api/files/{id}/suggestions?status=PENDING
Authorization: Bearer YOUR_UPLOAD_TOKEN
status valueDescription
PENDINGAwaiting owner review (default)
APPROVEDAlready accepted
REJECTEDAlready dismissed

Only the file owner can view suggestions.

On this page