Skip to main content

 

epilot

epilot API

Integrate with all platform features programmatically using RESTful APIs

API ReferenceChangelog

 

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-client

Entities

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.

Changelog

Breaking changes, new endpoints, and updates are published in the API Changelog.

Subscribe via RSS to stay up to date.

API Reference

APISDK Client
Access Token API@epilot/access-token-client
User API@epilot/user-client
Organization API@epilot/organization-client
Entity API@epilot/entity-client
Purpose API@epilot/purpose-client
Batch API@epilot/batch-client
Submission API@epilot/submission-client
Pricing API@epilot/pricing-client
Dashboard API@epilot/dashboard-client
Query API@epilot/query-client
Webhooks API@epilot/webhooks-client
Permissions API@epilot/permissions-client
Email Settings API@epilot/email-settings-client
Message API@epilot/message-client
File API@epilot/file-client
Journey API@epilot/journey-client
Address Suggestions API@epilot/address-suggestions-client
Document API@epilot/document-client
Automation API@epilot/automation-client
Entity Mapping API@epilot/entity-mapping-client
Template Variables API@epilot/template-variables-client
Portal API@epilot/customer-portal-client
Metering API@epilot/metering-client
Billing API@epilot/billing-client
Email Template API@epilot/email-template-client
Workflow Definition API@epilot/workflow-definition-client
Workflow Execution API@epilot/workflow-execution-client
Notes API@epilot/notes-client
Consent API@epilot/consent-client
Partner API@epilot/partner-client
Notification API@epilot/notification-client
Blueprint Manifest API@epilot/blueprints-client
Design API@epilot/design-client
Product API@epilot/product-client
Customer API@epilot/customer-client
Opportunity API@epilot/opportunity-client
Order API@epilot/order-client
Kanban API@epilot/kanban-client
Validation Rules API@epilot/validation-rules-client
ERP Integration API@epilot/erp-integration-client
App API@epilot/app-client