API Documentation
Integrate Mujaz Platform into your applications with our RESTful API
v1.0
REST API
Rate Limited
Getting Started
Base URL
https://api.mujaz.com/v1Authentication
Include your API key in the Authorization header:
Authorization: Bearer your-api-keyRate Limits
1000 requests per hour per API key
Endpoints
GET
/api/newslettersRetrieve all newsletters
POST
/api/newslettersCreate a new newsletter
GET
/api/subscribersRetrieve subscriber list
POST
/api/subscribersAdd new subscriber
POST
/api/newsletters/{id}/sendSend newsletter to subscribers
GET
/api/analytics/newsletters/{id}Get newsletter analytics
GET
/api/newslettersRetrieve all newsletters
Parameters
pageoptionallimitoptionalstatusoptionalResponse
{
"newsletters": [
{
"id": "newsletter_123",
"title": "Weekly Update",
"status": "published",
"created_at": "2024-01-15T10:00:00Z"
}
],
"total": 25,
"page": 1,
"limit": 10
}SDK Examples
// Install: npm install @mujaz/api-client
import { MujazAPI } from '@mujaz/api-client';
const api = new MujazAPI('your-api-key');
// Create a newsletter
const newsletter = await api.newsletters.create({
title: 'Weekly Update',
content: '<h1>Hello World</h1>',
subject: 'This Week’s Update'
});
// Send newsletter
await api.newsletters.send(newsletter.id);
// Get analytics
const analytics = await api.analytics.getNewsletter(newsletter.id);Need API Support?
Have questions about our API? Our developer support team is here to help.