API Documentation
REST API reference for the CRM platform
Authentication
Bearer Token
API Key
Base URL
Endpoints
Contacts
5 endpoints
/contactsRetrieve a list of all contacts
/contactsCreate a new contact
/contacts/:idRetrieve a specific contact by ID
/contacts/:idUpdate an existing contact
/contacts/:idDelete a contact
Companies
5 endpoints
/companiesRetrieve a list of all companies
/companiesCreate a new company
/companies/:idRetrieve a specific company by ID
/companies/:idUpdate an existing company
/companies/:idDelete a company
Leads
5 endpoints
/leadsRetrieve a list of all leads
/leadsCreate a new lead
/leads/:idRetrieve a specific lead by ID
/leads/:idUpdate an existing lead
/leads/:idDelete a lead
Deals
5 endpoints
/dealsRetrieve a list of all deals
/dealsCreate a new deal
/deals/:idRetrieve a specific deal by ID
/deals/:idUpdate an existing deal
/deals/:idDelete a deal
Pipelines
5 endpoints
/pipelinesRetrieve a list of all pipelines
/pipelinesCreate a new pipeline
/pipelines/:idRetrieve a specific pipeline by ID
/pipelines/:idUpdate an existing pipeline
/pipelines/:idDelete a pipeline
Tasks
5 endpoints
/tasksRetrieve a list of all tasks
/tasksCreate a new task
/tasks/:idRetrieve a specific task by ID
/tasks/:idUpdate an existing task
/tasks/:idDelete a task
Activities
1 endpoints
/activities/entity/:entityType/:entityIdRetrieve activities for a specific entity
Email Templates
5 endpoints
/email-templatesRetrieve a list of all email templates
/email-templatesCreate a new email template
/email-templates/:idRetrieve a specific email template by ID
/email-templates/:idUpdate an existing email template
/email-templates/:idDelete an email template
Import / Export
2 endpoints
/import-export/import/:entityImport data for a specific entity type
/import-export/export/:entityExport data for a specific entity type