API v1 ReferenceCompany Files

Returns all files of the company with the specified id.

Returns all file metadata of the company with the specified id.

Path parameters

companyIdUUIDRequired

The id of the company.

Headers

AuthorizationstringRequired

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

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 nullOptional

The user-specified name of the file.

descriptionstring or nullOptional

The description of the file.

idUUIDOptional

The id of the file info.

entityIdUUID or nullOptional

The id of the linked entity.

fileNamestring or nullOptional

The name of the file.

entityTypestring or nullOptional

The name of the linked entity type.

mimeTypestring or nullOptional

The MIME type of the file.

createdOndatetimeOptional

The date this file was created.

createdByUUIDOptional

The id of the user who created this file.

updatedOndatetimeOptional

The date this file was last modified.

updatedByUUIDOptional

The id of the user who last modified this file.

fileVersionslist of objectsOptional

List of all versions.

isCommentFilebooleanOptional

Whether the file is related to a comment.

externalProviderstring or nullOptional

The external provider for the file. Like ‘google’ or ‘onedrive’.

externalFileUrlstring or nullOptional

The file url of the external provider.

isHiddenForConnectUsersbooleanOptional

Whether the file is hidden for connect users.