Egnyte's Public API enables you directly access content and manage a domain using your own application. This section houses the technical details for each of our endpoints and is updated periodically as new endpoints are added. Below, you'll find a brief overview of the different methods you can access once you register for a key.

Getting StartedThe Egnyte Public API enables developers to build applications that interact with an Egnyte domain programmatically. Using these APIs, you can integrate Egnyte with internal systems, automate workflows, build custom applications, and extend Egnyte functionality into your own products.Get Started

AuthenticationThis section describes the ways your application can authenticate with Egnyte. You must get an access token from one of these authorization flows in order to send a valid request to any other endpoint.Methods

Best PracticesThis guide covers essential best practices for working with the Egnyte Public API, including authentication, rate limiting, data formatting, and error handling.Read

AgentsThe Egnyte Agent API allows you to access Agents in Egnyte like getting the list of available custom agents, executing the agent and polling the execution status and the response of an agent execution job.Methods

Agentic CLIThe Egnyte Agentic CLI is a command-line tool for interacting with the Egnyte API from terminals, CI pipelines, and AI coding agents. JSON-only output, schema introspection, and mandatory dry-run for mutations.Guide

AIThe Egnyte AI API allows you to access AI features supported by Egnyte via API such as ask a question and generate the summary of a document, ask a question to AI Assistant, Knowledge Bases, etc.Methods

Audit Reporting V1The Audit Reporting API allows you to programmatically generate and retrieve reports on login activity, file actions, and permission changes. The scope of these reports effectively gives you a 360° view of the activity in your account.Methods

Audit Reporting V2The Audit Reporting API v2 lets you retrieve audit records for login activity, file actions, permission changes, configuration changes, and more. This streaming API provides near real-time access to events from the last 7 days.Methods

BookmarksThe Bookmarks API allows you to create a bookmark on a folder, list all bookmarks, list the details for a specific bookmark, and delete a bookmark.Methods

CommentsThe Comments API allows you to create a comment, list all comments for a file, and list the details for a specific comment. Comments can also be referred to as notes.Methods

Controlled Document ManagementThe Controlled Document Management API allows you to import documents and training assignments into the Egnyte Controlled Document Management app to migrate or integrate external document control workflows.Methods

Document PortalThe Document Portal API allows you to list and create workspaces programmatically, integrating Egnyte document portal functionality into your applications and workflows.Methods

ETMFThe eTMF (Electronic Trial Master File) API enables you to manage clinical trial documentation programmatically — query study details, retrieve filing levels, list artifacts and milestones, and import documents.Methods

EventsThe Event API lets you retrieve recent changes that have occurred in Egnyte. This can be used to detect an event that should trigger activity in your application or can help you maintain state between an Egnyte domain and your application.Methods

File System ManagementThe File System API allows you to perform file system actions like: create, update, move, copy, delete, download, and list information about files and folders. Since most use cases involve some basic file system operation, this is one of our core APIs.Methods

Folder OptionsThe Folder Options API allows you to modify folder settings in your Egnyte domain, including descriptions, link sharing permissions, move/delete restrictions, and email notification preferences.Methods

Group ManagementThe Group Management API allows you to create, edit and delete groups. You can also use this API to inspect and manage group membership.Methods

LinksOur Link API allows you to create and manage file and folder links so that you can share content with ease. You can also customize links in several ways: set a click or date based expiry, require recipients to log in before accessing content, and more.Methods

MetadataThe Metadata API (Beta Version) allows you to create namespaces of custom metadata fields (keys) and get/set metadata values. You can set metadata in the context of a file, specific file version, or folder.Methods

Mobile DevelopmentGuide for deep-linking into the Egnyte mobile app on iOS, Android, and Windows from your own native or web application using URL schemes to launch the app and open specific folders.Guide

MSPEgnyte MSP Public API exposes endpoints which provides reseller information.Methods

NavigateThe Navigate API allows you to start an Egnyte Web UI session in the web browser with a public API token. The token is required to have an Egnyte.launchwebsession scope.Methods

PermissionsThe Permissions API allows you to list, set, and remove folder permissions for users or groups. You can also get the effective permission for a user, which takes into account group and individual permissions on a given folder.Methods

Project Custom MetadataThe Project Custom Fields API lets you define structured metadata tailored to your workflows. Create fields once and they appear everywhere within your project's scope.Methods

Project FolderThe Project Folder API allows you to search, create, modify, and delete Project folders.Methods

Remote MCP ServerThe Egnyte MCP Server is a fully-managed Model Context Protocol server that enables secure integration between your Egnyte content and AI tools like Claude and ChatGPT via OAuth 2.0.Guide

SearchThe Search API lets you search for content stored in Egnyte based on filenames, metadata, and content. Your application can benefit from Egnyte's robust search capabilities without needing to index the content in your own application.Methods

SignThe Egnyte Sign API allows you to create a new signature request, list templates and signature requests, and cancel them.Methods

Third-Party IntegrationsThe Third-Party Integrations API provides endpoints for managing integrations with external applications including Salesforce and Procore to retrieve folder mappings and linked records.Methods

TrashThe Trash API allows you to programmatically move files and folders to the trash, permanently delete items in the trash, empty the trash, and restore items from the trash.Methods

UI Integration FrameworkThe UI Integration Framework enables app developers to hook into the Egnyte Web UI to expose custom actions for their app. Currently, you can extend the "More" menu and the Context menu.Process

Upload RequestsThe Upload Requests API allows you to send upload requests to internal or external users and retrieve available upload request templates to automate document collection workflows.Methods

User InsightsThe User Insights API provides you with the information about the files a user has recently accessed.Methods

User ManagementThe User Management API allows you to create, update, get information about, and delete users. You can leverage our user schema to customize settings like user role or authentication type and even control whether a new user receives an invitation email.Methods

WebhooksThe Webhooks API lets you subscribe to real-time push notifications for events in your Egnyte domain — file uploads, folder changes, permission updates, and more — without polling the Events API.Methods

WorkflowThe Workflow API allows you to create a new workflow, list tasks and workflows, and cancel workflows.Methods