API Reference

Integrate Mewayz with your applications using our REST API.

Authentication

All API requests require authentication using a Bearer token. Generate your API token from Settings > API in the Mewayz dashboard.

curl -X GET https://app.mewayz.com/api/v1/contacts \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json"
Keep your API token secure. Do not expose it in client-side code or public repositories.

Base URL

All API endpoints are relative to:

https://app.mewayz.com/api/v1/

Endpoints

Contacts

MethodEndpointDescription
GET/api/v1/contactsList all contacts
GET/api/v1/contacts/{id}Get a single contact
POST/api/v1/contactsCreate a new contact
PUT/api/v1/contacts/{id}Update a contact
DELETE/api/v1/contacts/{id}Delete a contact

Example: Create a Contact

curl -X POST https://app.mewayz.com/api/v1/contacts \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "+1234567890",
    "company": "Acme Corp"
  }'

Response Format

{
  "success": true,
  "data": {
    "id": 123,
    "name": "John Doe",
    "email": "[email protected]",
    "phone": "+1234567890",
    "company": "Acme Corp",
    "created_at": "2026-03-21T10:00:00Z"
  }
}

Invoices

MethodEndpointDescription
GET/api/v1/invoicesList all invoices
GET/api/v1/invoices/{id}Get a single invoice
POST/api/v1/invoicesCreate a new invoice
POST/api/v1/invoices/{id}/sendSend invoice to client

Tasks

MethodEndpointDescription
GET/api/v1/tasksList all tasks
POST/api/v1/tasksCreate a new task
PUT/api/v1/tasks/{id}/statusUpdate task status

Employees

MethodEndpointDescription
GET/api/v1/employeesList all employees
GET/api/v1/employees/{id}Get employee details
POST/api/v1/employeesCreate employee record

Error Handling

The API returns standard HTTP status codes:

CodeDescription
200Success
201Resource created
400Bad request (validation error)
401Unauthorized (invalid or missing token)
403Forbidden (insufficient permissions)
404Resource not found
429Rate limit exceeded
500Server error

Rate Limits

API requests are rate-limited based on your plan:

PlanRequests/Minute
Starter60
Pro300
Enterprise1,000

Rate limit headers are included in every response:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1711022400