Documents

The Document entity set provides endpoints for managing files, hyperlinks, file links, and folder structures within projects. Documents can be organized into folders and linked to other entities.

---

Document

A document represents a file, hyperlink, or file link stored within a project. Documents support metadata, notes, favorites, and relations to other entities.

Properties

Property	Type	Description
DocumentId	Guid	Primary key. Unique identifier for the document.
FileName	string	Name of the file including extension.
ProjectId	Guid?	Foreign key to the associated project.
DocumentFolderId	Guid?	Foreign key to the parent folder.
DescriptionHTML	string	HTML-formatted description of the document.
OutlookPreviewText	string	Preview text extracted from Outlook messages.
IsInternetLink	bool	Whether the document is a web URL.
IsFileLink	bool	Whether the document is a link to a local or network file.
IsStandardFile	bool	Whether the document is an uploaded file.
StoreType	int?	Storage backend type identifier.
PhysicalId	string	Internal storage identifier for the physical file.
IsOrphaned	bool	Whether the document has lost its association to a project or folder.
SourceFolder	string	Original source folder path.
DocumentFolderPath	string	Full path of the document within the folder structure.
CreatedByContactId	Guid?	Contact who created the document.
FileType	string	MIME type or file extension classification.
State	int?	Current state of the document.
UpdatedAt	DateTimeOffset	Timestamp when the document was last updated.
CreatedAt	DateTimeOffset	Timestamp when the document was created.

Endpoints

List Documents

GET/odata/Document

Returns all documents. Supports OData query options.

GET /odata/Document?$filter=ProjectId eq {projectId}&$orderby=CreatedAt desc

Create Document

POST/odata/Document

Creates a new document entry.

{
  "FileName": "report.pdf",
  "ProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "IsStandardFile": true
}

Get Document

GET/odata/Document({key})

Returns a single document by its ID.

Parameter	Type	Required	Description
key	Guid	✅	The DocumentId.

Update Document

PATCH/odata/Document({key})

Partially updates an existing document.

Parameter	Type	Required	Description
key	Guid	✅	The DocumentId.

Delete Document

DELETE/odata/Document({key})

Deletes a document.

Parameter	Type	Required	Description
key	Guid	✅	The DocumentId.

Count Documents

GET/odata/Document/$count

Returns the total number of documents.

Functions

Get Documents for Object

GET/odata/Document({key})/GetDocumentsForObject()

Returns all documents linked to a specific object.

Parameter	Type	Required	Description
key	Guid	✅	The object ID to retrieve documents for.

Get Related Items

GET/odata/Document({key})/GetRelatedItems()

Returns all entities related to the specified document.

Parameter	Type	Required	Description
key	Guid	✅	The DocumentId.

Get Tracked Documents for Project

GET/odata/Document/GetTrackedDocumentsForProject(projectId={projectId})

Returns documents being tracked within a project.

Parameter	Type	Required	Description
projectId	Guid	✅	The ProjectId to query tracked documents for.

Check for Document by Internet Message ID

GET/odata/Document/HasDocumentWithInternetMessageIdInProject(internetMessageId={internetMessageId},projectId={projectId})

Checks whether a document with the given Internet Message ID exists in a project.

Parameter	Type	Required	Description
internetMessageId	string	✅	The Internet Message ID (e.g., from an email header).
projectId	Guid	✅	The ProjectId to search within.

tip

Use this function to prevent duplicate email imports by checking if an email has already been stored.

Get File Upload Size Limit

GET/odata/Document/GetFileUploadSizeLimit()

Returns the maximum allowed file upload size in bytes.

Toggle Favorite

GET/odata/Document({key})/ToggleFavorite(isFavorite={isFavorite})

Marks or unmarks a document as a favorite.

Parameter	Type	Required	Description
key	Guid	✅	The DocumentId.
isFavorite	bool	✅	Set to true to mark as favorite, false to unmark.

Actions

Add Note

POST/odata/Document({key})/AddNote

Adds a note to the document.

Parameter	Type	Required	Description
key	Guid	✅	The DocumentId.

Delete Note

GET/odata/Document/DeleteNote(noteRelationId={noteRelationId})

Removes a note from a document.

Parameter	Type	Required	Description
noteRelationId	Guid	✅	The ID of the note-document relation to remove.

Add Hyperlink

POST/odata/Document/AddHyperlink

Creates a new document entry from a URL.

{
  "FileName": "InLoox Homepage",
  "Url": "https://www.inloox.com",
  "ProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Add File Link

POST/odata/Document/AddFileLink

Creates a new document entry that links to a file on disk or a network share.

{
  "FileName": "Shared Report",
  "FilePath": "\\\\server\\share\\report.xlsx",
  "ProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Change File Link

POST/odata/Document/ChangeFileLink

Updates the target path of an existing file link.

---

DocumentFolder

Document folders organize documents into a hierarchical directory structure within a project.

Properties

Property	Type	Description
DocumentFolderId	Guid	Primary key. Unique identifier for the folder.
ParentDocumentFolderId	Guid?	Foreign key to the parent folder. Null for root folders.
FolderName	string	Display name of the folder.
RelativePath	string	Relative path of the folder within the project.
ProjectId	Guid?	Foreign key to the associated project.
IsOrphaned	bool	Whether the folder has lost its parent reference.
CreatedDate	DateTimeOffset	Timestamp when the folder was created.

Endpoints

GET/odata/DocumentFolder

Returns all document folders.

POST/odata/DocumentFolder

Creates a new document folder.

{
  "FolderName": "Contracts",
  "ProjectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ParentDocumentFolderId": null
}

GET/odata/DocumentFolder({key})

Returns a single folder by its ID.

PATCH/odata/DocumentFolder({key})

Updates an existing folder.

DELETE/odata/DocumentFolder({key})

Deletes a folder.

GET/odata/DocumentFolder/$count

Returns the total number of document folders.

---

DocumentFolderStructure

Document folder structures define rules for automatic folder creation based on project field values.

Properties

Property	Type	Description
DocumentStructureId	Guid	Primary key. Unique identifier for the structure rule.
FolderPath	string	Folder path template to create.
RuleField	string	The project field used to evaluate the rule.
RuleExpression	string	Expression that determines when the folder is created.

info

Folder structure rules automate directory creation. When a project matches the defined RuleField and RuleExpression, the corresponding folder hierarchy is created automatically.

Endpoints

POST/odata/DocumentFolderStructure

Creates a new folder structure rule.

GET/odata/DocumentFolderStructure({key})

Returns a single folder structure rule by its ID.

PATCH/odata/DocumentFolderStructure({key})

Updates an existing folder structure rule.

DELETE/odata/DocumentFolderStructure({key})

Deletes a folder structure rule.

GET/odata/DocumentFolderStructure/$count

Returns the total number of folder structure rules.