SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceWorkspace Files

GET
https://api.awork.com/api/v1/workspaces/:workspaceId/files
GET
/api/v1/workspaces/:workspaceId/files
1curl https://api.awork.com/api/v1/workspaces/workspaceId/files \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1[
2  {
3    "name": "Final project report",
4    "description": "The client requested a cost overview and timeline",
5    "id": "123e4567-e89b-12d3-a456-426614174000",
6    "entityId": "123e4567-e89b-12d3-a456-426614174000",
7    "fileName": "Final project report.xlsx",
8    "entityType": "project",
9    "mimeType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
10    "createdOn": "2024-01-15T09:30:00Z",
11    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
12    "updatedOn": "2024-01-15T09:30:00Z",
13    "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
14    "fileVersions": [
15      {
16        "id": "123e4567-e89b-12d3-a456-426614174000",
17        "fileInfoId": "123e4567-e89b-12d3-a456-426614174000",
18        "version": 13,
19        "size": 13590,
20        "width": 1920,
21        "height": 1200,
22        "createdOn": "2024-01-15T09:30:00Z",
23        "createdBy": "123e4567-e89b-12d3-a456-426614174000",
24        "updatedOn": "2024-01-15T09:30:00Z",
25        "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
26      }
27    ],
28    "isCommentFile": false,
29    "externalProvider": "string",
30    "externalFileUrl": "string",
31    "isHiddenForConnectUsers": true
32  }
33]
Was this page helpful?
Previous

Creates a new workspace file for the workspace with the specified id..

Next
Built with
Returns all file metadata of the workspace with the specified id.
Returns all files of the workspace with the specified id.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

workspaceIdstringRequiredformat: "uuid"
The id of the workspace.

Query Parameters

pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

OK
namestring or null

The user-specified name of the file.

descriptionstring or null
The description of the file.
idstring or nullformat: "uuid"
The id of the file info.
entityIdstring or nullformat: "uuid"
The id of the linked entity.
fileNamestring or null
The name of the file.
entityTypestring or null
The name of the linked entity type.
mimeTypestring or null
The MIME type of the file.
createdOnstring or nullformat: "date-time"
The date this file was created.
createdBystring or nullformat: "uuid"
The id of the user who created this file.
updatedOnstring or nullformat: "date-time"
The date this file was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this file.
fileVersionslist of objects or null
List of all versions.
isCommentFileboolean or null
Whether the file is related to a comment.
externalProviderstring or null
The external provider for the file. Like 'google' or 'onedrive'.
externalFileUrlstring or null
The file url of the external provider.
isHiddenForConnectUsersboolean or null
Whether the file is hidden for connect users.
Page number for pagination
Number of items per page
The properties to order by
The filter expression to filter by
OK