Developers · REST API

Build on
Mewayz.

One REST API across your whole workspace — CRM, sales, invoicing, accounting, projects, POS, HR and more. 372 endpoints, JSON everywhere, authenticated with a bearer token. The same browsable reference lives in-app under Settings → API Docs.

Base URL · app.mewayz.com/api Auth · Bearer token Format · JSON Endpoints · 372

Authentication

Every request is authenticated with a bearer token. Generate one in your dashboard under Settings → API Keys — it is shown once, so copy it then. A token inherits the roles & permissions of the user who created it, and most resource endpoints also require the matching module to be enabled on your plan.

Authorization header
# Pass your token on every request curl https://app.mewayz.com/api/leads \ -H "Authorization: Bearer 12|aZ8f3a...d92c" \ -H "Accept: application/json"

Prefer to authenticate programmatically? POST /api/login with your email and password returns a bearer token you can use the same way, and POST /api/refresh rotates it.

Quickstart

Create a CRM lead in under a minute. The API works against the same data you see in the product — there is no separate sync layer.

POST /api/lead/create
curl -X POST https://app.mewayz.com/api/lead/create \ -H "Authorization: Bearer 12|aZ8f3a..." \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{ "name": "Ada Lovelace", "email": "[email protected]" }'

Errors & status codes

We use conventional HTTP status codes. Error bodies include a human-readable message you can surface directly.

200OK — request succeeded
201Created — resource created
401Unauthorized — missing or invalid token
422Unprocessable — validation failed
429Too many requests — you hit a rate limit
500Server error — we'll have it on status

Rate limits

API traffic is rate-limited to keep the platform fast for everyone. If you exceed the limit you'll receive an HTTP 429 response — back off and retry. The Retry-After header tells you when you can resume.

Authentication & session /api/login

Log in, refresh or revoke your token, fetch the signed-in user, edit the profile, and read staff / client / vendor user lists. (11 endpoints)

POST/api/change-password
GET/api/client-user
DELETE/api/delete-account
POST/api/edit-profile
POST/api/login
POST/api/logout
POST/api/refresh
GET/api/staff-user
POST/api/upload-photos
GET/api/user
GET/api/vendor-user

API keys /api/v1/settings/api-keys

List, create and revoke your personal access tokens — the same keys you generate under Settings → API Keys. (3 endpoints)

GET/api/v1/settings/api-keys
POST/api/v1/settings/api-keys
DELETE/api/v1/settings/api-keys/{id}

CRM — leads, deals & pipeline /api/leads

Full CRUD over leads, deals, pipelines, stages, labels and sources, plus their tasks, calls, files, notes and products. (79 endpoints)

DELETE/api/deal-call/delete/{call_id}
POST/api/deal-call/store
POST/api/deal-call/update/{call_id}
POST/api/deal-client/store/{deal_id}
DELETE/api/deal-client/{deal_id}/delete/{client_id}
POST/api/deal-discussion/store/{deal_id}
POST/api/deal-email/store/{deal_id}
POST/api/deal-file/store/{deal_id}
DELETE/api/deal-file/{deal_id}/delete/{file_id}
POST/api/deal-source/store/{deal_id}
DELETE/api/deal-source/{deal_id}/delete/{source_id}
POST/api/deal-stage/create
DELETE/api/deal-stage/delete/{id}
POST/api/deal-stage/update/{id}
GET/api/deal-stages
POST/api/deal-task/create
DELETE/api/deal-task/delete/{id}
POST/api/deal-task/update/{id}
POST/api/deal-user/store/{deal_id}
DELETE/api/deal-user/{deal_id}/delete/{user_id}
POST/api/deal/add-label/{id}
POST/api/deal/assign-products/{deal_id}
POST/api/deal/create
DELETE/api/deal/delete/{id}
GET/api/deal/show/{id}
POST/api/deal/update/{id}
DELETE/api/deal/{deal_id}/products/{product_id}
GET/api/deals
POST/api/label/create
DELETE/api/label/delete/{id}
POST/api/label/update/{id}
GET/api/labels
DELETE/api/lead-call/delete/{call_id}
POST/api/lead-call/store
POST/api/lead-call/update/{call_id}
POST/api/lead-discussion/store/{lead_id}
POST/api/lead-email/store/{lead_id}
POST/api/lead-file/store/{lead_id}
DELETE/api/lead-file/{lead_id}/delete/{file_id}
POST/api/lead-source/store/{lead_id}
DELETE/api/lead-source/{lead_id}/delete/{source_id}
POST/api/lead-stage/create
DELETE/api/lead-stage/delete/{id}
POST/api/lead-stage/update/{id}
GET/api/lead-stages
POST/api/lead-task/create
DELETE/api/lead-task/delete/{id}
POST/api/lead-task/update/{id}
POST/api/lead-user/store/{lead_id}
DELETE/api/lead-user/{lead_id}/delete/{user_id}
POST/api/lead/add-label/{id}
POST/api/lead/assign-products/{lead_id}
POST/api/lead/convert-to-deal/{id}
POST/api/lead/create
DELETE/api/lead/delete/{id}
GET/api/lead/get-request-data
GET/api/lead/get-users
POST/api/lead/home
POST/api/lead/lead-create-update
POST/api/lead/lead-delete
POST/api/lead/lead-details
POST/api/lead/lead-stage-create-update
POST/api/lead/lead-stage-update
POST/api/lead/lead-stages
POST/api/lead/leadboard
POST/api/lead/pipeline-create-update
GET/api/lead/pipelines
GET/api/lead/show/{id}
POST/api/lead/update/{id}
DELETE/api/lead/{lead_id}/products/{product_id}
GET/api/leads
POST/api/pipeline/create
DELETE/api/pipeline/delete/{id}
POST/api/pipeline/update/{id}
GET/api/pipelines
POST/api/source/create
DELETE/api/source/delete/{id}
POST/api/source/update/{id}
GET/api/sources

Sales /api/sales/sales-orders

Opportunities, quotes, meetings, sales orders and warehouse lookups. (23 endpoints)

GET/api/sales/RequestData
POST/api/sales/get-warehouse-products
GET/api/sales/home
DELETE/api/sales/meeting/destroy/{id}
POST/api/sales/meeting/store
POST/api/sales/meeting/update/{id}
GET/api/sales/meetings
GET/api/sales/opportunities
DELETE/api/sales/opportunities/delete/{id}
POST/api/sales/opportunities/update/{id}
POST/api/sales/opportunitity/store
POST/api/sales/parent-records
GET/api/sales/quotes
DELETE/api/sales/quotes/destroy/{id}
POST/api/sales/quotes/store
POST/api/sales/quotes/update/{id}
GET/api/sales/quotes/{id}
DELETE/api/sales/sales-order/delete/{id}
POST/api/sales/sales-order/store
POST/api/sales/sales-order/update/{id}
GET/api/sales/sales-orders
GET/api/sales/sales-orders/{id}
GET/api/sales/warehouses

Sales proposals /api/sales-proposal

Draft, send, accept/reject proposals and convert them to invoices. (9 endpoints)

GET/api/sales-proposal
POST/api/sales-proposal/accept/{proposal_id}
POST/api/sales-proposal/convert-to-invoice/{proposal_id}
POST/api/sales-proposal/create
DELETE/api/sales-proposal/delete/{proposal_id}
POST/api/sales-proposal/reject/{proposal_id}
POST/api/sales-proposal/sent/{proposal_id}
GET/api/sales-proposal/show/{proposal_id}
POST/api/sales-proposal/update/{proposal_id}

Sales invoices /api/sales-invoice

List, create, update, delete and post sales invoices. (6 endpoints)

GET/api/sales-invoice
POST/api/sales-invoice/create
DELETE/api/sales-invoice/delete/{invoice_id}
POST/api/sales-invoice/post/{invoice_id}
GET/api/sales-invoice/show/{invoice_id}
POST/api/sales-invoice/update/{invoice_id}

Sales invoice returns /api/sales-invoice-return

Create, approve and complete sales-invoice returns. (6 endpoints)

GET/api/sales-invoice-return
POST/api/sales-invoice-return/approve/{return_id}
POST/api/sales-invoice-return/complete/{return_id}
POST/api/sales-invoice-return/create
DELETE/api/sales-invoice-return/delete/{return_id}
GET/api/sales-invoice-return/show/{return_id}

Purchase invoices /api/purchase-invoice

List, create, update, delete and post purchase invoices. (6 endpoints)

GET/api/purchase-invoice
POST/api/purchase-invoice/create
DELETE/api/purchase-invoice/delete/{invoice_id}
POST/api/purchase-invoice/post/{invoice_id}
GET/api/purchase-invoice/show/{invoice_id}
POST/api/purchase-invoice/update/{invoice_id}

Purchase returns /api/purchase-return

Create, approve and complete purchase returns. (6 endpoints)

GET/api/purchase-return
POST/api/purchase-return/approve/{return_id}
POST/api/purchase-return/complete/{return_id}
POST/api/purchase-return/create
DELETE/api/purchase-return/delete/{return_id}
GET/api/purchase-return/show/{return_id}

Accounting /api/chart-of-accounts

Customers, vendors, bank accounts, chart of accounts, revenues, expenses, payments, credit/debit notes and transfers. (37 endpoints)

GET/api/account-types
GET/api/bank-accounts
POST/api/bank-accounts/create
DELETE/api/bank-accounts/delete/{id}
POST/api/bank-accounts/update/{id}
GET/api/bank-transactions
GET/api/bank-transfers
GET/api/chart-of-accounts
GET/api/credit-notes
GET/api/customer-payments
GET/api/customers
POST/api/customers/create
DELETE/api/customers/delete/{id}
POST/api/customers/update/{id}
GET/api/debit-notes
GET/api/expense-categories
GET/api/expenses
POST/api/expenses/approve/{id}
POST/api/expenses/create
DELETE/api/expenses/delete/{id}
POST/api/expenses/post/{id}
POST/api/expenses/update/{id}
GET/api/get-clients
GET/api/get-vendors
GET/api/gl-accounts
GET/api/revenue-categories
GET/api/revenues
POST/api/revenues/approve/{id}
POST/api/revenues/create
DELETE/api/revenues/delete/{id}
POST/api/revenues/post/{id}
POST/api/revenues/update/{id}
GET/api/vendor-payments
GET/api/vendors
POST/api/vendors/create
DELETE/api/vendors/delete/{id}
POST/api/vendors/update/{id}

Products & services /api/products

Products, categories, taxes, units and stock. (20 endpoints)

GET/api/product-service/items
POST/api/product-stock/add
GET/api/product-stocks
GET/api/product/category
POST/api/product/category/create
DELETE/api/product/category/delete/{id}
POST/api/product/category/update/{id}
POST/api/product/create
DELETE/api/product/delete/{id}
GET/api/product/detail/{id}
POST/api/product/update/{id}
GET/api/products
GET/api/tax
POST/api/tax/create
DELETE/api/tax/delete/{id}
POST/api/tax/update/{id}
POST/api/unit/create
DELETE/api/unit/delete/{id}
POST/api/unit/update/{id}
GET/api/units

Warehouse & inventory /api/warehouse

Warehouses and stock transfers. (9 endpoints)

GET/api/transfer
POST/api/transfer/create
DELETE/api/transfer/delete/{transfer_id}
GET/api/transfer/request-data
GET/api/warehouse
POST/api/warehouse/create
DELETE/api/warehouse/delete/{warehouse_id}
GET/api/warehouse/product/{warehouse_id}
POST/api/warehouse/update/{warehouse_id}

Projects, tasks & bugs /api/projects

Projects, milestones, task boards, tasks, subtasks, bugs and reports. (45 endpoints)

GET/api/bug-status-list
GET/api/get-projects
POST/api/project/bug-stage/create
DELETE/api/project/bug-stage/delete/{id}
POST/api/project/bug-stage/order
POST/api/project/bug-stage/update/{id}
GET/api/project/bug-stages
POST/api/project/bug/create/{project_id}
GET/api/project/bug/show/{bug_id}
POST/api/project/bug/{bug_id}/comment/create
DELETE/api/project/bug/{id}/comment/delete
GET/api/project/bug/{project_id}
DELETE/api/project/client/delete/{id}
POST/api/project/client/invite
GET/api/project/clients
DELETE/api/project/delete/{id}
POST/api/project/file/create
DELETE/api/project/file/delete/{id}
DELETE/api/project/member/delete/{id}
POST/api/project/milestone/create
DELETE/api/project/milestone/delete/{id}
POST/api/project/milestone/update/{id}
GET/api/project/milestones
GET/api/project/report/{id}
GET/api/project/reports
GET/api/project/show/{id}
POST/api/project/task-stage/create
DELETE/api/project/task-stage/delete/{id}
POST/api/project/task-stage/order
POST/api/project/task-stage/update/{id}
GET/api/project/task-stages
POST/api/project/task-subtask/create/{task_id}
POST/api/project/task-subtask/update/{subtask_id}
DELETE/api/project/task/comment/delete/{comment_id}
GET/api/project/task/show/{id}
POST/api/project/task/{task_id}/comment/create
POST/api/project/update/{id}
GET/api/project/{id}/task-board
POST/api/project/{id}/task/create
POST/api/project/{id}/task/update/{task_id}
DELETE/api/project/{project_id}/bug/delete/{bug_id}
POST/api/project/{project_id}/bug/update/{bug_id}
DELETE/api/project/{project_id}/task/delete/{task_id}
GET/api/projects
POST/api/projects/create

Point of sale /api/pos

POS orders and order detail. (2 endpoints)

GET/api/pos
GET/api/pos/show/{id}

Support desk /api/support-ticket/tickets

Tickets and replies, FAQs and knowledge-base articles. (16 endpoints)

POST/api/support-ticket/faq/delete/{faq_id}
POST/api/support-ticket/faq/update/{faq_id}
GET/api/support-ticket/faqs
POST/api/support-ticket/faqs/store
GET/api/support-ticket/get-request-data
GET/api/support-ticket/home
POST/api/support-ticket/knowledge/delete/{knowledge_id}
POST/api/support-ticket/knowledge/store
POST/api/support-ticket/knowledge/update/{knowledge_id}
GET/api/support-ticket/knowledges
POST/api/support-ticket/ticket/add-reply/{ticket_id}
POST/api/support-ticket/ticket/delete/{ticket_id}
POST/api/support-ticket/ticket/note/store/{ticket_id}
POST/api/support-ticket/ticket/store
POST/api/support-ticket/ticket/update/{ticket_id}
GET/api/support-ticket/tickets

Taskly /api/taskly/projects

Taskly projects and tasks for the lightweight project module. (18 endpoints)

GET/api/taskly/home
POST/api/taskly/project-activity
POST/api/taskly/project-create-update
POST/api/taskly/project-delete
POST/api/taskly/project-details
DELETE/api/taskly/project-file-delete/{id}
POST/api/taskly/project-file-upload
POST/api/taskly/project-list
POST/api/taskly/project-status-update
GET/api/taskly/projects
GET/api/taskly/projects/{project}/tasks
POST/api/taskly/task-create-update
POST/api/taskly/task-delete
POST/api/taskly/task-details
POST/api/taskly/task-list
POST/api/taskly/task-stage-update
POST/api/taskly/taskboard
GET/api/taskly/users

Time tracking /api/add-tracker

Start and stop time trackers. (3 endpoints)

POST/api/add-tracker
POST/api/stop-tracker
POST/api/tracker-login

Users & roles /api/users

Administer workspace users and read roles. (8 endpoints)

GET/api/roles
DELETE/api/user/delete/{id}
POST/api/user/reset-password/{id}
POST/api/user/store
POST/api/user/update/{id}
PUT/api/user/verify/{id}
GET/api/users
GET/api/users/log

HR & payroll /api/employees

Employees, attendance, leave, payroll, plus the full HR record set (branches, departments, holidays, awards and more). (44 endpoints)

GET/api/acknowledgments
GET/api/announcements
POST/api/attendance/create
DELETE/api/attendance/delete/{attendance_id}
POST/api/attendance/update/{attendance_id}
GET/api/attendances
GET/api/awards
GET/api/branches
GET/api/complaints
GET/api/departments
GET/api/designations
GET/api/document-types
GET/api/employee-transfers
POST/api/employee/create
DELETE/api/employee/delete/{id}
GET/api/employee/show/{id}
POST/api/employee/update/{id}
GET/api/employees
GET/api/events
GET/api/holidays
GET/api/hrm-documents
POST/api/hrm/attendence-history
POST/api/hrm/clock-in-out
POST/api/hrm/events
GET/api/hrm/get-leaves
GET/api/hrm/get-leaves-types
GET/api/hrm/holidays-list
GET/api/hrm/home
POST/api/hrm/leave-request
POST/api/leave-application/create
DELETE/api/leave-application/delete/{leaveapplication_id}
POST/api/leave-application/update-status/{leaveapplication_id}
POST/api/leave-application/update/{leaveapplication_id}
GET/api/leave-applications
GET/api/leave-balances
GET/api/leave-types
GET/api/payrolls
GET/api/payrolls/{payroll_id}
GET/api/payslip/{payroll_entry_id}
GET/api/promotions
GET/api/resignations
GET/api/shifts
GET/api/terminations
GET/api/warnings

Third-party API (v1) /api/v1/customers

A stable, versioned slice built for no-code tools like Zapier — customers and invoices. (7 endpoints)

GET/api/v1/customers
POST/api/v1/customers
GET/api/v1/customers/{id}
PUT/api/v1/customers/{id}
GET/api/v1/invoices
POST/api/v1/invoices
GET/api/v1/invoices/{id}

Public endpoints /api/public/plans

Unauthenticated helpers: the public plan catalogue and the embeddable lead-capture widget & partner badge. (4 endpoints)

GET/api/badge/{token}
GET/api/public/plans
POST/api/widget/lead
GET/api/widget/{token}

White-label platform /api/wl/plans

Server-to-server endpoints used by white-label instances for billing and Stripe Connect (token-authenticated). (6 endpoints)

POST/api/wl/checkout
POST/api/wl/connect/onboard
GET/api/wl/connect/status
GET/api/wl/plans
POST/api/wl/subscription/{stripe_subscription_id}/cancel
POST/api/wl/webhook-callback

Integration endpoints /api/microsofttodo

Helper endpoints for connected integrations (Microsoft To Do, Vonage SMS, Facebook posts). (3 endpoints)

GET/api/facebookpost
GET/api/microsofttodo
GET/api/vonagesms

More endpoints

Additional registered endpoints. (1 endpoints)

GET/api/agents/{agent}/outstanding-commissions