Dynamic interactive API references parsed directly from the system Postman collection.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"full_name": "John Doe",
"email": "john@example.com",
"phone": "0501234567",
"password": "password123"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"email": "john@example.com",
"password": "password123"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
{
"email": "john@example.com"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
{
"token": "mock_reset_token_here",
"password": "newpassword123"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"old_password": "password123",
"new_password": "newpassword123"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"full_name": "Johnathan Doe",
"phone_code": "+971",
"phone": "0509999999",
"preferred_language": "ar",
"city_ids": [1, 2]
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"vendor_id": 1,
"request_type": "general_vendor",
"number_of_helpers": 1,
"preferred_nationality_id": 1,
"specialty_ids": [
4
],
"service_model_id": 1,
"additional_notes": "We need the helper to start early in the morning and have experience in cooking Filipino food."
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"vendor_id": 1,
"maid_id": 4,
"request_type": "specific_maid",
"start_date": "2024-10-15",
"duration_months": 6,
"work_days": 6,
"service_model_id": 2,
"specialty_ids": [
5,
6,
4
],
"city_id": 1,
"additional_notes": "E.g., Gate code is 1234, please park in visitor area...",
"estimated_total_value": 15000,
"estimated_monthly_payment": 2500
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"vendor_id": 1,
"maid_id": 4,
"platform_id": 1,
"interview_date": "2024-10-14",
"time_from": "10:00:00",
"time_to": "11:30:00",
"customer_notes": "Looking forward to meeting Sarah Jenkins",
"translation_enabled": 1,
"customer_language": "English (US)",
"helper_language": "Arabic",
"notify_app": 1,
"notify_whatsapp": 1,
"notify_email": 0,
"notify_call": 0
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"cancel_reason": "Plans changed"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"interview_date": "2026-06-24",
"time_from": "14:00:00",
"time_to": "14:30:00"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"maid_id": 12
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"vendor_id": 5
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"status": "accepted"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"terms_accepted": true
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"firebase_chat_id": "room_cust1_vend5",
"vendor_id": 5,
"maid_id": 12
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"rating": 4.5,
"comment": "Excellent and very professional maid.",
"maid_id": 12
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"subject": "Quotation pending approval",
"message": "It has been 2 days since my quotation request was sent. Please assist."
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"enable_push": true,
"booking_updates": true,
"messages": true,
"account_activity": false
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
{
"agency_name": "Premium Maids Dubai",
"email": "info@premiummaids.com",
"phone": "041234567",
"password": "password123"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
{
"email": "vendor@test.com",
"password": "123456"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
{
"email": "info@premiummaids.com"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
{
"token": "YOUR_RESET_TOKEN",
"password": "newpassword123"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"old_password": "password123",
"new_password": "newpassword123"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"agency_name": "Premium Maids Dubai LLC",
"tagline": "Top rated maid service in UAE",
"description": "Providing experienced housekeepers across Dubai.",
"phone": "0501234567",
"address": "Marina Gate 1, Dubai Marina",
"preferred_language": "en",
"country_id": 1,
"city_id": 1
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"first_name": "Sarah",
"last_name": "Jenkins",
"nationality_id": 5,
"gender": "female",
"date_of_birth": "1994-05-15",
"marital_status": "single",
"language_ids": [
{"id": 1, "proficiency": "fluent"},
{"id": 2, "proficiency": "native"}
]
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"languages": [
{"id": 1, "proficiency": "fluent"},
{"id": 2, "proficiency": "native"}
]
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"years_experience": 5,
"experience_location": "Dubai, UAE",
"service_model_id": 1,
"monthly_salary": 3500,
"bio": "Hi, I'm Sarah! I specialize in full-time household management, deep cleaning, and organizing."
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"specialty_ids": [1, 2, 3, 4],
"custom_speciality": "Taking care of elders"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"skill_ids": [1, 2, 5]
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
| Field Key | Type | Example / Src |
|---|---|---|
| profile_image | file | File Upload Stream |
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
| Field Key | Type | Example / Src |
|---|---|---|
| document_type_id | text | 1 |
| expiry_date | text | 2028-05-01 |
| document | file | File Upload Stream |
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"availability_status": "available",
"available_from": "2024-10-15",
"service_model_id": 1
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"status": "published"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"full_name": "Maria Santos",
"nationality_id": 5,
"monthly_salary": 1800,
"experience_years": 4,
"date_of_birth": "1992-05-15",
"gender": "female"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"full_name": "Maria Santos Alcantara",
"monthly_salary": 1950,
"availability_status": "available"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
| Field Key | Type | Example / Src |
|---|---|---|
| images[] | file | File Upload Stream |
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
| Field Key | Type | Example / Src |
|---|---|---|
| document_type_id | text | 3 |
| expiry_date | text | 2029-12-31 |
| document | file | File Upload Stream |
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"status": "published"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"job_title": "Full-time Housemaid",
"employer": "Al Rashid Family",
"location": "Dubai Hills, Dubai UAE",
"description": "Managing a 5-bedroom villa in Dubai Hills. Responsibilities include deep cleaning, laundry, and assisting with children.",
"date_from": "2021-01-01",
"date_to": null,
"is_current": true
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"job_title": "Senior Housekeeper",
"description": "Updated job responsibilities.",
"is_current": false,
"date_to": "2023-06-30"
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"status": "confirmed",
"meeting_link": "https://meet.google.com/azu-hori-xyz",
"notes": "Ensure you have a good internet connection."
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"interview_date": "2024-10-25",
"time_from": "10:30:00",
"time_to": "11:15:00",
"notes": "Proposing a new time slot."
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"slots": [
{
"day_of_week": "monday",
"time_from": "09:00:00",
"time_to": "17:00:00"
},
{
"day_of_week": "wednesday",
"time_from": "10:00:00",
"time_to": "16:00:00"
}
]
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"timezone": "Asia/Dubai",
"duration_minutes": 45
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"status": "declined",
"decline_reason": "Location is outside service area",
"decline_message": "We currently do not serve the Al-Maktoum region."
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"quotation_request_id": 1003,
"customer_id": 1,
"maid_id": null,
"base_salary": 2400,
"visa_processing": 450,
"health_insurance": 180,
"service_fee": 120,
"notes": "Testing general quote creation with inclusions",
"background_checks": true,
"medical_coverage": true,
"replacement_guarantee": false
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"payment_method_id": 1,
"card_last_four": "4242",
"card_brand": "Visa",
"expiry_month": "12",
"expiry_year": "2028",
"is_default": 1
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"auto_renew": true
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"address_label": "Office",
"name_or_company": "Azure Horizon Agency",
"country_region": "United Arab Emirates",
"street_address": "Office 402, Business Bay",
"apt_suite_office": "Office 402",
"city": "Dubai",
"postal_zip": "00000",
"is_default": true
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"address_label": "Office",
"name_or_company": "Azure Horizon Agency",
"country_region": "United Arab Emirates",
"street_address": "Office 402, Business Bay",
"apt_suite_office": "Office 402",
"city": "Dubai",
"postal_zip": "00000",
"is_default": true
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
| Field Key | Type | Example / Src |
|---|---|---|
| document_type_id | text | 2 |
| expiry_date | text | 2026-12-31 |
| document | file | File Upload Stream |
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"firebase_chat_id": "chat_room_889",
"customer_id": 2,
"maid_id": 12,
"quotation_request_id": 10
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"enable_push": true,
"booking_updates": true,
"messages": true,
"account_activity": false
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"subject": "App Subscription Upgrade Issue",
"message": "My credit card was charged but the subscription plan remains Basic. Please upgrade to Professional."
}
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
No request payload needed for this endpoint.
| Header Name | Required Value | Description |
|---|---|---|
| Content-Type | application/json | Informs server that request payload uses JSON structure. |
| Authorization | Bearer {jwt_token} | JWT Required Access Token generated from login endpoint. |
{
"timezone": "Gulf Standard Time (GST)",
"duration_minutes": 45,
"availability": [
{
"day_of_week": "monday",
"is_available": true,
"slots": [
{"from": "09:00 AM", "to": "06:00 PM"}
]
},
{
"day_of_week": "tuesday",
"is_available": true,
"slots": [
{"from": "09:00 AM", "to": "06:00 PM"}
]
},
{
"day_of_week": "wednesday",
"is_available": true,
"slots": [
{"from": "09:00 AM", "to": "06:00 PM"}
]
},
{
"day_of_week": "thursday",
"is_available": true,
"slots": [
{"from": "09:00 AM", "to": "06:00 PM"}
]
},
{
"day_of_week": "friday",
"is_available": true,
"slots": [
{"from": "09:00 AM", "to": "12:00 PM"},
{"from": "02:00 PM", "to": "06:00 PM"}
]
},
{
"day_of_week": "saturday",
"is_available": false,
"slots": []
},
{
"day_of_week": "sunday",
"is_available": false,
"slots": []
}
]
}