API Documentation

REST API reference for the CRM platform

Authentication

Bearer Token

Authorization: Bearer <your_token>

API Key

X-API-Key: <your_api_key>

Base URL

http://localhost:3001/api/v1

Endpoints

Contacts

5 endpoints

GET
/contacts

Retrieve a list of all contacts

POST
/contacts

Create a new contact

GET
/contacts/:id

Retrieve a specific contact by ID

PATCH
/contacts/:id

Update an existing contact

DELETE
/contacts/:id

Delete a contact

Companies

5 endpoints

GET
/companies

Retrieve a list of all companies

POST
/companies

Create a new company

GET
/companies/:id

Retrieve a specific company by ID

PATCH
/companies/:id

Update an existing company

DELETE
/companies/:id

Delete a company

Leads

5 endpoints

GET
/leads

Retrieve a list of all leads

POST
/leads

Create a new lead

GET
/leads/:id

Retrieve a specific lead by ID

PATCH
/leads/:id

Update an existing lead

DELETE
/leads/:id

Delete a lead

Deals

5 endpoints

GET
/deals

Retrieve a list of all deals

POST
/deals

Create a new deal

GET
/deals/:id

Retrieve a specific deal by ID

PATCH
/deals/:id

Update an existing deal

DELETE
/deals/:id

Delete a deal

Pipelines

5 endpoints

GET
/pipelines

Retrieve a list of all pipelines

POST
/pipelines

Create a new pipeline

GET
/pipelines/:id

Retrieve a specific pipeline by ID

PATCH
/pipelines/:id

Update an existing pipeline

DELETE
/pipelines/:id

Delete a pipeline

Tasks

5 endpoints

GET
/tasks

Retrieve a list of all tasks

POST
/tasks

Create a new task

GET
/tasks/:id

Retrieve a specific task by ID

PATCH
/tasks/:id

Update an existing task

DELETE
/tasks/:id

Delete a task

Activities

1 endpoints

GET
/activities/entity/:entityType/:entityId

Retrieve activities for a specific entity

Email Templates

5 endpoints

GET
/email-templates

Retrieve a list of all email templates

POST
/email-templates

Create a new email template

GET
/email-templates/:id

Retrieve a specific email template by ID

PATCH
/email-templates/:id

Update an existing email template

DELETE
/email-templates/:id

Delete an email template

Import / Export

2 endpoints

POST
/import-export/import/:entity

Import data for a specific entity type

GET
/import-export/export/:entity

Export data for a specific entity type