{ "info": { "name": "HelperLink API Collection", "description": "Comprehensive Postman collection detailing all mobile app endpoints for Customer and Vendor portals, updated to include full availability schedulers, digital contracts, quotations management, chat log references, notifications explorer, and profile settings.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Customer", "item": [ { "name": "Auth", "item": [ { "name": "Register", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"full_name\": \"John Doe\",\n \"email\": \"john@example.com\",\n \"phone\": \"0501234567\",\n \"password\": \"password123\"\n}" }, "url": { "raw": "{{base_url}}/api/customer/register", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "register" ] } } }, { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"john@example.com\",\n \"password\": \"password123\"\n}" }, "url": { "raw": "{{base_url}}/api/customer/login", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "login" ] } } }, { "name": "Profile", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/profile", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "profile" ] } } }, { "name": "Forgot Password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"john@example.com\"\n}" }, "url": { "raw": "{{base_url}}/api/customer/forgot-password", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "forgot-password" ] } } }, { "name": "Reset Password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"mock_reset_token_here\",\n \"password\": \"newpassword123\"\n}" }, "url": { "raw": "{{base_url}}/api/customer/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "reset-password" ] } } }, { "name": "Change Password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"old_password\": \"password123\",\n \"new_password\": \"newpassword123\"\n}" }, "url": { "raw": "{{base_url}}/api/customer/change-password", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "change-password" ] } } }, { "name": "Update Profile", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Johnathan Doe\",\n \"phone_code\": \"+971\",\n \"phone\": \"0509999999\",\n \"preferred_language\": \"ar\",\n \"city_ids\": [1, 2]\n}" }, "url": { "raw": "{{base_url}}/api/customer/profile/update", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "profile", "update" ] } } } ] }, { "name": "Quotation Requests", "item": [ { "name": "Create Quotation Request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"vendor_id\": 1,\n \"request_type\": \"general_vendor\",\n \"number_of_helpers\": 1,\n \"preferred_nationality_id\": 1,\n \"specialty_ids\": [\n 4\n ],\n \"service_model_id\": 1,\n \"additional_notes\": \"We need the helper to start early in the morning and have experience in cooking Filipino food.\"\n}" }, "url": { "raw": "{{base_url}}/api/customer/quotation-requests/create", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "quotation-requests", "create" ] }, "description": "Submit a request to a vendor for a monthly maid service quote based on specified preferences from the 'Get Monthly Quotation' screen.\n\n### Request Body Fields:\n- **`vendor_id`** (integer, Required): ID of the agency vendor.\n- **`request_type`** (string, Required): Type of request. Set to `general_vendor` for form-based requests.\n- **`number_of_helpers`** (integer, Optional, default `1`): Number of helpers requested (Service Details counter).\n- **`preferred_nationality_id`** (integer, Optional): Preferred nationality ID (Filipino: `1`, Indonesian: `2`, Sri Lankan: `3`, Ethiopian: `4`, Nepalese: `5`, No Preference: `null`).\n- **`specialty_ids`** (array of integers, Optional): Specialized skills needed (Baby Care/Sitting: `1`, Cooking: `4`, Cleaning/Deep Cleaning: `5`).\n- **`service_model_id`** (integer, Optional): Working model chosen in the 'Accommodation' UI section (Live-in: `1`, Live-out: `2`).\n- **`additional_notes`** (string, Optional): Textbox input for specific timings, rules, or requirements (Max 200 characters)." } }, { "name": "List Quotation Requests", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/quotation-requests", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "quotation-requests" ] } } }, { "name": "Cancel Quotation Request", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/quotation-requests/1/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "quotation-requests", "1", "cancel" ] } } }, { "name": "Get Quotation Request Details", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/quotation-requests/1", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "quotation-requests", "1" ] }, "description": "Get details and timeline logs of a specific quotation request. Used for displaying the timeline on the 'Contract Request Success Screen'." }, "response": [] }, { "name": "Create Specific Maid Request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"vendor_id\": 1,\n \"maid_id\": 4,\n \"request_type\": \"specific_maid\",\n \"start_date\": \"2024-10-15\",\n \"duration_months\": 6,\n \"work_days\": 6,\n \"service_model_id\": 2,\n \"specialty_ids\": [\n 5,\n 6,\n 4\n ],\n \"city_id\": 1,\n \"additional_notes\": \"E.g., Gate code is 1234, please park in visitor area...\",\n \"estimated_total_value\": 15000,\n \"estimated_monthly_payment\": 2500\n}" }, "url": { "raw": "{{base_url}}/api/customer/quotation-requests/create", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "quotation-requests", "create" ] }, "description": "Submit a request to a vendor for a monthly maid service quote based on specified preferences from the 'Get Monthly Quotation' screen.\n\n### Request Body Fields:\n- **`vendor_id`** (integer, Required): ID of the agency vendor.\n- **`request_type`** (string, Required): Type of request. Set to `general_vendor` for form-based requests.\n- **`number_of_helpers`** (integer, Optional, default `1`): Number of helpers requested (Service Details counter).\n- **`preferred_nationality_id`** (integer, Optional): Preferred nationality ID (Filipino: `1`, Indonesian: `2`, Sri Lankan: `3`, Ethiopian: `4`, Nepalese: `5`, No Preference: `null`).\n- **`specialty_ids`** (array of integers, Optional): Specialized skills needed (Baby Care/Sitting: `1`, Cooking: `4`, Cleaning/Deep Cleaning: `5`).\n- **`service_model_id`** (integer, Optional): Working model chosen in the 'Accommodation' UI section (Live-in: `1`, Live-out: `2`).\n- **`additional_notes`** (string, Optional): Textbox input for specific timings, rules, or requirements (Max 200 characters)." } } ] }, { "name": "Interviews", "item": [ { "name": "Create Interview", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"vendor_id\": 1,\n \"maid_id\": 4,\n \"platform_id\": 1,\n \"interview_date\": \"2024-10-14\",\n \"time_from\": \"10:00:00\",\n \"time_to\": \"11:30:00\",\n \"customer_notes\": \"Looking forward to meeting Sarah Jenkins\",\n \"translation_enabled\": 1,\n \"customer_language\": \"English (US)\",\n \"helper_language\": \"Arabic\",\n \"notify_app\": 1,\n \"notify_whatsapp\": 1,\n \"notify_email\": 0,\n \"notify_call\": 0\n}" }, "url": { "raw": "{{base_url}}/api/customer/interviews/create", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "interviews", "create" ] } } }, { "name": "List Interviews", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/interviews", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "interviews" ] } } }, { "name": "Cancel Interview", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"cancel_reason\": \"Plans changed\"\n}" }, "url": { "raw": "{{base_url}}/api/customer/interviews/1/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "interviews", "1", "cancel" ] } } }, { "name": "Get Maid Availability", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/maids/4/availability?date=2024-10-14", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "maids", "4", "availability" ], "query": [ { "key": "date", "value": "2024-10-14", "description": "Target date for checking availability (format: YYYY-MM-DD)" } ] } } }, { "name": "Get Vendor Interview Settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/vendors/1/interview-settings", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "vendors", "1", "interview-settings" ] } } }, { "name": "Get Interview Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/interviews/1", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "interviews", "1" ] } } }, { "name": "Reschedule Interview Request", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"interview_date\": \"2026-06-24\",\n \"time_from\": \"14:00:00\",\n \"time_to\": \"14:30:00\"\n}" }, "url": { "raw": "{{base_url}}/api/customer/interviews/1/reschedule", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "interviews", "1", "reschedule" ] } } } ] }, { "name": "Home", "item": [ { "name": "Get Home Data", "request": { "method": "GET", "header": [], "description": "Retrieve comprehensive landing home page content tailored for the Customer App.\n\nReturned Fields:\n- `sliders` (array): Active promotional banners and yearly offers managed by administrators.\n- `recommended_maids` (array): Promoted or top-rated helper profiles featured by administrators.\n- `featured_vendors` (array): Featured agency profiles with verification status, rating, and starting price details.", "url": { "raw": "{{base_url}}/api/customer/home", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "home" ] } } } ] }, { "name": "Marketplace", "item": [ { "name": "Search Marketplace", "request": { "method": "GET", "header": [], "description": "Unified Marketplace Search endpoint with multi-criteria filters, keywords splitting, sorting, and pagination.\n\nQuery Parameters:\n- `searchTerm` (string): Keywords to search (splits by spaces and matches names, bio, nationality, or agency).\n- `type` (string): Scope of search. Allowed: `all` (default), `maids`, `agencies`.\n- `page` (integer): Current page number for paginated results (default: `1`).\n- `limit` (integer): Number of records per page (default: `10`).\n- `sortBy` (string): Ordering of results. Allowed: `best_match` (default - highest ratings + most views), `lowest_price` (lowest salary), `top_rated` (highest reviews + rating), `newest`.\n- `nationality_ids` (comma-separated string or array): Filter by nationality IDs.\n- `specialty_ids` (comma-separated string or array): Filter by helper specialties (e.g. Cooking, Childcare).\n- `skill_ids` (comma-separated string or array): Filter by skill IDs.\n- `language_ids` (comma-separated string or array): Filter by spoken language IDs.\n- `city_ids` (comma-separated string or array): Filter by city IDs.\n- `salary_min` / `salary_max` (numeric): Monthly salary range filters.\n- `experience_min` / `experience_max` (integer): Experience years range filters.\n- `visa_included` (integer `1` or `0`): If `1`, filter helpers with sponsor visa status.\n- `reference_checked` (integer `1` or `0`): If `1`, filter helpers whose work references / Emirates ID have been verified.\n- `available_now` (integer `1` or `0`): If `1` (default), filter only currently available helpers.\n- `package_includes` (comma-separated string or array): Filter by package items: `visa_processing`, `full_insurance`, `accommodation`, `annual_leave`, `mohre_registration`.", "url": { "raw": "{{base_url}}/api/customer/search?searchTerm=Sarah&type=maids&page=1&limit=10&sortBy=best_match&nationality_ids=&specialty_ids=&skill_ids=&language_ids=&city_ids=&salary_min=&salary_max=&experience_min=&experience_max=&visa_included=&reference_checked=&available_now=1&package_includes=", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "search" ], "query": [ { "key": "searchTerm", "value": "Sarah", "description": "Keywords to search across helper names, bios, nationalities, and agencies." }, { "key": "type", "value": "maids", "description": "Search category scope. Allowed values: all, maids, agencies." }, { "key": "page", "value": "1", "description": "Page number for pagination." }, { "key": "limit", "value": "10", "description": "Number of records returned per page." }, { "key": "sortBy", "value": "best_match", "description": "Sorting ordering mode. Allowed values: best_match, lowest_price, top_rated, newest." }, { "key": "nationality_ids", "value": "", "description": "Comma-separated nationality ID list filter." }, { "key": "specialty_ids", "value": "", "description": "Comma-separated specialty ID list filter." }, { "key": "skill_ids", "value": "", "description": "Comma-separated skill ID list filter." }, { "key": "language_ids", "value": "", "description": "Comma-separated language ID list filter." }, { "key": "city_ids", "value": "", "description": "Comma-separated city ID list filter." }, { "key": "salary_min", "value": "", "description": "Minimum monthly salary filter." }, { "key": "salary_max", "value": "", "description": "Maximum monthly salary filter." }, { "key": "experience_min", "value": "", "description": "Minimum years of experience filter." }, { "key": "experience_max", "value": "", "description": "Maximum years of experience filter." }, { "key": "visa_included", "value": "", "description": "Set to 1 to filter helpers sponsored by agencies." }, { "key": "reference_checked", "value": "", "description": "Set to 1 to filter helpers with verified work references / Emirates ID." }, { "key": "available_now", "value": "1", "description": "Set to 1 to show only currently available helpers." }, { "key": "available_soon", "value": "", "description": "Set to 1 to show helpers available soon (Within 1 week)." }, { "key": "contract_type", "value": "", "description": "Filter by service contract type: live-in, live-out, or monthly." }, { "key": "package_includes", "value": "", "description": "Comma-separated package inclusions: visa_processing, full_insurance, accommodation, annual_leave, mohre_registration." } ] } } }, { "name": "List Maids with Filters", "request": { "method": "GET", "header": [], "description": "Retrieve list of all maids with comprehensive filtering, search, sorting, and pagination.\n\nQuery Parameters:\n- `searchTerm` (string): Search keyword.\n- `page` (integer): Current page number (default: `1`).\n- `limit` (integer): Number of helpers per page (default: `10`).\n- `sortBy` (string): Sorting mode (e.g. `best_match`, `lowest_price`, `top_rated`, `newest`).\n- `nationality_ids` (comma-separated string): Filter by nationality IDs.\n- `specialty_ids` (comma-separated string): Filter by specialty IDs.\n- `skill_ids` (comma-separated string): Filter by skill IDs.\n- `language_ids` (comma-separated string): Filter by language IDs.\n- `city_ids` (comma-separated string): Filter by city/location IDs.\n- `salary_min` / `salary_max` (numeric): Salary range.\n- `experience_min` / `experience_max` (integer): Years of experience range.\n- `contract_type` (string): e.g. `live-in`, `live-out`, `monthly`.\n- `visa_included` (integer `1` or `0`): Only sponsored visa helpers.\n- `reference_checked` (integer `1` or `0`): Only reference-verified helpers.\n- `available_now` (integer `1` or `0`): Active available helpers.\n- `available_soon` (integer `1` or `0`): Available soon (Within 1 week).\n- `package_includes` (comma-separated string or array): Filter by package items: `visa_processing`, `full_insurance`, `accommodation`, `annual_leave`, `mohre_registration`.", "url": { "raw": "{{base_url}}/api/customer/maids?searchTerm=Sarah&page=1&limit=10&sortBy=best_match&nationality_ids=&specialty_ids=&skill_ids=&language_ids=&city_ids=&salary_min=&salary_max=&experience_min=&experience_max=&contract_type=&visa_included=&reference_checked=&available_now=1&available_soon=&package_includes=", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "maids" ], "query": [ { "key": "searchTerm", "value": "Sarah", "description": "Keyword search matched against helper names, bio text, nationalities, or agency names." }, { "key": "page", "value": "1", "description": "Current page number for pagination (starts at 1)." }, { "key": "limit", "value": "10", "description": "Number of helper profiles to return per page." }, { "key": "sortBy", "value": "best_match", "description": "Sort results: best_match (highest rating + views), lowest_price (salary), top_rated (reviews), newest." }, { "key": "nationality_ids", "value": "", "description": "Comma-separated list of nationality IDs (e.g. 1,2,3)." }, { "key": "specialty_ids", "value": "", "description": "Comma-separated list of specialty IDs (e.g. 1,4)." }, { "key": "skill_ids", "value": "", "description": "Comma-separated list of skill IDs (e.g. 2,3,5)." }, { "key": "language_ids", "value": "", "description": "Comma-separated list of language IDs (e.g. 1,2)." }, { "key": "city_ids", "value": "", "description": "Comma-separated list of city IDs (e.g. 1,2)." }, { "key": "salary_min", "value": "", "description": "Minimum monthly salary (AED)." }, { "key": "salary_max", "value": "", "description": "Maximum monthly salary (AED)." }, { "key": "experience_min", "value": "", "description": "Minimum years of experience." }, { "key": "experience_max", "value": "", "description": "Maximum years of experience." }, { "key": "contract_type", "value": "", "description": "Filter by service contract type: live-in, live-out, or monthly." }, { "key": "visa_included", "value": "", "description": "Set to 1 to show only helpers with agency-sponsored visas." }, { "key": "reference_checked", "value": "", "description": "Set to 1 to show only helpers with verified Emirates ID/work reference history." }, { "key": "available_now", "value": "1", "description": "Set to 1 to return only currently active and available helpers." }, { "key": "available_soon", "value": "", "description": "Set to 1 to show helpers available soon (Within 1 week)." }, { "key": "package_includes", "value": "", "description": "Comma-separated package inclusions: visa_processing, full_insurance, accommodation, annual_leave, mohre_registration." } ] } } }, { "name": "List Agency Vendors", "request": { "name": "List Agency Vendors", "method": "GET", "header": [], "description": "Retrieve list of all active registered agency vendors/companies on the HelperLink platform.\n\nQuery Parameters:\n- `searchTerm` (string): Keywords to filter agencies by name.\n- `city_ids` (string): Comma-separated list of city IDs (e.g. `1,2`) to filter agencies by area/location.\n- `specialty_ids` (string): Comma-separated list of specialty IDs (e.g. `3,5`) to filter agencies by helper specialisation.\n- `package_includes` (comma-separated string or array): Filter by package items: `visa_processing`, `full_insurance`, `accommodation`, `annual_leave`, `mohre_registration`.\n\nReturned Fields:\n- `vendors` (array): List of agencies showing agency name, tagline, logo, rating, reviews_count, insurance_coverage, staff_count, starting_price, experience_years, and service tags.", "url": { "raw": "{{base_url}}/api/customer/vendors?searchTerm=&city_ids=&specialty_ids=&package_includes=", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "vendors" ], "query": [ { "key": "searchTerm", "value": "", "description": "Keyword search matched against company/agency name." }, { "key": "city_ids", "value": "", "description": "Comma-separated list of city IDs (e.g., 1 for Dubai, 2 for Abu Dhabi)." }, { "key": "specialty_ids", "value": "", "description": "Comma-separated list of specialty IDs to filter by agency helper specialization." }, { "key": "package_includes", "value": "", "description": "Comma-separated package inclusions: visa_processing, full_insurance, accommodation, annual_leave, mohre_registration." } ] } } }, { "name": "Get Vendor Details", "request": { "method": "GET", "header": [], "description": "Retrieve detailed information for a specific agency, including their complete roster of available helpers and customer feedback reviews.\n\nReturned Fields:\n- Profile details: Tagline, trade license, address, cover photo, registration status, staff_count, starting_price.\n- `contact_actions` (object): Formatted tel, WhatsApp, email, and Google Maps direction links.\n- `package_inclusions` (array): Included items such as Visa Processing, Full Insurance, Accommodation, and Annual Leave.\n- `service_models` (array): Aggregate of unique service models supported by this agency's helpers.\n- `maids` (array): List of published, available helpers hosted under this vendor agency, decorated with `service_model_formatted` and profile tags.\n- `reviews` (array): Approved customer reviews and ratings left for this agency.", "url": { "raw": "{{base_url}}/api/customer/vendors/5", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "vendors", "5" ] } } }, { "name": "Get Maid Profile", "request": { "method": "GET", "header": [], "description": "Retrieve detailed profile for a specific maid helper, with UI-ready metadata mapped to match the profile details layout.\n\nReturned Fields:\n- `experience_formatted` (string): Ready-to-render years of experience stat badge (e.g. `5+ Years Exp.`).\n- `reliability_formatted` (string): Ready-to-render reliability score stat badge (e.g. `100% Reliable`).\n- `visa_status_formatted` (string): Human-readable visa status indicator (e.g. `Sponsored Visa`).\n- `availability_formatted` (string): Current availability status tag (e.g. `AVAILABLE MONTHLY` or `FULLY BOOKED`).\n- `is_verified_pro` (boolean): Flag indicating if helper's Emirates ID is verified.\n- `languages` (array): List of spoken languages, each decorated with a mock/assigned `proficiency` level (e.g. `Fluent`, `Conversational`).\n- `experience_history` (array): Mapped employment history list with `role`, `company`, `period`, and `description` to render on the timeline.\n- `reviews` (array): Approved feedback list, complete with customer profile images and calculated `time_ago` relative strings.", "url": { "raw": "{{base_url}}/api/customer/maids/12", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "maids", "12" ] } } } ] }, { "name": "Favorites", "item": [ { "name": "List Saved Maids", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "description": "Retrieve list of all bookmarked/favorited maids saved by the customer.\n\nReturned Fields:\n- `maids` (array): Saved helper profiles with basic identification info, rating, and agency details.", "url": { "raw": "{{base_url}}/api/customer/favorites/maids", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "favorites", "maids" ] } } }, { "name": "Toggle Favorite Maid", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"maid_id\": 12\n}" }, "url": { "raw": "{{base_url}}/api/customer/favorites/maids", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "favorites", "maids" ] } } }, { "name": "List Saved Vendors", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "description": "Retrieve list of all bookmarked/favorited agencies saved by the customer.\n\nReturned Fields:\n- `vendors` (array): Saved agency profiles with logos, descriptions, ratings, and tags.", "url": { "raw": "{{base_url}}/api/customer/favorites/vendors", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "favorites", "vendors" ] } } }, { "name": "Toggle Favorite Vendor", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"vendor_id\": 5\n}" }, "url": { "raw": "{{base_url}}/api/customer/favorites/vendors", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "favorites", "vendors" ] } } } ] }, { "name": "Quotations", "item": [ { "name": "List Quotations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/quotations", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "quotations" ], "query": [ { "key": "status", "value": "active", "description": "Filter quotations by state. Options: active (sent/accepted), completed (accepted), cancelled (declined/expired)." } ] }, "description": "Fetch all quotations received by the customer. Can filter using status query parameter (active, completed, cancelled) to populate status-specific lists." } }, { "name": "Get Quotation Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/quotations/1", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "quotations", "1" ] } } }, { "name": "Accept or Decline Quotation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"accepted\"\n}" }, "url": { "raw": "{{base_url}}/api/customer/quotations/1/action", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "quotations", "1", "action" ] } } }, { "name": "Sign Quotation / Contract", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"terms_accepted\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/api/customer/quotations/:id/sign", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "quotations", ":id", "sign" ], "variable": [ { "key": "id", "value": "1", "description": "The quotation ID to sign the associated contract for." } ] }, "description": "Customer digitally signs the contract associated with the specific quotation. This transitions the parent quotation's status to 'signed', updates the contract signature timestamp, and transitions the contract status." } } ] }, { "name": "Chat", "item": [ { "name": "List Chat Rooms", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/chat/rooms", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "chat", "rooms" ] } } }, { "name": "Register Chat Reference", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"firebase_chat_id\": \"room_cust1_vend5\",\n \"vendor_id\": 5,\n \"maid_id\": 12\n}" }, "url": { "raw": "{{base_url}}/api/customer/chat/rooms/create", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "chat", "rooms", "create" ] } } } ] }, { "name": "Notifications", "item": [ { "name": "List Notifications", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "description": "Retrieve list of notification alerts for the customer, formatted dynamically with UI-friendly metadata structures.\n\nReturned Fields:\n- `notifications` (array): Notifications with:\n - `time_ago` (string): e.g. `2 hours ago`, `Just now` relative indicators.\n - `date_group` (string): e.g. `Today`, `Yesterday`, `Earlier` for visually grouping sections.\n - `actions` (array): Mapped interactive callback action triggers including visual colors (e.g. primary, success, default) and destinations to direct the mobile application flow on click.", "url": { "raw": "{{base_url}}/api/customer/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "notifications" ] } } }, { "name": "Read Notification", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/notifications/1/read", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "notifications", "1", "read" ] } } }, { "name": "Read All Notifications", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/notifications/read-all", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "notifications", "read-all" ] } } } ] }, { "name": "Reviews", "item": [ { "name": "Submit Review", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"rating\": 4.5,\n \"comment\": \"Excellent and very professional maid.\",\n \"maid_id\": 12\n}" }, "url": { "raw": "{{base_url}}/api/customer/reviews", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "reviews" ] } } } ] }, { "name": "Support", "item": [ { "name": "List Support Tickets", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/support/tickets", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "support", "tickets" ] } } }, { "name": "Raise Support Ticket", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"Quotation pending approval\",\n \"message\": \"It has been 2 days since my quotation request was sent. Please assist.\"\n}" }, "url": { "raw": "{{base_url}}/api/customer/support/tickets", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "support", "tickets" ] } } } ] }, { "name": "Notification Settings", "item": [ { "name": "Get Notification Settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "url": { "raw": "{{base_url}}/api/customer/notification-settings", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "notification-settings" ] }, "description": "Fetches the customer's current notification settings preferences (Enable Push master toggle, Booking updates, Messages, and Account activity)." } }, { "name": "Update Notification Settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{customer_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"enable_push\": true,\n \"booking_updates\": true,\n \"messages\": true,\n \"account_activity\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{base_url}}/api/customer/notification-settings/update", "host": [ "{{base_url}}" ], "path": [ "api", "customer", "notification-settings", "update" ] }, "description": "Updates individual toggles of customer notifications preferences. Accepts boolean flags." } } ] } ] }, { "name": "Lookups & Metadata", "item": [ { "name": "List Countries", "request": { "method": "GET", "url": { "raw": "{{base_url}}/api/lookups/countries", "host": [ "{{base_url}}" ], "path": [ "api", "lookups", "countries" ] } } }, { "name": "List Cities", "request": { "method": "GET", "url": { "raw": "{{base_url}}/api/lookups/cities?country_id=1", "host": [ "{{base_url}}" ], "path": [ "api", "lookups", "cities" ] } } }, { "name": "List Nationalities", "request": { "method": "GET", "url": { "raw": "{{base_url}}/api/lookups/nationalities", "host": [ "{{base_url}}" ], "path": [ "api", "lookups", "nationalities" ] } } }, { "name": "List Languages", "request": { "method": "GET", "url": { "raw": "{{base_url}}/api/lookups/languages", "host": [ "{{base_url}}" ], "path": [ "api", "lookups", "languages" ] } } }, { "name": "List Specialties", "request": { "method": "GET", "url": { "raw": "{{base_url}}/api/lookups/specialties", "host": [ "{{base_url}}" ], "path": [ "api", "lookups", "specialties" ] } } }, { "name": "List Skills", "request": { "method": "GET", "url": { "raw": "{{base_url}}/api/lookups/skills", "host": [ "{{base_url}}" ], "path": [ "api", "lookups", "skills" ] } } }, { "name": "List Accommodation Types", "request": { "method": "GET", "url": { "raw": "{{base_url}}/api/lookups/accommodation-types", "host": [ "{{base_url}}" ], "path": [ "api", "lookups", "accommodation-types" ] } } }, { "name": "List Service Models (Working Models)", "request": { "method": "GET", "url": { "raw": "{{base_url}}/api/lookups/service-models", "host": [ "{{base_url}}" ], "path": [ "api", "lookups", "service-models" ] } } }, { "name": "List Document Types", "request": { "method": "GET", "url": { "raw": "{{base_url}}/api/lookups/document-types?owner_type=maid", "host": [ "{{base_url}}" ], "path": [ "api", "lookups", "document-types" ] } } } ] }, { "name": "Vendor", "item": [ { "name": "Auth & Settings", "item": [ { "name": "Register", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agency_name\": \"Premium Maids Dubai\",\n \"email\": \"info@premiummaids.com\",\n \"phone\": \"041234567\",\n \"password\": \"password123\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/auth/register", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "auth", "register" ] } } }, { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"vendor@test.com\",\n \"password\": \"123456\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/auth/login", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "auth", "login" ] } } }, { "name": "Profile Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/auth/profile", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "auth", "profile" ] } } }, { "name": "Forgot Password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"info@premiummaids.com\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/auth/forgot-password", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "auth", "forgot-password" ] } } }, { "name": "Reset Password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token\": \"YOUR_RESET_TOKEN\",\n \"password\": \"newpassword123\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/auth/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "auth", "reset-password" ] } } }, { "name": "Change Password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"old_password\": \"password123\",\n \"new_password\": \"newpassword123\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/auth/change-password", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "auth", "change-password" ] } } }, { "name": "Update Profile", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"agency_name\": \"Premium Maids Dubai LLC\",\n \"tagline\": \"Top rated maid service in UAE\",\n \"description\": \"Providing experienced housekeepers across Dubai.\",\n \"phone\": \"0501234567\",\n \"address\": \"Marina Gate 1, Dubai Marina\",\n \"preferred_language\": \"en\",\n \"country_id\": 1,\n \"city_id\": 1\n}" }, "url": { "raw": "{{base_url}}/api/vendor/auth/profile/update", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "auth", "profile", "update" ] } } } ] }, { "name": "Dashboard & Stats", "item": [ { "name": "Load Analytics Stats", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/dashboard/stats", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "dashboard", "stats" ] } } } ] }, { "name": "Maids & Media", "item": [ { "name": "List Maids", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/maids", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids" ] } } }, { "name": "STEP 1 \u2014 Create Maid Draft (Personal Info)", "description": "Creates the maid record with basic personal info. Returns {id} to use in all subsequent steps.\nAccepts first_name + last_name OR full_name.\n\nType IDs:\n- nationality_id: 1=Philippines, 2=India, 3=Sri Lanka, 4=Ethiopia, 5=Nepal, 6=Indonesia\n- language_ids (optional list of objects with id and proficiency): 1=Arabic, 2=English, 3=Tagalog, 4=Hindi, 5=Urdu", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"first_name\": \"Sarah\",\n \"last_name\": \"Jenkins\",\n \"nationality_id\": 5,\n \"gender\": \"female\",\n \"date_of_birth\": \"1994-05-15\",\n \"marital_status\": \"single\",\n \"language_ids\": [\n {\"id\": 1, \"proficiency\": \"fluent\"},\n {\"id\": 2, \"proficiency\": \"native\"}\n ]\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids" ] } } }, { "name": "STEP 1b \u2014 Sync Languages", "description": "Set/replace all maid languages. Accepts {languages:[{id, proficiency}]} or {language_ids:[1,2,3]}\n\nLanguage IDs:\n- 1=Arabic, 2=English, 3=Tagalog, 4=Hindi, 5=Urdu", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"languages\": [\n {\"id\": 1, \"proficiency\": \"fluent\"},\n {\"id\": 2, \"proficiency\": \"native\"}\n ]\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids/12/languages", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "languages" ] } } }, { "name": "STEP 2 \u2014 Work Details", "description": "Save experience, salary, service model, bio, custom speciality.\nAlso supports experience_location and available_from.\n\nType IDs:\n- service_model_id (working model): 1=Live-in, 2=Live-out, 3=Part-time, 4=Full-time\n- accommodation_type_id: 1=Apartment, 2=Villa, 3=Townhouse, 4=Studio", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"years_experience\": 5,\n \"experience_location\": \"Dubai, UAE\",\n \"service_model_id\": 1,\n \"monthly_salary\": 3500,\n \"bio\": \"Hi, I'm Sarah! I specialize in full-time household management, deep cleaning, and organizing.\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids/12", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12" ] } } }, { "name": "STEP 2b \u2014 Sync Specialties", "description": "Set/replace maid specialties. Optionally also set custom_speciality text.\n\nSpecialty IDs:\n- 1=Daily Housekeeping, 2=Baby Care, 3=Elderly Care, 4=Pet Care, 5=Cooking, 6=Cleaning", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"specialty_ids\": [1, 2, 3, 4],\n \"custom_speciality\": \"Taking care of elders\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids/12/specialties", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "specialties" ] } } }, { "name": "STEP 2c \u2014 Sync Skills", "description": "Set/replace maid skills.\n\nSkill IDs:\n- 1=Ironing, 2=Washing, 3=Driving, 4=Tutoring, 5=First Aid", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"skill_ids\": [1, 2, 5]\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids/12/skills", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "skills" ] } } }, { "name": "STEP 3 \u2014 Upload Profile Photo", "description": "Multipart upload. Field: profile_image. Allowed: JPG, PNG, WEBP. Max: 5MB.", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "formdata", "formdata": [ { "key": "profile_image", "type": "file", "src": [] } ] }, "url": { "raw": "{{base_url}}/api/vendor/maids/12/photo", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "photo" ] } } }, { "name": "STEP 3b \u2014 Upload Document (Passport / Emirates ID / Medical)", "description": "Fields: document_type_id, expiry_date, document (file).\n\nDocument Type IDs:\n- 2=Passport Copy (Maid)\n- 3=Visa Copy (Maid)\n- 4=Medical Certificate (Maid)\n\n(Note: ID 1 is Trade License for Vendor documents)", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "formdata", "formdata": [ { "key": "document_type_id", "value": "1", "type": "text" }, { "key": "expiry_date", "value": "2028-05-01", "type": "text" }, { "key": "document", "type": "file", "src": [] } ] }, "url": { "raw": "{{base_url}}/api/vendor/maids/12/documents", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "documents" ] } } }, { "name": "STEP 4 \u2014 Set Availability", "description": "Set availability_status (available/booked/unavailable), available_from date, and service_model_id (working model).\n\nType IDs:\n- service_model_id: 1=Live-in, 2=Live-out, 3=Part-time, 4=Full-time", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"availability_status\": \"available\",\n \"available_from\": \"2024-10-15\",\n \"service_model_id\": 1\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids/12", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12" ] } } }, { "name": "STEP 4 FINAL \u2014 Publish Profile", "description": "Publishes the maid listing. Automatically approves the profile (verification_status = approved) if not deactivated/rejected by the admin. Will return 403 if deactivated by the admin.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"published\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids/12/status", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "status" ] } } }, { "name": "Add Maid", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Maria Santos\",\n \"nationality_id\": 5,\n \"monthly_salary\": 1800,\n \"experience_years\": 4,\n \"date_of_birth\": \"1992-05-15\",\n \"gender\": \"female\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids" ] } } }, { "name": "Update Maid Details", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Maria Santos Alcantara\",\n \"monthly_salary\": 1950,\n \"availability_status\": \"available\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids/12", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12" ] } } }, { "name": "Delete Maid", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/maids/12", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12" ] } } }, { "name": "Upload Gallery Photos", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "formdata", "formdata": [ { "key": "images[]", "type": "file", "src": [] } ] }, "url": { "raw": "{{base_url}}/api/vendor/maids/12/gallery", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "gallery" ] } } }, { "name": "Delete Gallery Photo", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/maids/gallery/45", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "gallery", "45" ] } } }, { "name": "Upload Maid Passport/Documents", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "formdata", "formdata": [ { "key": "document_type_id", "value": "3", "type": "text" }, { "key": "expiry_date", "value": "2029-12-31", "type": "text" }, { "key": "document", "type": "file", "src": [] } ] }, "url": { "raw": "{{base_url}}/api/vendor/maids/12/documents", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "documents" ] } } }, { "name": "Get Maid Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/maids/12", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12" ] } } }, { "name": "Update Listing Status", "description": "Change listing status: draft, published, hidden. Can only publish if maid is verified/approved.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"published\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids/12/status", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "status" ] } } } ] }, { "name": "Work Experience", "item": [ { "name": "Add Work Experience", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"job_title\": \"Full-time Housemaid\",\n \"employer\": \"Al Rashid Family\",\n \"location\": \"Dubai Hills, Dubai UAE\",\n \"description\": \"Managing a 5-bedroom villa in Dubai Hills. Responsibilities include deep cleaning, laundry, and assisting with children.\",\n \"date_from\": \"2021-01-01\",\n \"date_to\": null,\n \"is_current\": true\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids/12/experience", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "experience" ] } } }, { "name": "Update Work Experience", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"job_title\": \"Senior Housekeeper\",\n \"description\": \"Updated job responsibilities.\",\n \"is_current\": false,\n \"date_to\": \"2023-06-30\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/maids/12/experience/3", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "experience", "3" ] } } }, { "name": "Delete Work Experience", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/maids/12/experience/3", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "maids", "12", "experience", "3" ] } } } ] }, { "name": "Interviews Scheduler", "item": [ { "name": "List Scheduled Interviews", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/interviews?status=confirmed", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "interviews" ], "query": [ { "key": "status", "value": "confirmed" } ] } } }, { "name": "Get Interview Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/interviews/5", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "interviews", "5" ] }, "description": "Retrieve comprehensive details for a specific interview request. Returns customer info (name, avatar, member year), requested helper/maid info (name, nationality, experience, rating, bio, contract badge), platform info, time range duration, and status." } }, { "name": "Get Interview Reschedule Availability Slots", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/interviews/5/availability?date=2026-06-15", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "interviews", "5", "availability" ], "query": [ { "key": "date", "value": "2026-06-15", "description": "The date to load reschedule slots for (format: YYYY-MM-DD). Defaults to the interview's current date." } ] }, "description": "Retrieve the available, taken, and selected reschedule time slots for this interview request on a specific date. Helpful for displaying the reschedule calendar and time picker." } }, { "name": "Transition Interview Status", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"confirmed\",\n \"meeting_link\": \"https://meet.google.com/azu-hori-xyz\",\n \"notes\": \"Ensure you have a good internet connection.\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/interviews/5/status", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "interviews", "5", "status" ] }, "description": "Transition the status of an interview request.\n\n### Supported Transitions:\n\n1. **`confirmed`** (Accept/Confirm Request)\n - **Use Case**: Vendor accepts the customer's interview request.\n - **Optional Fields**: `meeting_link` (string). If not provided, a Google Meet link format and a unique room ID will be automatically generated.\n - **Payload**:\n ```json\n {\n \"status\": \"confirmed\"\n }\n ```\n\n2. **`rescheduled`** (Reschedule Request)\n - **Use Case**: Vendor proposes a new date and time range for the interview.\n - **Required Fields**:\n - `interview_date` (string, YYYY-MM-DD)\n - `time_from` (string, HH:MM or HH:MM:SS)\n - `time_to` (string, HH:MM or HH:MM:SS)\n - **Optional Fields**: `notes` or `vendor_notes` (string)\n - **Payload**:\n ```json\n {\n \"status\": \"rescheduled\",\n \"interview_date\": \"2024-10-24\",\n \"time_from\": \"10:30 AM\",\n \"time_to\": \"12:00 PM\",\n \"notes\": \"Suggesting a slightly later slot on the same day.\"\n }\n ```\n\n3. **`cancelled`** (Cancel Request)\n - **Use Case**: Vendor cancels the scheduled or pending interview.\n - **Required Fields**:\n - `cancel_reason` (string): Pre-defined reason from the UI design (`\"I have a better quotation\"`, `\"Cannot meet specific requirements\"`, `\"I found another maid\"`, `\"Other reason\"`).\n - **Optional Fields**:\n - `cancel_message` (string): Optional custom note explaining the cancellation.\n - **Payload**:\n ```json\n {\n \"status\": \"cancelled\",\n \"cancel_reason\": \"I found another maid\",\n \"cancel_message\": \"The helper is no longer available for this slot.\"\n }\n ```\n\n4. **`rejected`** (Reject Request)\n - **Use Case**: Vendor rejects the customer's interview request.\n - **Optional Fields**: `notes` or `vendor_notes` (string)\n - **Payload**:\n ```json\n {\n \"status\": \"rejected\",\n \"notes\": \"We cannot accommodate this request due to scheduling conflicts.\"\n }\n ```\n\n5. **`completed`** (Mark as Completed)\n - **Use Case**: Vendor marks the interview as completed after it has been conducted.\n - **Payload**:\n ```json\n {\n \"status\": \"completed\"\n }\n ```" } }, { "name": "Reschedule Interview Request (Vendor)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"interview_date\": \"2024-10-25\",\n \"time_from\": \"10:30:00\",\n \"time_to\": \"11:15:00\",\n \"notes\": \"Proposing a new time slot.\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/interviews/5/reschedule", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "interviews", "5", "reschedule" ] }, "description": "Reschedule an interview request from the vendor side. Proposes a new date and time range for the interview.\n\n### Required Fields:\n- `interview_date` (string, YYYY-MM-DD)\n- `time_from` (string, HH:MM or HH:MM:SS)\n- `time_to` (string, HH:MM or HH:MM:SS)\n\n### Optional Fields:\n- `notes` or `vendor_notes` (string)\n\n### Rules:\n1. The new slot must be within the vendor's working hours/availability settings.\n2. The slot must not overlap with confirm bookings for the same maid." } }, { "name": "Fetch Availability Settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/interviews/availability", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "interviews", "availability" ] } } }, { "name": "Save Availability Working Days", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"slots\": [\n {\n \"day_of_week\": \"monday\",\n \"time_from\": \"09:00:00\",\n \"time_to\": \"17:00:00\"\n },\n {\n \"day_of_week\": \"wednesday\",\n \"time_from\": \"10:00:00\",\n \"time_to\": \"16:00:00\"\n }\n ]\n}" }, "url": { "raw": "{{base_url}}/api/vendor/interviews/availability", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "interviews", "availability" ] } } }, { "name": "Save Availability Duration & Timezone", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"timezone\": \"Asia/Dubai\",\n \"duration_minutes\": 45\n}" }, "url": { "raw": "{{base_url}}/api/vendor/interviews/settings", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "interviews", "settings" ] } } } ] }, { "name": "Quotation Requests & Quotations", "item": [ { "name": "Quotation Inquiries Requests", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/requests", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "requests" ] } } }, { "name": "Quotation Request Status Update", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"status\": \"declined\",\n \"decline_reason\": \"Location is outside service area\",\n \"decline_message\": \"We currently do not serve the Al-Maktoum region.\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/business/requests/10/status", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "requests", "10", "status" ] }, "description": "Update status of a quotation request.\n\n### Supported Statuses:\n\n1. **`vendor_reviewing`**\n - **Use Case**: Sent when the vendor begins reviewing the client's request.\n - **Payload**:\n ```json\n {\n \"status\": \"vendor_reviewing\"\n }\n ```\n\n2. **`declined`**\n - **Use Case**: Sent when the vendor declines the request (cannot fulfill it).\n - **Required Fields**:\n - `decline_reason` (string): Pre-defined reason from the UI (e.g. \"Fully booked for these dates\", \"Cannot meet specific requirements\", \"Location is outside service area\", \"Other reason\").\n - **Optional Fields**:\n - `decline_message` (string): Additional feedback explaining why the request cannot be accepted.\n - **Payload**:\n ```json\n {\n \"status\": \"declined\",\n \"decline_reason\": \"Location is outside service area\",\n \"decline_message\": \"We currently do not serve the Al-Maktoum region.\"\n }\n ```" } }, { "name": "List Quotations Ledger", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/quotations", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "quotations" ] } } }, { "name": "Create Quotation Draft", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"quotation_request_id\": 1003,\n \"customer_id\": 1,\n \"maid_id\": null,\n \"base_salary\": 2400,\n \"visa_processing\": 450,\n \"health_insurance\": 180,\n \"service_fee\": 120,\n \"notes\": \"Testing general quote creation with inclusions\",\n \"background_checks\": true,\n \"medical_coverage\": true,\n \"replacement_guarantee\": false\n}" }, "url": { "raw": "{{base_url}}/api/vendor/business/quotations", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "quotations" ] }, "description": "Create or update a draft quotation for a customer request, including checkable inclusions (Background Checks, Medical Coverage, and Replacement Guarantee)." } }, { "name": "Send Quotation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/quotations/15/send", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "quotations", "15", "send" ] } } }, { "name": "Send Quotation", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/quotations/15/send", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "quotations", "15", "send" ] } } }, { "name": "Get Quotation Request Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/requests/1003", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "requests", "1003" ] }, "description": "Load details of a quotation request for the vendor app, showing client's name, profile image, registration year, service model requirements, skills, and any existing quotation draft with inclusions." } }, { "name": "Get Quotation Details", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/quotations/1000", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "quotations", "1000" ] }, "description": "Load details of a specific quotation draft or sent quote for the vendor, including client metadata and inclusions." } } ] }, { "name": "Subscriptions & Billing", "item": [ { "name": "View Active Subscription Plan", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/subscription", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "subscription" ] } } }, { "name": "Get Quota Usage", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/quota", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "quota" ] } } }, { "name": "Cancel Subscription", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/subscription/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "subscription", "cancel" ] } } }, { "name": "List Saved Payment Cards", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/payment-methods", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "payment-methods" ] } } }, { "name": "Save Credit Card", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"payment_method_id\": 1,\n \"card_last_four\": \"4242\",\n \"card_brand\": \"Visa\",\n \"expiry_month\": \"12\",\n \"expiry_year\": \"2028\",\n \"is_default\": 1\n}" }, "url": { "raw": "{{base_url}}/api/vendor/business/payment-methods", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "payment-methods" ] } } }, { "name": "Delete Credit Card", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/payment-methods/8", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "payment-methods", "8" ] } } }, { "name": "Toggle Subscription Auto-Renew", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"auto_renew\": true\n}" }, "url": { "raw": "{{base_url}}/api/vendor/business/subscription/toggle-auto-renew", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "subscription", "toggle-auto-renew" ] } } }, { "name": "Download Invoice PDF", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/payments/1/invoice", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "payments", "1", "invoice" ] } } }, { "name": "Get Billing Addresses", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/billing-addresses", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "billing-addresses" ] } } }, { "name": "Add Billing Address", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"address_label\": \"Office\",\n \"name_or_company\": \"Azure Horizon Agency\",\n \"country_region\": \"United Arab Emirates\",\n \"street_address\": \"Office 402, Business Bay\",\n \"apt_suite_office\": \"Office 402\",\n \"city\": \"Dubai\",\n \"postal_zip\": \"00000\",\n \"is_default\": true\n}" }, "url": { "raw": "{{base_url}}/api/vendor/business/billing-addresses", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "billing-addresses" ] } } }, { "name": "Update Billing Address", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"address_label\": \"Office\",\n \"name_or_company\": \"Azure Horizon Agency\",\n \"country_region\": \"United Arab Emirates\",\n \"street_address\": \"Office 402, Business Bay\",\n \"apt_suite_office\": \"Office 402\",\n \"city\": \"Dubai\",\n \"postal_zip\": \"00000\",\n \"is_default\": true\n}" }, "url": { "raw": "{{base_url}}/api/vendor/business/billing-addresses/1", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "billing-addresses", "1" ] } } }, { "name": "Delete Billing Address", "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/business/billing-addresses/1", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "business", "billing-addresses", "1" ] } } } ] }, { "name": "Documents", "item": [ { "name": "List Company Documents", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/documents", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "documents" ] } } }, { "name": "Upload Company Document", "request": { "method": "POST", "description": "Upload or update a company document. Available document_type_id values: 1 = Trade License, 2 = Manager's Emirates ID, 3 = MOHRE Approval.", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "formdata", "formdata": [ { "key": "document_type_id", "value": "2", "type": "text", "description": "The ID of the document type. 1 = Trade License, 2 = Manager's Emirates ID, 3 = MOHRE Approval" }, { "key": "expiry_date", "value": "2026-12-31", "type": "text" }, { "key": "document", "type": "file", "src": "" } ] }, "url": { "raw": "{{base_url}}/api/vendor/documents", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "documents" ] } } } ] }, { "name": "Chats", "item": [ { "name": "List Chat Room References", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/chat/rooms", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "chat", "rooms" ] } } }, { "name": "Log Chat Room Reference", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"firebase_chat_id\": \"chat_room_889\",\n \"customer_id\": 2,\n \"maid_id\": 12,\n \"quotation_request_id\": 10\n}" }, "url": { "raw": "{{base_url}}/api/vendor/chat/rooms", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "chat", "rooms" ] } } } ] }, { "name": "Notifications Ledger", "item": [ { "name": "List Log Notifications", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/notifications", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "notifications" ] } } }, { "name": "Mark Read", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/notifications/44/read", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "notifications", "44", "read" ] } } }, { "name": "Mark All Read", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/notifications/read-all", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "notifications", "read-all" ] } } }, { "name": "Get Notification Settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/notifications/settings", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "notifications", "settings" ] } } }, { "name": "Update Notification Settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"enable_push\": true,\n \"booking_updates\": true,\n \"messages\": true,\n \"account_activity\": false\n}" }, "url": { "raw": "{{base_url}}/api/vendor/notifications/settings", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "notifications", "settings" ] } } } ] }, { "name": "Support System", "item": [ { "name": "List Support Tickets", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/support/tickets", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "support", "tickets" ] } } }, { "name": "Open Support Ticket", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"subject\": \"App Subscription Upgrade Issue\",\n \"message\": \"My credit card was charged but the subscription plan remains Basic. Please upgrade to Professional.\"\n}" }, "url": { "raw": "{{base_url}}/api/vendor/support/tickets", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "support", "tickets" ] } } } ] }, { "name": "Scheduler & Interview Settings", "item": [ { "name": "Get Interview Settings", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "url": { "raw": "{{base_url}}/api/vendor/interviews/settings", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "interviews", "settings" ] } } }, { "name": "Update Interview Settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{vendor_token}}" } ], "body": { "mode": "raw", "raw": "{\n \"timezone\": \"Gulf Standard Time (GST)\",\n \"duration_minutes\": 45,\n \"availability\": [\n {\n \"day_of_week\": \"monday\",\n \"is_available\": true,\n \"slots\": [\n {\"from\": \"09:00 AM\", \"to\": \"06:00 PM\"}\n ]\n },\n {\n \"day_of_week\": \"tuesday\",\n \"is_available\": true,\n \"slots\": [\n {\"from\": \"09:00 AM\", \"to\": \"06:00 PM\"}\n ]\n },\n {\n \"day_of_week\": \"wednesday\",\n \"is_available\": true,\n \"slots\": [\n {\"from\": \"09:00 AM\", \"to\": \"06:00 PM\"}\n ]\n },\n {\n \"day_of_week\": \"thursday\",\n \"is_available\": true,\n \"slots\": [\n {\"from\": \"09:00 AM\", \"to\": \"06:00 PM\"}\n ]\n },\n {\n \"day_of_week\": \"friday\",\n \"is_available\": true,\n \"slots\": [\n {\"from\": \"09:00 AM\", \"to\": \"12:00 PM\"},\n {\"from\": \"02:00 PM\", \"to\": \"06:00 PM\"}\n ]\n },\n {\n \"day_of_week\": \"saturday\",\n \"is_available\": false,\n \"slots\": []\n },\n {\n \"day_of_week\": \"sunday\",\n \"is_available\": false,\n \"slots\": []\n }\n ]\n}" }, "url": { "raw": "{{base_url}}/api/vendor/interviews/settings", "host": [ "{{base_url}}" ], "path": [ "api", "vendor", "interviews", "settings" ] } } } ] } ] }, { "name": "General", "item": [ { "name": "Get FAQs", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/faqs", "host": [ "{{base_url}}" ], "path": [ "api", "faqs" ] } } }, { "name": "Get FAQ Categories", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/faqs/categories", "host": [ "{{base_url}}" ], "path": [ "api", "faqs", "categories" ] } } }, { "name": "Get FAQs for Category", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/api/faqs/categories/1", "host": [ "{{base_url}}" ], "path": [ "api", "faqs", "categories", "1" ] } } } ] } ], "variable": [ { "key": "base_url", "value": "http://localhost/helperlink/public", "type": "string" }, { "key": "customer_token", "value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjEiLCJ0eXBlIjoiY3VzdG9tZXIiLCJleHAiOjE3Nzk2NTEzMDV9.qD4_AbGZbruUGlXw6tXSmtUwpvDi6_q60JnvDcuJpQQ", "type": "string" }, { "key": "vendor_token", "value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6MSwiZW1haWwiOiJpbmZvQHNwb3RsZXNzLmFlIiwidHlwZSI6InZlbmRvciIsImV4cCI6MTc3OTY3MzIwM30.agnTxf7xFCKdIfG7UKArc1QLjq7CpAIIAHfc3gBEZ4M", "type": "string" } ] }