Files API

File public API endpoints are available under /public/v1/files.

Use these endpoints for file records and metadata. Actual upload behavior should follow the generated OpenAPI reference for the current deployment.

Common Operations

• List files.
• Get a file.
• Create file metadata after an upload flow.
• Update file metadata.
• Delete a file.

Useful Filters and Includes

Filters include:

• search
• file_type
• parent_id
• uploader_id

Includes include:

• folder
• shares
• tags
• uploader

Integration Notes

Store returned file IDs in your integration database. This lets you attach, update, or delete the same Agiled file record later instead of creating duplicates.

For migrations, list a small sample after upload and confirm folder placement, record attachment, preview, and download behavior from the Agiled UI.

Use backend jobs for file API work. Do not expose API tokens or upload metadata write access in browser code. If your integration mirrors files from another system, keep the external file ID alongside the Agiled file ID for safe retries.

Before Deleting Files

Check whether the file is attached to a customer record, invoice, estimate, document, project, ticket, or shared link. Delete only when the integration owns the file lifecycle or a human has confirmed the file should be removed.

Migration Review

After a file migration, sample files from each folder, file type, and source system. Confirm preview, download, record attachment, uploader context, and permissions from the Agiled UI before deleting source-system files or telling users the migration is complete.

Keep a mapping table of external file ID, Agiled file ID, folder, and attached record so retries update the same file instead of creating duplicates.

Permissions Review

Files can carry customer, finance, HRM, or project context. Before exposing file links or syncing files into another system, confirm which users should see the file and whether it is attached to a record with restricted access.

For customer-facing files, test preview and download from the same access path a customer or teammate will use.

Related Docs

• Upload a File with the API
• Files
• API Reference