Introduction
B2B CRM Api Documentation
Authentication
HTTP: Bearer Auth
Default JWT Authorization
| Security Scheme Type | http |
|---|---|
| HTTP Authorization Scheme | Bearer |
| Bearer format | JWT |
API Reference
Below is a categorized list of all available API endpoints with their HTTP methods and routes.
📂 API Keys
| Method | Path | Description |
|---|---|---|
POST | /api-keys | Create a new API key |
GET | /api-keys/{id} | Get an API key by ID |
PATCH | /api-keys/{id}/regenerate | Regenerate an API key |
PATCH | /api-keys/{id}/soft-delete | Soft delete an API key |
PATCH | /api-keys/{id}/status | Update the status of an API key |
📂 Company
| Method | Path | Description |
|---|---|---|
POST | /company | Create a new company |
DELETE | /company | Delete a company |
GET | /company/account-owner/{accountOwnerId} | Get companies by account owner ID |
POST | /company/all | Get all companies |
GET | /company/check-permissions | Check import permissions |
GET | /company/columns | Get company entity columns |
POST | /company/create-bulk | Create bulk companies |
DELETE | /company/delete/{id} | Delete a company |
GET | /company/export | Generate Excel file |
GET | /company/get-name-and-id | Get company name and ID |
POST | /company/import | Import companies |
PATCH | /company/restore | Restore companies |
GET | /company/simple | Get simple companies |
DELETE | /company/soft | Soft delete companies |
PATCH | /company/update/{id} | Update a company |
POST | /company/upload-excel | Upload Excel file |
GET | /company/{id} | Get a company by ID |
📂 Lead
| Method | Path | Description |
|---|---|---|
POST | /lead | Create a new lead |
DELETE | /lead | Delete leads |
POST | /lead/all | Get all leads |
GET | /lead/check-permissions | Check import permissions |
GET | /lead/columns | Get lead entity columns |
DELETE | /lead/delete/{id} | Delete a lead |
GET | /lead/export | Generate Excel file |
GET | /lead/get-name-and-id | Get lead name and ID |
POST | /lead/import | Import leads |
GET | /lead/lead/{id} | Get a lead by ID |
POST | /lead/leads-bulk | Create bulk leads |
POST | /lead/persons-to-leads | Convert persons to leads |
PATCH | /lead/restore | Restore leads |
DELETE | /lead/soft | Soft delete leads |
PUT | /lead/{id} | Update a lead |
PATCH | /lead/{id}/update-with-person | Update a lead with a person |
📂 Person
| Method | Path | Description |
|---|---|---|
POST | /person | Create a new person |
DELETE | /person | Delete persons |
POST | /person/all | Get all persons |
GET | /person/check-permissions | Check import permissions |
GET | /person/columns | Get person entity columns |
POST | /person/create-bulk | Create bulk persons |
DELETE | /person/delete/{id} | Delete a person |
GET | /person/export | Generate Excel file |
GET | /person/get-name-and-id | Get person name and ID |
POST | /person/import | Import persons |
GET | /person/person/{id} | Get a person by ID |
PATCH | /person/restore | Restore persons |
DELETE | /person/soft | Soft delete persons |
PATCH | /person/update/{id} | Update a person |
POST | /person/upload-excel | Upload Excel file |
📂 Task
| Method | Path | Description |
|---|---|---|
POST | /task | Create a new task |
GET | /task/all | Get all tasks |
POST | /task/by-assignee | Get tasks by assignee |
POST | /task/get-tasks-by-target | Get task by target |
POST | /task/soft | Soft delete tasks |
POST | /task/target | Create a new task target |
GET | /task/{id} | Get a task by ID |
PATCH | /task/{id} | Update a task |
DELETE | /task/{id} | Delete a task |
📂 Note
| Method | Path | Description |
|---|---|---|
POST | /note | Create a new note |
GET | /note/all | Get all notes |
POST | /note/get-notes-by-target | Get note by target |
POST | /note/soft-delete | Soft delete notes |
POST | /note/target | Create a new note target |
GET | /note/{id} | Get a note by ID |
PATCH | /note/{id} | Update a note |
DELETE | /note/{id} | Delete a note |
📂 Workspace Member
| Method | Path | Description |
|---|---|---|
GET | /workspace-member | Get all workspace members |
GET | /workspace-member/members/{workspaceId} | Get workspace members by workspace ID |
GET | /workspace-member/{userId} | Get a workspace member by user ID |
PATCH | /workspace-member/{userId} | Update a workspace member |
DELETE | /workspace-member/{userId} | Delete a workspace member |