Workspaces

A Workspace is a lightweight way to organize related resources inside a single Files.com Site.

Customers commonly group resources by project, department, client, or region. Workspaces provide a built-in structure for that grouping, so the UI can operate within a clear “workspace context” and admins can delegate management for a subset of resources without requiring full site-level isolation.

Every Site has an implicit Default workspace (ID 0). Resources that are not explicitly assigned to a named workspace are considered part of the Default workspace.

List Workspaces

Endpoint

GET/workspaces

Return Object

Workspace[]

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

curl https://app.files.com/api/rest/v1/workspaces.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "name": "Project Alpha"
  }
]

Show Workspace

Endpoint

GET/workspaces/{id}

Return Object

Workspace

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
id
int64
Required		Workspace ID.

Example Request

curl https://app.files.com/api/rest/v1/workspaces/{id}.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "name": "Project Alpha"
}

Create Workspace

Endpoint

POST/workspaces

Return Object

Workspace

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
name
string		Workspace name

Example Request

curl https://app.files.com/api/rest/v1/workspaces.json \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{"name":"Project Alpha"}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "name": "Project Alpha"
}

Update Workspace

Endpoint

PATCH/workspaces/{id}

Return Object

Workspace

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
id
int64
Required		Workspace ID.
name
string		Workspace name

Example Request

curl https://app.files.com/api/rest/v1/workspaces/{id}.json \
  -X PATCH \
  -H 'Content-Type: application/json' \
  -d '{"name":"Project Alpha"}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "name": "Project Alpha"
}

Delete Workspace

Endpoint

DELETE/workspaces/{id}

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Request Parameters

ParameterDescription
id
int64
Required		Workspace ID.

Example Request

curl https://app.files.com/api/rest/v1/workspaces/{id}.json \
  -X DELETE \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

The Workspace Object

Some of the endpoints above return a Workspace object. The attributes of this object are listed below.

AttributeDescription
id
int64		Workspace ID
name
string		Workspace name

Example Workspace Object

{
  "id": 1,
  "name": "Project Alpha"
}