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
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/contacts | List all contacts |
GET | /api/v1/contacts/{id} | Get a single contact |
POST | /api/v1/contacts | Create 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
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/invoices | List all invoices |
GET | /api/v1/invoices/{id} | Get a single invoice |
POST | /api/v1/invoices | Create a new invoice |
POST | /api/v1/invoices/{id}/send | Send invoice to client |
Tasks
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/tasks | List all tasks |
POST | /api/v1/tasks | Create a new task |
PUT | /api/v1/tasks/{id}/status | Update task status |
Employees
| Method | Endpoint | Description |
|---|---|---|
GET | /api/v1/employees | List all employees |
GET | /api/v1/employees/{id} | Get employee details |
POST | /api/v1/employees | Create employee record |
Error Handling
The API returns standard HTTP status codes:
| Code | Description |
|---|---|
| 200 | Success |
| 201 | Resource created |
| 400 | Bad request (validation error) |
| 401 | Unauthorized (invalid or missing token) |
| 403 | Forbidden (insufficient permissions) |
| 404 | Resource not found |
| 429 | Rate limit exceeded |
| 500 | Server error |
Rate Limits
API requests are rate-limited based on your plan:
| Plan | Requests/Minute |
|---|---|
| Starter | 60 |
| Pro | 300 |
| Enterprise | 1,000 |
Rate limit headers are included in every response:
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1711022400