# Essal Developer Docs

## Docs

- [Groups](https://developers.essal.cloud/api-reference/access/groups.md): API reference for Essal Access group management — create groups, manage membership, and assign roles.
- [Sessions](https://developers.essal.cloud/api-reference/access/sessions.md): API reference for Essal Access session management — list active sessions, revoke, and check MFA status.
- [Users](https://developers.essal.cloud/api-reference/access/users.md): API reference for Essal Access user management — create, update, activate, deactivate, and manage users.
- [Applications](https://developers.essal.cloud/api-reference/careers/applications.md): API reference for Essal Careers applications — list, retrieve, advance stages, disqualify, and attach files.
- [Jobs](https://developers.essal.cloud/api-reference/careers/jobs.md): API reference for Essal Careers job postings — create, publish, pause, close, and manage application forms.
- [Stages](https://developers.essal.cloud/api-reference/careers/stages.md): API reference for Essal Careers pipeline stages — list, create, reorder, and delete hiring stages.
- [Alerts](https://developers.essal.cloud/api-reference/guard/alerts.md): API reference for Essal Guard alerts — rules, active alerts, lifecycle management, and notification channels.
- [Audit Logs](https://developers.essal.cloud/api-reference/guard/audit-logs.md): API reference for Essal Guard audit logs — query, filter, export, and configure retention.
- [Policies](https://developers.essal.cloud/api-reference/guard/policies.md): API reference for Essal Guard access policies — create, evaluate, test, activate, and delete policies.
- [Documents](https://developers.essal.cloud/api-reference/office/documents.md): API reference for Essal Office document operations — list, create, update, delete, and publish.
- [Files](https://developers.essal.cloud/api-reference/office/files.md): API reference for Essal Office file storage — upload, download, list, and delete files.
- [Sheets](https://developers.essal.cloud/api-reference/office/sheets.md): API reference for Essal Office spreadsheet operations — CRUD, cell range reads and writes.
- [API Overview](https://developers.essal.cloud/api-reference/overview.md): Overview of the Essal API — base URLs, versioning, request format, error codes, and pagination.
- [Projects](https://developers.essal.cloud/api-reference/project/projects.md): API reference for Essal Project projects — create, archive, apply templates, and manage members.
- [Tasks](https://developers.essal.cloud/api-reference/project/tasks.md): API reference for Essal Project tasks — full CRUD, subtasks, priorities, sprint assignment, and bulk operations.
- [Time Entries](https://developers.essal.cloud/api-reference/project/time-entries.md): API reference for Essal Project time entries — manual logging, start/stop timers, and reporting.
- [Contacts](https://developers.essal.cloud/api-reference/sales/contacts.md): API reference for Essal Sales contacts — create, search, update, merge, and delete contact records.
- [Deals](https://developers.essal.cloud/api-reference/sales/deals.md): API reference for Essal Sales deals — lifecycle management, stage transitions, activity logging, and closing.
- [Pipelines](https://developers.essal.cloud/api-reference/sales/pipelines.md): API reference for Essal Sales pipelines — configuration, stage management, and forecasting.
- [Create a Webhook](https://developers.essal.cloud/api-reference/webhooks/create.md): Register a new webhook subscription to receive Essal platform events at your endpoint.
- [Webhook Events](https://developers.essal.cloud/api-reference/webhooks/events.md): Complete reference of all event types available for webhook subscriptions in the Essal platform.
- [List Webhooks](https://developers.essal.cloud/api-reference/webhooks/list.md): List all webhook subscriptions registered in your Essal workspace.
- [Verify Webhooks](https://developers.essal.cloud/api-reference/webhooks/verify.md): Verify the authenticity of Essal webhook payloads using HMAC-SHA256 signature verification.
- [Changelog — April 10, 2026](https://developers.essal.cloud/changelog/2026-04-10.md): Essal platform release notes for April 10, 2026.
- [Changelog — May 20, 2026](https://developers.essal.cloud/changelog/2026-05-20.md): Essal platform release notes for May 20, 2026.
- [Changelog — June 15, 2026](https://developers.essal.cloud/changelog/2026-06-15.md): Essal platform release notes for June 15, 2026.
- [Changelog — July 1, 2026](https://developers.essal.cloud/changelog/2026-07-01.md): Essal platform release notes for July 1, 2026.
- [Apps](https://developers.essal.cloud/concepts/apps.md): An overview of the six Essal apps, how they relate to each other, and how they share data through the Core API.
- [Data Model](https://developers.essal.cloud/concepts/data-model.md): Understand the shared entity model that links records across Office, Sales, Careers, Project, and Guard.
- [Events](https://developers.essal.cloud/concepts/events.md): Understand Essal's async event system — how app-level events are produced, routed, and consumed via webhooks.
- [Organizations](https://developers.essal.cloud/concepts/organizations.md): Understand how Essal Organizations group multiple workspaces under a single account for enterprise deployments.
- [Users & Roles](https://developers.essal.cloud/concepts/users-and-roles.md): Understand how users, roles, and scopes work across the Essal platform.
- [Workspaces](https://developers.essal.cloud/concepts/workspace.md): Understand Essal Workspaces — the top-level container for all apps, members, billing, and configuration.
- [Authentication](https://developers.essal.cloud/getting-started/authentication.md): Authenticate with the Essal API using API keys or OAuth 2.0. Understand scopes, token lifetimes, and key rotation.
- [Environments](https://developers.essal.cloud/getting-started/environments.md): Understand Essal's sandbox, staging, and production environments and how to configure each.
- [Quickstart](https://developers.essal.cloud/getting-started/quickstart.md): Deploy Essal and make your first authenticated API request in under 10 minutes.
- [Rate Limits](https://developers.essal.cloud/getting-started/rate-limits.md): Understand Essal API rate limits, burst allowances, and how to handle 429 responses gracefully.
- [Manage Directories](https://developers.essal.cloud/guides/access/manage-directories.md): Sync Essal Access with LDAP directories or Active Directory and map groups to Essal roles.
- [Provision Users](https://developers.essal.cloud/guides/access/provision-users.md): Automate user provisioning and deprovisioning in Essal Access using SCIM 2.0.
- [Set Up SSO](https://developers.essal.cloud/guides/access/setup-sso.md): Configure SAML 2.0 or OIDC single sign-on in Essal Access, map identity provider claims to roles, and test the login flow.
- [Manage Hiring Pipeline](https://developers.essal.cloud/guides/careers/manage-pipeline.md): Move candidates through hiring stages, send automated communications, and run bulk status updates in Essal Careers.
- [Post a Job](https://developers.essal.cloud/guides/careers/post-job.md): Create job postings in Essal Careers, publish them to job boards, and manage their lifecycle via the API.
- [Review Applicants](https://developers.essal.cloud/guides/careers/review-applicants.md): Score, evaluate, and collaborate on candidates in Essal Careers using scorecards and interviewer assignments.
- [Configure Policies](https://developers.essal.cloud/guides/guard/configure-policies.md): Create and manage RBAC access policies in Essal Guard to control resource-level permissions across all apps.
- [Threat Alerts](https://developers.essal.cloud/guides/guard/threat-alerts.md): Configure anomaly detection rules in Essal Guard to automatically detect and route security threats.
- [View Audit Trail](https://developers.essal.cloud/guides/guard/view-audit-trail.md): Query, filter, and export the Essal Guard audit log to track all actions across the platform.
- [Collaborate in Real Time](https://developers.essal.cloud/guides/office/collaborate-in-real-time.md): Understand how Essal Office handles real-time collaborative editing, presence awareness, and conflict resolution.
- [Create a Document](https://developers.essal.cloud/guides/office/create-document.md): Learn how to create a document in Essal Office via the API, set permissions, and upload attachments.
- [Export Formats](https://developers.essal.cloud/guides/office/export-formats.md): Export Essal Office documents to PDF, DOCX, XLSX, and other formats using the async export API.
- [Create a Project](https://developers.essal.cloud/guides/project/create-project.md): Scaffold a new project in Essal Project, apply a template, and assign team members via the API.
- [Manage Tasks](https://developers.essal.cloud/guides/project/manage-tasks.md): Create, assign, and update tasks in Essal Project — including subtasks, priorities, and sprint assignment.
- [Track Time](https://developers.essal.cloud/guides/project/track-time.md): Log time entries against tasks in Essal Project, use the start/stop timer API, and generate time reports.
- [Import Contacts](https://developers.essal.cloud/guides/sales/import-contacts.md): Import contacts into Essal Sales via CSV upload or the API, with field mapping and deduplication options.
- [Manage Pipeline](https://developers.essal.cloud/guides/sales/manage-pipeline.md): Configure sales pipeline stages, move deals through them via the API, and use webhooks to trigger downstream actions.
- [Track Deals](https://developers.essal.cloud/guides/sales/track-deals.md): Create and manage deal records in Essal Sales, log activities, and use the revenue forecasting API.
- [OAuth Apps](https://developers.essal.cloud/integrations/oauth-apps.md): Register an OAuth app to build integrations that act on behalf of Essal users with scoped access.
- [Integrations Overview](https://developers.essal.cloud/integrations/overview.md): Overview of integration options available in the Essal platform — webhooks, OAuth apps, SSO, and third-party connectors.
- [SSO / SAML](https://developers.essal.cloud/integrations/sso-saml.md): Connect an identity provider to Essal Access using SAML 2.0 or OIDC for single sign-on.
- [Third-Party Integrations](https://developers.essal.cloud/integrations/third-party.md): Connect Essal to Slack, Zapier, Make, and other tools through the integrations marketplace.
- [Webhooks](https://developers.essal.cloud/integrations/webhooks.md): Set up and manage webhook subscriptions to receive real-time events from the Essal platform.
- [Introduction](https://developers.essal.cloud/introduction.md): Welcome to the Essal Developer Portal. Build, extend, and integrate with a unified suite of business apps covering documents, CRM, identity, recruiting, project management, and security.
- [Essal CLI](https://developers.essal.cloud/sdks/cli.md): Use the Essal CLI to manage your workspace, trigger API calls, and automate tasks from the terminal.
- [Go SDK](https://developers.essal.cloud/sdks/go.md): Install and use the official Essal Go SDK to access all six apps from your Go project.
- [Node.js / TypeScript SDK](https://developers.essal.cloud/sdks/node.md): Install and use the official Essal Node.js SDK to interact with all six apps from your TypeScript or JavaScript project.
- [SDKs Overview](https://developers.essal.cloud/sdks/overview.md): Official Essal SDKs for Node.js, Python, Ruby, and Go — installation, configuration, and basic usage.
- [Postman Collection](https://developers.essal.cloud/sdks/postman.md): Use the official Essal Postman collection to explore and test all API endpoints interactively.
- [Python SDK](https://developers.essal.cloud/sdks/python.md): Install and use the official Essal Python SDK to access all six apps from your Python project.
- [Ruby SDK](https://developers.essal.cloud/sdks/ruby.md): Install and use the official Essal Ruby SDK to access all six apps from your Ruby project.
- [Sandbox](https://developers.essal.cloud/sdks/sandbox.md): Use the Essal sandbox environment to safely test all API operations without affecting live data.
- [Audit Logs](https://developers.essal.cloud/security/audit-logs.md): How Essal Guard captures, stores, and surfaces audit trail data for all platform activity.
- [Data Privacy](https://developers.essal.cloud/security/data-privacy.md): How Essal handles your data — storage locations, data residency, deletion policies, and privacy controls.
- [Encryption](https://developers.essal.cloud/security/encryption.md): How Essal protects data at rest and in transit across all apps.
- [IP Allowlisting](https://developers.essal.cloud/security/ip-allowlisting.md): Restrict API access to trusted IP addresses and CIDR ranges using Essal Guard's IP allowlist.
- [Developer Support](https://developers.essal.cloud/support/contact.md): Get help with your Essal integration — channels, response times, and how to report issues.
- [FAQ](https://developers.essal.cloud/support/faq.md): Frequently asked questions about the Essal developer platform and API.
- [Migration Guide](https://developers.essal.cloud/support/migration-guide.md): Guide for teams migrating existing integrations to the Essal v1 API.
- [System Status](https://developers.essal.cloud/support/status.md): Monitor Essal platform uptime, incidents, and scheduled maintenance.

## OpenAPI Specs

- [openapi](https://developers.essal.cloud/api-reference/openapi.json)