Â
epilot API
Integrate with all platform features programmatically using RESTful APIs
Â
Authentication
All requests require a Bearer token in the Authorization header.
curl https://entity.sls.epilot.io/v1/entity/schemas \
-H "Authorization: Bearer <token>"Generate API tokens from the epilot portal. See Access Tokens for details.
SDK
The epilot SDK provides typed TypeScript clients for every API.
npm i --save @epilot/entity-client
# or
yarn add @epilot/entity-clientEntities
Business objects like contacts, orders, products, and contracts are represented as entities. Flexible JSON objects backed by user-definable schemas. The platform ships with a standard set of core entities, and organizations can extend schemas or define entirely new entity types via the Entity API.
Webhooks
Receive real-time notifications when events occur on the platform. Configure endpoints via the Webhooks API and subscribe to any of the standardized core event types
See the Webhooks guide for setup, payload structure, and signature verification.
Versioning
epilot maintains strong backwards compatibility commitments for all public APIs.
Compatibility Guarantees
- No breaking changes — existing API endpoints, request/response schemas, and webhook payloads remain backwards compatible
- Additive changes only — new fields, parameters, and endpoints may be added; consumers should ignore unknown fields
- Minimum two years support — any published API route is supported for at least two years
Deprecation Policy
- 12-month notice — breaking changes are announced at least 12 months in advance
- OpenAPI marking — deprecated operations are marked in API definitions
- Changelog — all deprecations are published in the API Changelog
Exceptions: Security vulnerabilities or regulatory requirements may necessitate changes on shorter notice.
Breaking Changes
The following are considered breaking changes:
- Removing an API endpoint (sunsetting)
- Removing or renaming request parameters or response fields
- Changing field types or formats
- Changing error codes for existing scenarios
- Tightening validation on existing parameters
Changelog
Breaking changes, new endpoints, and updates are published in the API Changelog.
Subscribe via RSS to stay up to date.