LogoLogo
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
SupportDeveloper ForumLogin
API v1 ReferenceWorkspace Files

Returns the file with the specified id of the workspace with the specified id.

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

Path parameters

workspaceIdUUIDRequired
The id of the workspace.
fileIdUUIDRequired
The id of the file.

Headers

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

Response

OK
namestring or null

The user-specified name of the file.

descriptionstring or null
The description of the file.
idUUID or null
The id of the file info.
entityIdUUID or null
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.
createdOndatetime or null
The date this file was created.
createdByUUID or null
The id of the user who created this file.
updatedOndatetime or null
The date this file was last modified.
updatedByUUID or null
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.
Was this page helpful?
Previous

Updates the metadata of the workspace file with the specified id.

Next
Built with
The id of the workspace.
The id of the file.
OK

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