Skip to main content

SDK

[GitHub]

tip

Every epilot API ships with a typed TypeScript client — full types and IntelliSense out of the box.

Getting Started​

Install the client for the API you need:

Install
npm install --save @epilot/entity-client

Authorize with an Access Token and call an API:

Create a contact entity
import { getClient } from '@epilot/entity-client';

const entityClient = getClient();
entityClient.defaults.headers['Authorization'] = 'Bearer <your-access-token>';

await entityClient.createEntity('contact', {
first_name: 'Example',
last_name: 'Contact',
});

Available Clients​

All clients are published on npm under the @epilot scope and listed on GitHub: epilot-dev/sdk-js/clients

PackageAPI Docs
@epilot/access-token-clientAccess Token API
@epilot/address-suggestions-clientAddress Suggestions API
@epilot/app-clientApp API
@epilot/automation-clientAutomation API
@epilot/billing-clientBilling API
@epilot/blueprint-manifest-clientBlueprint Manifest API
@epilot/consent-clientConsent API
@epilot/customer-portal-clientPortal API
@epilot/design-clientDesign API
@epilot/document-clientDocument API
@epilot/email-settings-clientEmail Settings API
@epilot/email-template-clientEmail Template API
@epilot/entity-clientEntity API
@epilot/entity-mapping-clientEntity Mapping API
@epilot/erp-integration-clientERP Integration API
@epilot/file-clientFile API
@epilot/journey-clientJourney API
@epilot/kanban-clientKanban API
@epilot/message-clientMessage API
@epilot/metering-clientMetering API
@epilot/notes-clientNotes API
@epilot/notification-clientNotification API
@epilot/organization-clientOrganization API
@epilot/partner-directory-clientPartner API
@epilot/permissions-clientPermissions API
@epilot/pricing-clientPricing API
@epilot/purpose-clientPurpose API
@epilot/submission-clientSubmission API
@epilot/template-variables-clientTemplate Variables API
@epilot/user-clientUser API
@epilot/validation-rules-clientValidation Rules API
@epilot/webhooks-clientWebhooks API
@epilot/workflow-clientWorkflow Execution API
@epilot/workflow-definition-clientWorkflow Definition API