{ "info": { "name": "Laravel Base API", "_postman_id": "1acf5a1f-1705-4c98-a995-a85f0096387d", "description": "Auto-generated API documentation.\nGenerated: 2026-09-24 16:01:15", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "http://localhost:8000", "type": "string" }, { "key": "admin_token", "value": "", "type": "string" }, { "key": "client_token", "value": "", "type": "string" }, { "key": "company_token", "value": "", "type": "string" }, { "key": "technician_token", "value": "", "type": "string" }, { "key": "token", "value": "", "type": "string" }, { "key": "locale", "value": "en", "type": "string" } ], "item": [ { "name": "Admin", "item": [ { "name": "Media", "item": [ { "name": "List All Media", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "media" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.media.index`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Medium", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media", "host": [ "{{base_url}}" ], "path": [ "media" ] }, "description": "**Route:** `shared.media.store`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nSend as `multipart/form-data`. Select a local file for fields marked as `file`.\n\n**Field documentation:**\n### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|file|max:10240|mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240.\n- `mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav` — custom validation rule.\n### `collection`\n- **Description:** Collection\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "", "description": "### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `null`\n- **Validation rules:** `required|file|max:10240|mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240.\n- `mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav` — custom validation rule." }, { "key": "collection", "type": "text", "src": "value", "description": "### `collection`\n- **Description:** Collection\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `null`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255." } ] } } }, { "name": "Delete Medium", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media/:media_id", "host": [ "{{base_url}}" ], "path": [ "media", ":media_id" ], "variable": [ { "key": "media_id", "value": "1", "description": "Media_id ID" } ] }, "description": "**Route:** `shared.media.destroy`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Account", "item": [ { "name": "Auth", "item": [ { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/auth/login", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "auth", "login" ] }, "description": "**Route:** `admin.auth.login`\n**Middleware:** `api, set_locale, cors, admin.login_throttle`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `admin@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `password`\n- **Validation rules:** `required|string|min:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:6` — must be at least 6.\n### `device_id`\n- **Description:** Device ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"admin@info.com\",\n \"password\": \"password\",\n \"device_id\": \"device-uuid-123\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "var response = pm.response.json();", "var token = response.data ? (response.data.token || response.data.access_token) : (response.token || response.access_token);", "if (token) {", " pm.collectionVariables.set(\"admin_token\", token);", "}" ] } } ] }, { "name": "Logout", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/auth/logout", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "auth", "logout" ] }, "description": "**Route:** `admin.auth.logout`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `device_id`\n- **Description:** Device ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"device_id\": \"device-uuid-123\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Profile", "item": [ { "name": "Show Profile Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "profile" ] }, "description": "**Route:** `admin.profile.view`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "profile" ] }, "description": "**Route:** `admin.profile.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `name`\n- **Description:** Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:160`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:160` — must not exceed 160.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `user@example.com`\n- **Validation rules:** `sometimes|email|unique:users,email,1`\n- `sometimes` — validated only when the field is present.\n- `email` — must be a valid email address.\n- `unique:users,email,1` — must be unique (users, email, 1).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `sometimes|string|max:20|unique:users,phone,1`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone,1` — must be unique (users, phone, 1).\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string`\n- `nullable` — may be null.\n- `string` — must be text.\n### `gender`\n- **Description:** Gender\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `male`\n- **Validation rules:** `sometimes|in:male,female`\n- `sometimes` — validated only when the field is present.\n- `in:male,female` — must be one of: male, female.\n### `birth_date`\n- **Description:** Birth Date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2026-09-24`\n- **Validation rules:** `nullable|date`\n- `nullable` — may be null.\n- `date` — must be a valid date.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"image\": \"value\",\n \"gender\": \"male\",\n \"birth_date\": \"2026-09-24\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Password Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/profile/change-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "profile", "change-password" ] }, "description": "**Route:** `admin.profile.change-password`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `current_password`\n- **Description:** Current Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"current_password\": \"Password123!\",\n \"password\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Addresses", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/addresses/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "addresses", "bulk" ] }, "description": "**Route:** `admin.addresses.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Addresses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/addresses?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "addresses" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.addresses.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Address", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/addresses", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "addresses" ] }, "description": "**Route:** `admin.addresses.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `user_id`\n- **Description:** Customer\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:users,id`\n- `required` — must be provided.\n- `exists:users,id` — must reference an existing record (users, id).\n### `title`\n- **Description:** Title\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Title`\n- **Validation rules:** `required|string|max:100`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:countries,id`\n- `required` — must be provided.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `governorate_id`\n- **Description:** Governorate\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:governorates,id`\n- `nullable` — may be null.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `region_id`\n- **Description:** Region\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:regions,id`\n- `nullable` — may be null.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `lat`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|between:-90,90`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `lng`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|between:-180,180`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `phone_code`\n- **Description:** Phone code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `notes`\n- **Description:** Notes\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `is_default`\n- **Description:** Default\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_id\": 1,\n \"title\": \"Example Title\",\n \"address\": \"123 Main Street, Building A\",\n \"country_id\": 1,\n \"governorate_id\": 1,\n \"region_id\": 1,\n \"lat\": 10,\n \"lng\": 10,\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"notes\": \"value\",\n \"is_default\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Address Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/addresses/:address", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "addresses", ":address" ], "variable": [ { "key": "address", "value": "1", "description": "Address ID" } ] }, "description": "**Route:** `admin.addresses.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Address", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/addresses/:address", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "addresses", ":address" ], "variable": [ { "key": "address", "value": "1", "description": "Address ID" } ] }, "description": "**Route:** `admin.addresses.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `user_id`\n- **Description:** Customer\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|exists:users,id`\n- `sometimes` — validated only when the field is present.\n- `exists:users,id` — must reference an existing record (users, id).\n### `title`\n- **Description:** Title\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Title`\n- **Validation rules:** `sometimes|string|max:100`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `sometimes|string|max:500`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|exists:countries,id`\n- `sometimes` — validated only when the field is present.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `governorate_id`\n- **Description:** Governorate\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:governorates,id`\n- `nullable` — may be null.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `region_id`\n- **Description:** Region\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:regions,id`\n- `nullable` — may be null.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `lat`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|between:-90,90`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `lng`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|between:-180,180`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `phone_code`\n- **Description:** Phone code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `notes`\n- **Description:** Notes\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `is_default`\n- **Description:** Default\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_id\": 1,\n \"title\": \"Example Title\",\n \"address\": \"123 Main Street, Building A\",\n \"country_id\": 1,\n \"governorate_id\": 1,\n \"region_id\": 1,\n \"lat\": 10,\n \"lng\": 10,\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"notes\": \"value\",\n \"is_default\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Address", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/addresses/:address", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "addresses", ":address" ], "variable": [ { "key": "address", "value": "1", "description": "Address ID" } ] }, "description": "**Route:** `admin.addresses.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Communication", "item": [ { "name": "Notifications", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/notifications/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "notifications", "bulk" ] }, "description": "**Route:** `admin.notifications.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/notifications?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "notifications" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.notifications.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/notifications/send", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "notifications", "send" ] }, "description": "**Route:** `admin.notifications.create`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `title`\n- **Description:** Title\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Title`\n- **Validation rules:** `required|string|max:200`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:200` — must not exceed 200.\n### `body`\n- **Description:** Message Body\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example message body text.`\n- **Validation rules:** `required|string|max:1000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:1000` — must not exceed 1000.\n### `target`\n- **Description:** Target\n- **Type:** `string`\n- **Required:** required\n- **Example:** `broadcast`\n- **Validation rules:** `required|in:broadcast,targeted`\n- `required` — must be provided.\n- `in:broadcast,targeted` — must be one of: broadcast, targeted.\n### `user_ids`\n- **Description:** User IDs\n- **Type:** `array`\n- **Required:** conditional\n- **Example:** `[1]`\n- **Validation rules:** `required_if:target,targeted|array`\n- `required_if:target,targeted` — required when target, targeted.\n- `array` — must be an array.\n### `user_ids.*`\n- **Description:** User ids item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `integer|exists:users,id`\n- `integer` — must be a whole number.\n- `exists:users,id` — must reference an existing record (users, id).\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Example Title\",\n \"body\": \"Example message body text.\",\n \"target\": \"broadcast\",\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/notifications/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "notifications", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.notifications.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.notifications.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Mark All Read Notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/mark-all-read", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", "mark-all-read" ] }, "description": "**Route:** `shared.notifications.mark-all-read`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Clear All Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/clear-all", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", "clear-all" ] }, "description": "**Route:** `shared.notifications.clear-all`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Show Notification Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Mark Read Notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id/read", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id", "read" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.mark-read`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Contact messages", "item": [ { "name": "List All Contact messages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contact-messages?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_read]=0", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contact-messages" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_read]", "value": "0", "description": "Filter by read status: 0 or 1", "disabled": true } ] }, "description": "**Route:** `admin.contact-messages.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_read]` — Filter by read status: 0 or 1 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Show Contact message Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contact-messages/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contact-messages", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.contact-messages.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Reply Contact message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contact-messages/:id/reply", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contact-messages", ":id", "reply" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.contact-messages.reply`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `reply`\n- **Description:** Reply\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Thank you for reaching out. We will address your concern shortly.`\n- **Validation rules:** `required|string|max:5000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reply\": \"Thank you for reaching out. We will address your concern shortly.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contact-messages/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contact-messages", "bulk" ] }, "description": "**Route:** `admin.contact-messages.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Delete Contact message", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contact-messages/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contact-messages", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.contact-messages.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] } ] }, { "name": "System", "item": [ { "name": "Settings", "item": [ { "name": "List All Settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/settings?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "settings" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.settings.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Setting", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/settings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "settings" ] }, "description": "**Route:** `admin.settings.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `settings`\n- **Description:** Settings\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[{\"key\":\"value\",\"value\":\"value\"}]`\n- **Validation rules:** `sometimes|array`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n### `settings.*.key`\n- **Description:** Setting Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|string|max:100`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `settings.*.value`\n- **Description:** Setting Value\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable`\n- `nullable` — may be null.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"settings\": [\n {\n \"key\": \"value\",\n \"value\": \"value\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Feature flags", "item": [ { "name": "List All Feature flags", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/feature-flags?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "feature-flags" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.feature-flags.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Feature flag", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/feature-flags", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "feature-flags" ] }, "description": "**Route:** `admin.feature-flags.create`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** required\n- **Example:** `new_checkout_flow`\n- **Validation rules:** `required|string|max:100|unique:feature_flags,key,NULL,id`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n- `unique:feature_flags,key,NULL,id` — must be unique (feature_flags, key, NULL, id).\n### `is_enabled`\n- **Description:** Is Enabled\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `targeting_rules`\n- **Description:** Targeting Rules\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `description`\n- **Description:** Description\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `nullable|string`\n- `nullable` — may be null.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"new_checkout_flow\",\n \"is_enabled\": true,\n \"targeting_rules\": [],\n \"description\": \"Example content text\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Feature flag Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/feature-flags/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "feature-flags", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.feature-flags.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Feature flag", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/feature-flags/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "feature-flags", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.feature-flags.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `new_checkout_flow`\n- **Validation rules:** `sometimes|string|max:100|unique:feature_flags,key,NULL,id`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n- `unique:feature_flags,key,NULL,id` — must be unique (feature_flags, key, NULL, id).\n### `is_enabled`\n- **Description:** Is Enabled\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `targeting_rules`\n- **Description:** Targeting Rules\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `description`\n- **Description:** Description\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `nullable|string`\n- `nullable` — may be null.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"new_checkout_flow\",\n \"is_enabled\": true,\n \"targeting_rules\": [],\n \"description\": \"Example content text\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/feature-flags/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "feature-flags", "bulk" ] }, "description": "**Route:** `admin.feature-flags.bulk.delete`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Delete Feature flag", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/feature-flags/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "feature-flags", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.feature-flags.delete`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Toggle Feature flag Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/feature-flags/:id/toggle", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "feature-flags", ":id", "toggle" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.feature-flags.toggle`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Audit logs", "item": [ { "name": "List All Audit logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/audit-logs?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&model=App\\Models\\User&actor_id=1&action=created&from=2024-01-01&to=2024-12-31", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "audit-logs" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "model", "value": "App\\Models\\User", "description": "Filter by model class", "disabled": true }, { "key": "actor_id", "value": "1", "description": "Filter by actor user ID", "disabled": true }, { "key": "action", "value": "created", "description": "Filter by action: created, updated, deleted", "disabled": true }, { "key": "from", "value": "2024-01-01", "description": "Filter from date", "disabled": true }, { "key": "to", "value": "2024-12-31", "description": "Filter to date", "disabled": true } ] }, "description": "**Route:** `admin.audit-logs.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `model` — Filter by model class (optional)\n- `actor_id` — Filter by actor user ID (optional)\n- `action` — Filter by action: created, updated, deleted (optional)\n- `from` — Filter from date (optional)\n- `to` — Filter to date (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Dashboard", "item": [ { "name": "List All Dashboard", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "dashboard" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.dashboard.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Technicians Dashboard", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/technicians", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "dashboard", "technicians" ] }, "description": "**Route:** `admin.dashboard.technicians`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Companies Dashboard", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/dashboard/companies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "dashboard", "companies" ] }, "description": "**Route:** `admin.dashboard.companies`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Health", "item": [ { "name": "List All Health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/health?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "health" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.health.index`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Config", "item": [ { "name": "Bootstrap Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/config/bootstrap", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "config", "bootstrap" ] }, "description": "**Route:** `shared.config.bootstrap`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] }, { "name": "Content", "item": [ { "name": "Faqs", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/faqs/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "faqs", "bulk" ] }, "description": "**Route:** `admin.faqs.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Faqs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/faqs?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "faqs" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.faqs.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Faq", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/faqs", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "faqs" ] }, "description": "**Route:** `admin.faqs.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `type`\n- **Description:** Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|in:\"1\",\"2\",\"3\",\"4\"`\n- `sometimes` — validated only when the field is present.\n- `in:\"1\",\"2\",\"3\",\"4\"` — must be one of: \"1\", \"2\", \"3\", \"4\".\n### `en.question`\n- **Description:** Question (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `What is this?`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `en.answer`\n- **Description:** Answer (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `This is the answer.`\n- **Validation rules:** `required|string|max:5000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\n### `ar.question`\n- **Description:** Question (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `What is this?`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `ar.answer`\n- **Description:** Answer (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `This is the answer.`\n- **Validation rules:** `required|string|max:5000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"is_active\": true,\n \"type\": \"1\",\n \"en\": {\n \"question\": \"What is this?\",\n \"answer\": \"This is the answer.\"\n },\n \"ar\": {\n \"question\": \"What is this?\",\n \"answer\": \"This is the answer.\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Faq Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/faqs/:faq", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "faqs", ":faq" ], "variable": [ { "key": "faq", "value": "1", "description": "Faq ID" } ] }, "description": "**Route:** `admin.faqs.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Faq", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/faqs/:faq", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "faqs", ":faq" ], "variable": [ { "key": "faq", "value": "1", "description": "Faq ID" } ] }, "description": "**Route:** `admin.faqs.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `type`\n- **Description:** Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|in:\"1\",\"2\",\"3\",\"4\"`\n- `sometimes` — validated only when the field is present.\n- `in:\"1\",\"2\",\"3\",\"4\"` — must be one of: \"1\", \"2\", \"3\", \"4\".\n### `en.question`\n- **Description:** Question (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `What is this?`\n- **Validation rules:** `sometimes|string|max:500`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `en.answer`\n- **Description:** Answer (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `This is the answer.`\n- **Validation rules:** `sometimes|string|max:5000`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\n### `ar.question`\n- **Description:** Question (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `What is this?`\n- **Validation rules:** `sometimes|string|max:500`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `ar.answer`\n- **Description:** Answer (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `This is the answer.`\n- **Validation rules:** `sometimes|string|max:5000`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"is_active\": true,\n \"type\": \"1\",\n \"en\": {\n \"question\": \"What is this?\",\n \"answer\": \"This is the answer.\"\n },\n \"ar\": {\n \"question\": \"What is this?\",\n \"answer\": \"This is the answer.\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Faq", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/faqs/:faq", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "faqs", ":faq" ], "variable": [ { "key": "faq", "value": "1", "description": "Faq ID" } ] }, "description": "**Route:** `admin.faqs.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Pages", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/pages/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "pages", "bulk" ] }, "description": "**Route:** `admin.pages.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Pages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/pages?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "pages" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.pages.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Page", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/pages", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "pages" ] }, "description": "**Route:** `admin.pages.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `type`\n- **Description:** Type\n- **Type:** `string`\n- **Required:** required\n- **Example:** `about_us`\n- **Validation rules:** `required|in:\"about_us\",\"privacy_policy\",\"warranty_policy\",\"return_policy\",\"shipping_policy\"`\n- `required` — must be provided.\n- `in:\"about_us\",\"privacy_policy\",\"warranty_policy\",\"return_policy\",\"shipping_policy\"` — must be one of: \"about_us\", \"privacy_policy\", \"warranty_policy\", \"return_policy\", \"shipping_policy\".\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `en.title`\n- **Description:** Title (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Title`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.content`\n- **Description:** Content (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example content text`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `ar.title`\n- **Description:** Title (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Title`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.content`\n- **Description:** Content (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example content text`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"about_us\",\n \"is_active\": true,\n \"image\": \"value\",\n \"en\": {\n \"title\": \"Example Title\",\n \"content\": \"Example content text\"\n },\n \"ar\": {\n \"title\": \"Example Title\",\n \"content\": \"Example content text\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Page Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/pages/:page", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "pages", ":page" ], "variable": [ { "key": "page", "value": "1", "description": "Page ID" } ] }, "description": "**Route:** `admin.pages.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Page", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/pages/:page", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "pages", ":page" ], "variable": [ { "key": "page", "value": "1", "description": "Page ID" } ] }, "description": "**Route:** `admin.pages.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `type`\n- **Description:** Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `about_us`\n- **Validation rules:** `sometimes|in:\"about_us\",\"privacy_policy\",\"warranty_policy\",\"return_policy\",\"shipping_policy\"`\n- `sometimes` — validated only when the field is present.\n- `in:\"about_us\",\"privacy_policy\",\"warranty_policy\",\"return_policy\",\"shipping_policy\"` — must be one of: \"about_us\", \"privacy_policy\", \"warranty_policy\", \"return_policy\", \"shipping_policy\".\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `en.title`\n- **Description:** Title (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Title`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.content`\n- **Description:** Content (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `sometimes|string`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n### `ar.title`\n- **Description:** Title (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Title`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.content`\n- **Description:** Content (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `sometimes|string`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"type\": \"about_us\",\n \"is_active\": true,\n \"image\": \"value\",\n \"en\": {\n \"title\": \"Example Title\",\n \"content\": \"Example content text\"\n },\n \"ar\": {\n \"title\": \"Example Title\",\n \"content\": \"Example content text\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Page", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/pages/:page", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "pages", ":page" ], "variable": [ { "key": "page", "value": "1", "description": "Page ID" } ] }, "description": "**Route:** `admin.pages.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Sliders", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/sliders/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "sliders", "bulk" ] }, "description": "**Route:** `admin.sliders.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Sliders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/sliders?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "sliders" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.sliders.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Slider", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/sliders", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "sliders" ] }, "description": "**Route:** `admin.sliders.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `link`\n- **Description:** Link\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `https://example.com`\n- **Validation rules:** `nullable|url|max:500`\n- `nullable` — may be null.\n- `url` — must be a valid URL.\n- `max:500` — must not exceed 500.\n### `sort_order`\n- **Description:** Sort Order\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `en.title`\n- **Description:** Title (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Title`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.subtitle`\n- **Description:** Subtitle (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Title`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `ar.title`\n- **Description:** Title (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Title`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.subtitle`\n- **Description:** Subtitle (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Title`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"link\": \"https://example.com\",\n \"sort_order\": 1,\n \"is_active\": true,\n \"image\": \"value\",\n \"en\": {\n \"title\": \"Example Title\",\n \"subtitle\": \"Example Title\"\n },\n \"ar\": {\n \"title\": \"Example Title\",\n \"subtitle\": \"Example Title\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Slider Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/sliders/:slider", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "sliders", ":slider" ], "variable": [ { "key": "slider", "value": "1", "description": "Slider ID" } ] }, "description": "**Route:** `admin.sliders.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Slider", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/sliders/:slider", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "sliders", ":slider" ], "variable": [ { "key": "slider", "value": "1", "description": "Slider ID" } ] }, "description": "**Route:** `admin.sliders.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `link`\n- **Description:** Link\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `https://example.com`\n- **Validation rules:** `nullable|url|max:500`\n- `nullable` — may be null.\n- `url` — must be a valid URL.\n- `max:500` — must not exceed 500.\n### `sort_order`\n- **Description:** Sort Order\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `en.title`\n- **Description:** Title (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Title`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.subtitle`\n- **Description:** Subtitle (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Title`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `ar.title`\n- **Description:** Title (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Title`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.subtitle`\n- **Description:** Subtitle (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Title`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"link\": \"https://example.com\",\n \"sort_order\": 1,\n \"is_active\": true,\n \"image\": \"value\",\n \"en\": {\n \"title\": \"Example Title\",\n \"subtitle\": \"Example Title\"\n },\n \"ar\": {\n \"title\": \"Example Title\",\n \"subtitle\": \"Example Title\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Slider", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/sliders/:slider", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "sliders", ":slider" ], "variable": [ { "key": "slider", "value": "1", "description": "Slider ID" } ] }, "description": "**Route:** `admin.sliders.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Categories", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/categories/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "categories", "bulk" ] }, "description": "**Route:** `admin.categories.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/categories?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "categories" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.categories.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Category", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/categories", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "categories" ] }, "description": "**Route:** `admin.categories.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `parent_id`\n- **Description:** Parent Category\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `prohibited`\n- `prohibited` — custom validation rule.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `sort_order`\n- **Description:** Sort Order\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `with_visit`\n- **Description:** With Visit\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `nullable|boolean`\n- `nullable` — may be null.\n- `boolean` — must be true, false, 1, or 0.\n### `visit_price`\n- **Description:** Visit Price\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n### `visit_contract_price`\n- **Description:** Visit Contract Price\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.description`\n- **Description:** Description (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `nullable|string|max:2000`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.description`\n- **Description:** Description (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `nullable|string|max:2000`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"parent_id\": 1,\n \"is_active\": true,\n \"sort_order\": 1,\n \"image\": \"value\",\n \"with_visit\": true,\n \"visit_price\": 10,\n \"visit_contract_price\": 10,\n \"en\": {\n \"name\": \"Example Name\",\n \"description\": \"Example content text\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"description\": \"Example content text\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Category Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/categories/:category", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "categories", ":category" ], "variable": [ { "key": "category", "value": "1", "description": "Category ID" } ] }, "description": "**Route:** `admin.categories.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Category", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/categories/:category", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "categories", ":category" ], "variable": [ { "key": "category", "value": "1", "description": "Category ID" } ] }, "description": "**Route:** `admin.categories.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `parent_id`\n- **Description:** Parent Category\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `prohibited`\n- `prohibited` — custom validation rule.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `sort_order`\n- **Description:** Sort Order\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `with_visit`\n- **Description:** With Visit\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `nullable|boolean`\n- `nullable` — may be null.\n- `boolean` — must be true, false, 1, or 0.\n### `visit_price`\n- **Description:** Visit Price\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n### `visit_contract_price`\n- **Description:** Visit Contract Price\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.description`\n- **Description:** Description (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `nullable|string|max:2000`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.description`\n- **Description:** Description (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `nullable|string|max:2000`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"parent_id\": 1,\n \"is_active\": true,\n \"sort_order\": 1,\n \"image\": \"value\",\n \"with_visit\": true,\n \"visit_price\": 10,\n \"visit_contract_price\": 10,\n \"en\": {\n \"name\": \"Example Name\",\n \"description\": \"Example content text\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"description\": \"Example content text\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Category", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/categories/:category", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "categories", ":category" ], "variable": [ { "key": "category", "value": "1", "description": "Category ID" } ] }, "description": "**Route:** `admin.categories.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Edit Category", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/categories/:id/status", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "categories", ":id", "status" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.categories.edit`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Services", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/services/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "services", "bulk" ] }, "description": "**Route:** `admin.services.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Services", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/services?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "services" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.services.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Service", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/services", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "services" ] }, "description": "**Route:** `admin.services.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `parent_id`\n- **Description:** Category\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:categories,id,parent_id,\"NULL\"`\n- `required` — must be provided.\n- `exists:categories,id,parent_id,\"NULL\"` — must reference an existing record (categories, id, parent_id, \"NULL\").\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `sort_order`\n- **Description:** Sort Order\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `price`\n- **Description:** Price\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n### `contract_price`\n- **Description:** Contract Price\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n### `is_visit`\n- **Description:** Is Visit\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `nullable|boolean`\n- `nullable` — may be null.\n- `boolean` — must be true, false, 1, or 0.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.description`\n- **Description:** Description (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `nullable|string|max:2000`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.description`\n- **Description:** Description (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `nullable|string|max:2000`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"parent_id\": 1,\n \"is_active\": true,\n \"sort_order\": 1,\n \"image\": \"value\",\n \"price\": 10,\n \"contract_price\": 10,\n \"is_visit\": true,\n \"en\": {\n \"name\": \"Example Name\",\n \"description\": \"Example content text\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"description\": \"Example content text\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Service Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/services/:service", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "services", ":service" ], "variable": [ { "key": "service", "value": "1", "description": "Service ID" } ] }, "description": "**Route:** `admin.services.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Service", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/services/:service", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "services", ":service" ], "variable": [ { "key": "service", "value": "1", "description": "Service ID" } ] }, "description": "**Route:** `admin.services.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `parent_id`\n- **Description:** Category\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|exists:categories,id,parent_id,\"NULL\"`\n- `sometimes` — validated only when the field is present.\n- `exists:categories,id,parent_id,\"NULL\"` — must reference an existing record (categories, id, parent_id, \"NULL\").\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `sort_order`\n- **Description:** Sort Order\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `price`\n- **Description:** Price\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n### `contract_price`\n- **Description:** Contract Price\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n### `is_visit`\n- **Description:** Is Visit\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `nullable|boolean`\n- `nullable` — may be null.\n- `boolean` — must be true, false, 1, or 0.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.description`\n- **Description:** Description (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `nullable|string|max:2000`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.description`\n- **Description:** Description (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `nullable|string|max:2000`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"parent_id\": 1,\n \"is_active\": true,\n \"sort_order\": 1,\n \"image\": \"value\",\n \"price\": 10,\n \"contract_price\": 10,\n \"is_visit\": true,\n \"en\": {\n \"name\": \"Example Name\",\n \"description\": \"Example content text\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"description\": \"Example content text\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Service", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/services/:service", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "services", ":service" ], "variable": [ { "key": "service", "value": "1", "description": "Service ID" } ] }, "description": "**Route:** `admin.services.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Geo", "item": [ { "name": "Countries", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/countries/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "countries", "bulk" ] }, "description": "**Route:** `admin.countries.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Countries", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/countries?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[continent]=asia", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "countries" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true }, { "key": "filters[continent]", "value": "asia", "description": "Filter by continent", "disabled": true } ] }, "description": "**Route:** `admin.countries.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n- `filters[continent]` — Filter by continent (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Country", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/countries", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "countries" ] }, "description": "**Route:** `admin.countries.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `20`\n- **Validation rules:** `required|string|max:5|unique:countries,phone_code,NULL,id`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n- `unique:countries,phone_code,NULL,id` — must be unique (countries, phone_code, NULL, id).\n### `phone_starting_number`\n- **Description:** Phone Starting Number\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|string|max:10`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:10` — must not exceed 10.\n### `phone_length`\n- **Description:** Phone Length\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|between:5,15`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `between:5,15` — must be between 5, 15.\n### `short_name`\n- **Description:** Short Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:10`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:10` — must not exceed 10.\n### `continent`\n- **Description:** Continent\n- **Type:** `string`\n- **Required:** required\n- **Example:** `africa`\n- **Validation rules:** `required|in:\"africa\",\"europe\",\"asia\",\"south_america\",\"north_america\",\"australia\"`\n- `required` — must be provided.\n- `in:\"africa\",\"europe\",\"asia\",\"south_america\",\"north_america\",\"australia\"` — must be one of: \"africa\", \"europe\", \"asia\", \"south_america\", \"north_america\", \"australia\".\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `flag`\n- **Description:** Flag\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.slug`\n- **Description:** Slug (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.currency`\n- **Description:** Currency (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `EGP`\n- **Validation rules:** `required|string|max:50`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `en.nationality`\n- **Description:** Nationality (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Egyptian`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.slug`\n- **Description:** Slug (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.currency`\n- **Description:** Currency (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `EGP`\n- **Validation rules:** `required|string|max:50`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `ar.nationality`\n- **Description:** Nationality (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Egyptian`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"phone_code\": \"20\",\n \"phone_starting_number\": \"1234567890\",\n \"phone_length\": 1,\n \"short_name\": \"Example Name\",\n \"continent\": \"africa\",\n \"is_active\": true,\n \"flag\": \"value\",\n \"en\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\",\n \"currency\": \"EGP\",\n \"nationality\": \"Egyptian\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\",\n \"currency\": \"EGP\",\n \"nationality\": \"Egyptian\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Country Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/countries/:country", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "countries", ":country" ], "variable": [ { "key": "country", "value": "1", "description": "Country ID" } ] }, "description": "**Route:** `admin.countries.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Country", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/countries/:country", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "countries", ":country" ], "variable": [ { "key": "country", "value": "1", "description": "Country ID" } ] }, "description": "**Route:** `admin.countries.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `sometimes|string|max:5|unique:countries,phone_code,NULL,id`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n- `unique:countries,phone_code,NULL,id` — must be unique (countries, phone_code, NULL, id).\n### `phone_starting_number`\n- **Description:** Phone Starting Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `sometimes|string|max:10`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:10` — must not exceed 10.\n### `phone_length`\n- **Description:** Phone Length\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|between:5,15`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `between:5,15` — must be between 5, 15.\n### `short_name`\n- **Description:** Short Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:10`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:10` — must not exceed 10.\n### `continent`\n- **Description:** Continent\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `africa`\n- **Validation rules:** `sometimes|in:\"africa\",\"europe\",\"asia\",\"south_america\",\"north_america\",\"australia\"`\n- `sometimes` — validated only when the field is present.\n- `in:\"africa\",\"europe\",\"asia\",\"south_america\",\"north_america\",\"australia\"` — must be one of: \"africa\", \"europe\", \"asia\", \"south_america\", \"north_america\", \"australia\".\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `flag`\n- **Description:** Flag\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.slug`\n- **Description:** Slug (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.currency`\n- **Description:** Currency (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `EGP`\n- **Validation rules:** `sometimes|string|max:50`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `en.nationality`\n- **Description:** Nationality (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Egyptian`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.slug`\n- **Description:** Slug (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.currency`\n- **Description:** Currency (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `EGP`\n- **Validation rules:** `sometimes|string|max:50`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `ar.nationality`\n- **Description:** Nationality (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Egyptian`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"phone_code\": \"20\",\n \"phone_starting_number\": \"1234567890\",\n \"phone_length\": 1,\n \"short_name\": \"Example Name\",\n \"continent\": \"africa\",\n \"is_active\": true,\n \"flag\": \"value\",\n \"en\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\",\n \"currency\": \"EGP\",\n \"nationality\": \"Egyptian\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\",\n \"currency\": \"EGP\",\n \"nationality\": \"Egyptian\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Country", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/countries/:country", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "countries", ":country" ], "variable": [ { "key": "country", "value": "1", "description": "Country ID" } ] }, "description": "**Route:** `admin.countries.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Governorates", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/governorates/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "governorates", "bulk" ] }, "description": "**Route:** `admin.governorates.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Governorates", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/governorates?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[country_id]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "governorates" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[country_id]", "value": "1", "description": "Filter by country ID", "disabled": true } ] }, "description": "**Route:** `admin.governorates.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n- `filters[country_id]` — Filter by country ID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Governorate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/governorates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "governorates" ] }, "description": "**Route:** `admin.governorates.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:countries,id`\n- `required` — must be provided.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `lat`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|between:-90,90`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `lng`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|between:-180,180`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `sort_order`\n- **Description:** Sort Order\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.slug`\n- **Description:** Slug (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.slug`\n- **Description:** Slug (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"country_id\": 1,\n \"lat\": 10,\n \"lng\": 10,\n \"is_active\": true,\n \"sort_order\": 1,\n \"en\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Governorate Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/governorates/:governorate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "governorates", ":governorate" ], "variable": [ { "key": "governorate", "value": "1", "description": "Governorate ID" } ] }, "description": "**Route:** `admin.governorates.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Governorate", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/governorates/:governorate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "governorates", ":governorate" ], "variable": [ { "key": "governorate", "value": "1", "description": "Governorate ID" } ] }, "description": "**Route:** `admin.governorates.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|exists:countries,id`\n- `sometimes` — validated only when the field is present.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `lat`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|between:-90,90`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `lng`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|between:-180,180`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `sort_order`\n- **Description:** Sort Order\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.slug`\n- **Description:** Slug (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.slug`\n- **Description:** Slug (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"country_id\": 1,\n \"lat\": 10,\n \"lng\": 10,\n \"is_active\": true,\n \"sort_order\": 1,\n \"en\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Governorate", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/governorates/:governorate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "governorates", ":governorate" ], "variable": [ { "key": "governorate", "value": "1", "description": "Governorate ID" } ] }, "description": "**Route:** `admin.governorates.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Regions", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/regions/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "regions", "bulk" ] }, "description": "**Route:** `admin.regions.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Regions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/regions?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[governorate_id]=1&filters[shipping_zone_id]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "regions" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[governorate_id]", "value": "1", "description": "Filter by governorate ID", "disabled": true }, { "key": "filters[shipping_zone_id]", "value": "1", "description": "Filter by shipping zone ID", "disabled": true } ] }, "description": "**Route:** `admin.regions.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n- `filters[governorate_id]` — Filter by governorate ID (optional)\n- `filters[shipping_zone_id]` — Filter by shipping zone ID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Region", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/regions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "regions" ] }, "description": "**Route:** `admin.regions.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `governorate_id`\n- **Description:** Governorate\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:governorates,id`\n- `required` — must be provided.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `shipping_zone_id`\n- **Description:** Shipping Zone\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:shipping_zones,id`\n- `nullable` — may be null.\n- `exists:shipping_zones,id` — must reference an existing record (shipping_zones, id).\n### `lat`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|between:-90,90`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `lng`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|between:-180,180`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `sort_order`\n- **Description:** Sort Order\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.slug`\n- **Description:** Slug (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.slug`\n- **Description:** Slug (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"governorate_id\": 1,\n \"shipping_zone_id\": 1,\n \"lat\": 10,\n \"lng\": 10,\n \"is_active\": true,\n \"sort_order\": 1,\n \"en\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Region Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/regions/:region", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "regions", ":region" ], "variable": [ { "key": "region", "value": "1", "description": "Region ID" } ] }, "description": "**Route:** `admin.regions.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Region", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/regions/:region", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "regions", ":region" ], "variable": [ { "key": "region", "value": "1", "description": "Region ID" } ] }, "description": "**Route:** `admin.regions.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `governorate_id`\n- **Description:** Governorate\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|exists:governorates,id`\n- `sometimes` — validated only when the field is present.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `shipping_zone_id`\n- **Description:** Shipping Zone\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:shipping_zones,id`\n- `nullable` — may be null.\n- `exists:shipping_zones,id` — must reference an existing record (shipping_zones, id).\n### `lat`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|between:-90,90`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `lng`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|between:-180,180`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `sort_order`\n- **Description:** Sort Order\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.slug`\n- **Description:** Slug (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.slug`\n- **Description:** Slug (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"governorate_id\": 1,\n \"shipping_zone_id\": 1,\n \"lat\": 10,\n \"lng\": 10,\n \"is_active\": true,\n \"sort_order\": 1,\n \"en\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Region", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/regions/:region", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "regions", ":region" ], "variable": [ { "key": "region", "value": "1", "description": "Region ID" } ] }, "description": "**Route:** `admin.regions.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Shipping zones", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/shipping-zones/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "shipping-zones", "bulk" ] }, "description": "**Route:** `admin.shipping-zones.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Shipping zones", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/shipping-zones?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[country_id]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "shipping-zones" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[country_id]", "value": "1", "description": "Filter by country ID", "disabled": true } ] }, "description": "**Route:** `admin.shipping-zones.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n- `filters[country_id]` — Filter by country ID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Shipping zone", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/shipping-zones", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "shipping-zones" ] }, "description": "**Route:** `admin.shipping-zones.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:countries,id`\n- `required` — must be provided.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `shipping_cost`\n- **Description:** Shipping Cost\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|min:0`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `min:0` — must be at least .\n### `delivery_eta_min_days`\n- **Description:** Min Delivery Days\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|min:0`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `min:0` — must be at least .\n### `delivery_eta_max_days`\n- **Description:** Max Delivery Days\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|min:0`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `min:0` — must be at least .\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.slug`\n- **Description:** Slug (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.slug`\n- **Description:** Slug (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"country_id\": 1,\n \"shipping_cost\": 10,\n \"delivery_eta_min_days\": 1,\n \"delivery_eta_max_days\": 1,\n \"is_active\": true,\n \"en\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Shipping zone Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/shipping-zones/:shipping_zone", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "shipping-zones", ":shipping_zone" ], "variable": [ { "key": "shipping_zone", "value": "1", "description": "Shipping_zone ID" } ] }, "description": "**Route:** `admin.shipping-zones.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Shipping zone", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/shipping-zones/:shipping_zone", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "shipping-zones", ":shipping_zone" ], "variable": [ { "key": "shipping_zone", "value": "1", "description": "Shipping_zone ID" } ] }, "description": "**Route:** `admin.shipping-zones.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|exists:countries,id`\n- `sometimes` — validated only when the field is present.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `shipping_cost`\n- **Description:** Shipping Cost\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|min:0`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `min:0` — must be at least .\n### `delivery_eta_min_days`\n- **Description:** Min Delivery Days\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:0`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `min:0` — must be at least .\n### `delivery_eta_max_days`\n- **Description:** Max Delivery Days\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:0`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `min:0` — must be at least .\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `en.slug`\n- **Description:** Slug (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.slug`\n- **Description:** Slug (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"country_id\": 1,\n \"shipping_cost\": 10,\n \"delivery_eta_min_days\": 1,\n \"delivery_eta_max_days\": 1,\n \"is_active\": true,\n \"en\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"slug\": \"example-slug\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Shipping zone", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/shipping-zones/:shipping_zone", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "shipping-zones", ":shipping_zone" ], "variable": [ { "key": "shipping_zone", "value": "1", "description": "Shipping_zone ID" } ] }, "description": "**Route:** `admin.shipping-zones.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Access", "item": [ { "name": "Users", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users", "bulk" ] }, "description": "**Route:** `admin.users.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[status]=active&filters[user_type]=individual&from=2024-01-01&to=2024-12-31", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[status]", "value": "active", "description": "Filter by status: active, pending, suspended, rejected", "disabled": true }, { "key": "filters[user_type]", "value": "individual", "description": "Filter by user type: individual, company, technician", "disabled": true }, { "key": "from", "value": "2024-01-01", "description": "Filter from date", "disabled": true }, { "key": "to", "value": "2024-12-31", "description": "Filter to date", "disabled": true } ] }, "description": "**Route:** `admin.users.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[status]` — Filter by status: active, pending, suspended, rejected (optional)\n- `filters[user_type]` — Filter by user type: individual, company, technician (optional)\n- `from` — Filter from date (optional)\n- `to` — Filter to date (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New User", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users" ] }, "description": "**Route:** `admin.users.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `user_type`\n- **Description:** Account Type\n- **Type:** `string`\n- **Required:** required\n- **Example:** `super_admin`\n- **Validation rules:** `required|in:super_admin,admin,individual,company,technician`\n- `required` — must be provided.\n- `in:super_admin,admin,individual,company,technician` — must be one of: super_admin, admin, individual, company, technician.\n### `name`\n- **Description:** Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:160`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:160` — must not exceed 160.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|unique:users,email,NULL,id`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `unique:users,email,NULL,id` — must be unique (users, email, NULL, id).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20|unique:users,phone,NULL,id`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone,NULL,id` — must be unique (users, phone, NULL, id).\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|nullable|string|min:8`\n- `required` — must be provided.\n- `nullable` — may be null.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n### `status`\n- **Description:** Status\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `pending`\n- **Validation rules:** `sometimes|in:pending,active,suspended,rejected`\n- `sometimes` — validated only when the field is present.\n- `in:pending,active,suspended,rejected` — must be one of: pending, active, suspended, rejected.\n### `locale`\n- **Description:** Locale\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `en`\n- **Validation rules:** `nullable|in:\"en\",\"ar\"`\n- `nullable` — may be null.\n- `in:\"en\",\"ar\"` — must be one of: \"en\", \"ar\".\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** conditional\n- **Example:** `Example Name`\n- **Validation rules:** `nullable|required_if:user_type,technician|string|max:150`\n- `nullable` — may be null.\n- `required_if:user_type,technician` — required when user_type, technician.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `legal_name`\n- **Description:** Legal Company Name\n- **Type:** `string`\n- **Required:** conditional\n- **Example:** `Example Name`\n- **Validation rules:** `required_if:user_type,company|string|max:200`\n- `required_if:user_type,company` — required when user_type, company.\n- `string` — must be text.\n- `max:200` — must not exceed 200.\n### `tax_number`\n- **Description:** VAT Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `300012345600003`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_registration_no`\n- **Description:** Commercial Registration Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1010101010`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `account_owner_phone`\n- **Description:** Account Owner Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `category_id`\n- **Description:** Service Category\n- **Type:** `integer`\n- **Required:** conditional\n- **Example:** `2`\n- **Validation rules:** `required_if:user_type,technician|integer|exists:categories,id`\n- `required_if:user_type,technician` — required when user_type, technician.\n- `integer` — must be a whole number.\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `daily_order_capacity`\n- **Description:** Daily Order Capacity\n- **Type:** `integer`\n- **Required:** conditional\n- **Example:** `1`\n- **Validation rules:** `required_if:user_type,technician|integer|min:1`\n- `required_if:user_type,technician` — required when user_type, technician.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n### `employment_type`\n- **Description:** Employment Type\n- **Type:** `string`\n- **Required:** conditional\n- **Example:** `in_house`\n- **Validation rules:** `required_if:user_type,technician|string|in:in_house,freelance`\n- `required_if:user_type,technician` — required when user_type, technician.\n- `string` — must be text.\n- `in:in_house,freelance` — must be one of: in_house, freelance.\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:countries,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `governorate_id`\n- **Description:** City\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:governorates,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `region_id`\n- **Description:** District\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:regions,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `years_experience`\n- **Description:** Years experience\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|min:0`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:0` — must be at least .\n### `coverage_areas`\n- **Description:** Coverage Areas (Regions)\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[1]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `coverage_areas.*`\n- **Description:** Coverage areas item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `integer|exists:regions,id`\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_type\": \"super_admin\",\n \"name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"password\": \"Password123!\",\n \"status\": \"pending\",\n \"locale\": \"en\",\n \"full_name\": \"Example Name\",\n \"legal_name\": \"Example Name\",\n \"tax_number\": \"300012345600003\",\n \"commercial_registration_no\": \"1010101010\",\n \"account_owner_phone\": \"1234567890\",\n \"category_id\": 2,\n \"daily_order_capacity\": 1,\n \"employment_type\": \"in_house\",\n \"address\": \"123 Main Street, Building A\",\n \"country_id\": 1,\n \"governorate_id\": 1,\n \"region_id\": 1,\n \"years_experience\": 1,\n \"coverage_areas\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show User Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users/:user", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users", ":user" ], "variable": [ { "key": "user", "value": "1", "description": "User ID" } ] }, "description": "**Route:** `admin.users.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update User", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users/:user", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users", ":user" ], "variable": [ { "key": "user", "value": "1", "description": "User ID" } ] }, "description": "**Route:** `admin.users.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `user_type`\n- **Description:** Account Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `super_admin`\n- **Validation rules:** `sometimes|in:super_admin,admin,individual,company,technician`\n- `sometimes` — validated only when the field is present.\n- `in:super_admin,admin,individual,company,technician` — must be one of: super_admin, admin, individual, company, technician.\n### `name`\n- **Description:** Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:160`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:160` — must not exceed 160.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `user@example.com`\n- **Validation rules:** `sometimes|email|unique:users,email,NULL,id`\n- `sometimes` — validated only when the field is present.\n- `email` — must be a valid email address.\n- `unique:users,email,NULL,id` — must be unique (users, email, NULL, id).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20|unique:users,phone,NULL,id`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone,NULL,id` — must be unique (users, phone, NULL, id).\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Password123!`\n- **Validation rules:** `sometimes|nullable|string|min:8`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n### `status`\n- **Description:** Status\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `pending`\n- **Validation rules:** `sometimes|in:pending,active,suspended,rejected`\n- `sometimes` — validated only when the field is present.\n- `in:pending,active,suspended,rejected` — must be one of: pending, active, suspended, rejected.\n### `locale`\n- **Description:** Locale\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `en`\n- **Validation rules:** `nullable|in:\"en\",\"ar\"`\n- `nullable` — may be null.\n- `in:\"en\",\"ar\"` — must be one of: \"en\", \"ar\".\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** conditional\n- **Example:** `Example Name`\n- **Validation rules:** `nullable|required_if:user_type,technician|string|max:150`\n- `nullable` — may be null.\n- `required_if:user_type,technician` — required when user_type, technician.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `legal_name`\n- **Description:** Legal Company Name\n- **Type:** `string`\n- **Required:** conditional\n- **Example:** `Example Name`\n- **Validation rules:** `required_if:user_type,company|string|max:200`\n- `required_if:user_type,company` — required when user_type, company.\n- `string` — must be text.\n- `max:200` — must not exceed 200.\n### `tax_number`\n- **Description:** VAT Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `300012345600003`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_registration_no`\n- **Description:** Commercial Registration Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1010101010`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `account_owner_phone`\n- **Description:** Account Owner Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `category_id`\n- **Description:** Service Category\n- **Type:** `integer`\n- **Required:** conditional\n- **Example:** `2`\n- **Validation rules:** `required_if:user_type,technician|integer|exists:categories,id`\n- `required_if:user_type,technician` — required when user_type, technician.\n- `integer` — must be a whole number.\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `daily_order_capacity`\n- **Description:** Daily Order Capacity\n- **Type:** `integer`\n- **Required:** conditional\n- **Example:** `1`\n- **Validation rules:** `required_if:user_type,technician|integer|min:1`\n- `required_if:user_type,technician` — required when user_type, technician.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n### `employment_type`\n- **Description:** Employment Type\n- **Type:** `string`\n- **Required:** conditional\n- **Example:** `in_house`\n- **Validation rules:** `required_if:user_type,technician|string|in:in_house,freelance`\n- `required_if:user_type,technician` — required when user_type, technician.\n- `string` — must be text.\n- `in:in_house,freelance` — must be one of: in_house, freelance.\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:countries,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `governorate_id`\n- **Description:** City\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:governorates,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `region_id`\n- **Description:** District\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:regions,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `years_experience`\n- **Description:** Years experience\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|min:0`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:0` — must be at least .\n### `coverage_areas`\n- **Description:** Coverage Areas (Regions)\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[1]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `coverage_areas.*`\n- **Description:** Coverage areas item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `integer|exists:regions,id`\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"user_type\": \"super_admin\",\n \"name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"password\": \"Password123!\",\n \"status\": \"pending\",\n \"locale\": \"en\",\n \"full_name\": \"Example Name\",\n \"legal_name\": \"Example Name\",\n \"tax_number\": \"300012345600003\",\n \"commercial_registration_no\": \"1010101010\",\n \"account_owner_phone\": \"1234567890\",\n \"category_id\": 2,\n \"daily_order_capacity\": 1,\n \"employment_type\": \"in_house\",\n \"address\": \"123 Main Street, Building A\",\n \"country_id\": 1,\n \"governorate_id\": 1,\n \"region_id\": 1,\n \"years_experience\": 1,\n \"coverage_areas\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete User", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users/:user", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users", ":user" ], "variable": [ { "key": "user", "value": "1", "description": "User ID" } ] }, "description": "**Route:** `admin.users.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Toggle User Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users/:id/toggle-active", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users", ":id", "toggle-active" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.users.toggle`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Activate User", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users/:id/activate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users", ":id", "activate" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.users.activate`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject User", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users", ":id", "reject" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.users.reject`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Does not meet platform requirements.`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Does not meet platform requirements.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Roles", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roles/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roles", "bulk" ] }, "description": "**Route:** `admin.roles.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Roles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roles?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roles" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true } ] }, "description": "**Route:** `admin.roles.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Role", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roles", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roles" ] }, "description": "**Route:** `admin.roles.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `slug`\n- **Description:** Slug\n- **Type:** `string`\n- **Required:** required\n- **Example:** `example-slug`\n- **Validation rules:** `required|string|max:50|unique:roles,slug,NULL,id`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n- `unique:roles,slug,NULL,id` — must be unique (roles, slug, NULL, id).\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `parent_id`\n- **Description:** Parent Role\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:roles,id`\n- `nullable` — may be null.\n- `exists:roles,id` — must reference an existing record (roles, id).\n### `permissions`\n- **Description:** Permissions\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[703]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `permissions.*`\n- **Description:** Permission\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `703`\n- **Validation rules:** `exists:permissions,id`\n- `exists:permissions,id` — must reference an existing record (permissions, id).\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"slug\": \"example-slug\",\n \"is_active\": true,\n \"parent_id\": 1,\n \"permissions\": [\n 703\n ],\n \"en\": {\n \"name\": \"Example Name\"\n },\n \"ar\": {\n \"name\": \"Example Name\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Role Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roles/:role", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roles", ":role" ], "variable": [ { "key": "role", "value": "1", "description": "Role ID" } ] }, "description": "**Route:** `admin.roles.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Role", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roles/:role", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roles", ":role" ], "variable": [ { "key": "role", "value": "1", "description": "Role ID" } ] }, "description": "**Route:** `admin.roles.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `slug`\n- **Description:** Slug\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `example-slug`\n- **Validation rules:** `sometimes|string|max:50|unique:roles,slug,NULL,id`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n- `unique:roles,slug,NULL,id` — must be unique (roles, slug, NULL, id).\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `parent_id`\n- **Description:** Parent Role\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:roles,id`\n- `nullable` — may be null.\n- `exists:roles,id` — must reference an existing record (roles, id).\n### `permissions`\n- **Description:** Permissions\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[703]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `permissions.*`\n- **Description:** Permission\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `703`\n- **Validation rules:** `exists:permissions,id`\n- `exists:permissions,id` — must reference an existing record (permissions, id).\n### `en.name`\n- **Description:** Name (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `ar.name`\n- **Description:** Name (ar)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"slug\": \"example-slug\",\n \"is_active\": true,\n \"parent_id\": 1,\n \"permissions\": [\n 703\n ],\n \"en\": {\n \"name\": \"Example Name\"\n },\n \"ar\": {\n \"name\": \"Example Name\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Role", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/roles/:role", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "roles", ":role" ], "variable": [ { "key": "role", "value": "1", "description": "Role ID" } ] }, "description": "**Route:** `admin.roles.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Permissions", "item": [ { "name": "List All Permissions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/permissions?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "permissions" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.permissions.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Supervisors", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/supervisors/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "supervisors", "bulk" ] }, "description": "**Route:** `admin.supervisors.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Supervisors", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/supervisors?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "supervisors" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.supervisors.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Supervisor", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/supervisors", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "supervisors" ] }, "description": "**Route:** `admin.supervisors.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|max:255|unique:users,email,NULL,id`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `max:255` — must not exceed 255.\n- `unique:users,email,NULL,id` — must be unique (users, email, NULL, id).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20|unique:users,phone,NULL,id`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone,NULL,id` — must be unique (users, phone, NULL, id).\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|nullable|string|min:8`\n- `required` — must be provided.\n- `nullable` — may be null.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `role_id`\n- **Description:** Role\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:roles,id`\n- `required` — must be provided.\n- `exists:roles,id` — must reference an existing record (roles, id).\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"password\": \"Password123!\",\n \"is_active\": true,\n \"role_id\": 1,\n \"image\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Supervisor Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/supervisors/:supervisor", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "supervisors", ":supervisor" ], "variable": [ { "key": "supervisor", "value": "1", "description": "Supervisor ID" } ] }, "description": "**Route:** `admin.supervisors.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Supervisor", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/supervisors/:supervisor", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "supervisors", ":supervisor" ], "variable": [ { "key": "supervisor", "value": "1", "description": "Supervisor ID" } ] }, "description": "**Route:** `admin.supervisors.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `user@example.com`\n- **Validation rules:** `sometimes|email|max:255|unique:users,email,NULL,id`\n- `sometimes` — validated only when the field is present.\n- `email` — must be a valid email address.\n- `max:255` — must not exceed 255.\n- `unique:users,email,NULL,id` — must be unique (users, email, NULL, id).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20|unique:users,phone,NULL,id`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone,NULL,id` — must be unique (users, phone, NULL, id).\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Password123!`\n- **Validation rules:** `sometimes|nullable|string|min:8`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `role_id`\n- **Description:** Role\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|exists:roles,id`\n- `sometimes` — validated only when the field is present.\n- `exists:roles,id` — must reference an existing record (roles, id).\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"password\": \"Password123!\",\n \"is_active\": true,\n \"role_id\": 1,\n \"image\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Supervisor", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/supervisors/:supervisor", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "supervisors", ":supervisor" ], "variable": [ { "key": "supervisor", "value": "1", "description": "Supervisor ID" } ] }, "description": "**Route:** `admin.supervisors.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Technicians", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/technicians/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "technicians", "bulk" ] }, "description": "**Route:** `admin.technicians.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Technicians", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/technicians?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "technicians" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.technicians.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Technician", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/technicians", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "technicians" ] }, "description": "**Route:** `admin.technicians.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `name`\n- **Description:** Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:160`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:160` — must not exceed 160.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|unique:users,email`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `unique:users,email` — must be unique (users, email).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20|unique:users,phone`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone` — must be unique (users, phone).\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n### `status`\n- **Description:** Status\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `pending`\n- **Validation rules:** `sometimes|in:pending,active,suspended,rejected`\n- `sometimes` — validated only when the field is present.\n- `in:pending,active,suspended,rejected` — must be one of: pending, active, suspended, rejected.\n### `locale`\n- **Description:** Locale\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `en`\n- **Validation rules:** `nullable|in:\"en\",\"ar\"`\n- `nullable` — may be null.\n- `in:\"en\",\"ar\"` — must be one of: \"en\", \"ar\".\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:150`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `category_id`\n- **Description:** Service Category\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `2`\n- **Validation rules:** `required|integer|exists:categories,id`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `daily_order_capacity`\n- **Description:** Daily Order Capacity\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|min:1|max:50`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:50` — must not exceed 50.\n### `employment_type`\n- **Description:** Employment Type\n- **Type:** `string`\n- **Required:** required\n- **Example:** `in_house`\n- **Validation rules:** `required|string|in:in_house,freelance`\n- `required` — must be provided.\n- `string` — must be text.\n- `in:in_house,freelance` — must be one of: in_house, freelance.\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:countries,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `governorate_id`\n- **Description:** City\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:governorates,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `region_id`\n- **Description:** District\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:regions,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `id_number`\n- **Description:** ID Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `years_experience`\n- **Description:** Years of Experience\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|min:0|max:50`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:0` — must be at least .\n- `max:50` — must not exceed 50.\n### `coverage_areas`\n- **Description:** Coverage Areas (Regions)\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[1]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `coverage_areas.*`\n- **Description:** Coverage areas item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `integer|exists:regions,id`\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `personal_photo`\n- **Description:** Personal photo\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `national_id_front`\n- **Description:** National id front\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `national_id_back`\n- **Description:** National id back\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `cv_file`\n- **Description:** Cv file\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"password\": \"Password123!\",\n \"status\": \"pending\",\n \"locale\": \"en\",\n \"full_name\": \"Example Name\",\n \"category_id\": 2,\n \"daily_order_capacity\": 1,\n \"employment_type\": \"in_house\",\n \"address\": \"123 Main Street, Building A\",\n \"country_id\": 1,\n \"governorate_id\": 1,\n \"region_id\": 1,\n \"id_number\": \"1234567890\",\n \"years_experience\": 1,\n \"coverage_areas\": [\n 1\n ],\n \"personal_photo\": 1,\n \"national_id_front\": 1,\n \"national_id_back\": 1,\n \"cv_file\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Technician Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/technicians/:technician", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "technicians", ":technician" ], "variable": [ { "key": "technician", "value": "1", "description": "Technician ID" } ] }, "description": "**Route:** `admin.technicians.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Technician", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/technicians/:technician", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "technicians", ":technician" ], "variable": [ { "key": "technician", "value": "1", "description": "Technician ID" } ] }, "description": "**Route:** `admin.technicians.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `name`\n- **Description:** Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:160`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:160` — must not exceed 160.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `user@example.com`\n- **Validation rules:** `sometimes|email|unique:users,email,NULL,id`\n- `sometimes` — validated only when the field is present.\n- `email` — must be a valid email address.\n- `unique:users,email,NULL,id` — must be unique (users, email, NULL, id).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20|unique:users,phone,NULL,id`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone,NULL,id` — must be unique (users, phone, NULL, id).\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Password123!`\n- **Validation rules:** `sometimes|nullable|string|min:8`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n### `status`\n- **Description:** Status\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `pending`\n- **Validation rules:** `sometimes|in:pending,active,suspended,rejected`\n- `sometimes` — validated only when the field is present.\n- `in:pending,active,suspended,rejected` — must be one of: pending, active, suspended, rejected.\n### `locale`\n- **Description:** Locale\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `en`\n- **Validation rules:** `nullable|in:\"en\",\"ar\"`\n- `nullable` — may be null.\n- `in:\"en\",\"ar\"` — must be one of: \"en\", \"ar\".\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:150`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `category_id`\n- **Description:** Service Category\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `2`\n- **Validation rules:** `sometimes|integer|exists:categories,id`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `daily_order_capacity`\n- **Description:** Daily Order Capacity\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:1|max:50`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:50` — must not exceed 50.\n### `employment_type`\n- **Description:** Employment Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `in_house`\n- **Validation rules:** `sometimes|string|in:in_house,freelance`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `in:in_house,freelance` — must be one of: in_house, freelance.\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:countries,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `governorate_id`\n- **Description:** City\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:governorates,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `region_id`\n- **Description:** District\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:regions,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `id_number`\n- **Description:** ID Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `years_experience`\n- **Description:** Years of Experience\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|min:0|max:50`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:0` — must be at least .\n- `max:50` — must not exceed 50.\n### `coverage_areas`\n- **Description:** Coverage Areas (Regions)\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[1]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `coverage_areas.*`\n- **Description:** Coverage areas item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `integer|exists:regions,id`\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `personal_photo`\n- **Description:** Personal photo\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `national_id_front`\n- **Description:** National id front\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `national_id_back`\n- **Description:** National id back\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `cv_file`\n- **Description:** Cv file\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"password\": \"Password123!\",\n \"status\": \"pending\",\n \"locale\": \"en\",\n \"full_name\": \"Example Name\",\n \"category_id\": 2,\n \"daily_order_capacity\": 1,\n \"employment_type\": \"in_house\",\n \"address\": \"123 Main Street, Building A\",\n \"country_id\": 1,\n \"governorate_id\": 1,\n \"region_id\": 1,\n \"id_number\": \"1234567890\",\n \"years_experience\": 1,\n \"coverage_areas\": [\n 1\n ],\n \"personal_photo\": 1,\n \"national_id_front\": 1,\n \"national_id_back\": 1,\n \"cv_file\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Technician", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/technicians/:technician", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "technicians", ":technician" ], "variable": [ { "key": "technician", "value": "1", "description": "Technician ID" } ] }, "description": "**Route:** `admin.technicians.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Toggle Status Technician", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/technicians/:id/toggle-status", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "technicians", ":id", "toggle-status" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.technicians.toggle-status`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Toggle Availability Technician", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/technicians/:id/toggle-availability", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "technicians", ":id", "toggle-availability" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.technicians.toggle-availability`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Activate Technician", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/technicians/:id/activate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "technicians", ":id", "activate" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.technicians.activate`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject Technician", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/technicians/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "technicians", ":id", "reject" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.technicians.reject`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Does not meet platform requirements.`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Does not meet platform requirements.\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Organization", "item": [ { "name": "Companies", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/companies/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "companies", "bulk" ] }, "description": "**Route:** `admin.companies.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Companies", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/companies?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "companies" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.companies.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Company", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/companies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "companies" ] }, "description": "**Route:** `admin.companies.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `legal_name`\n- **Description:** Legal Company Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:200`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:200` — must not exceed 200.\n### `email`\n- **Description:** Official Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|unique:users,email,NULL,id`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `unique:users,email,NULL,id` — must be unique (users, email, NULL, id).\n### `account_owner_phone`\n- **Description:** Account Owner Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|string|max:20|unique:users,phone,NULL,id`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone,NULL,id` — must be unique (users, phone, NULL, id).\n### `account_owner_phone_code`\n- **Description:** Account Owner Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|nullable|string|min:8`\n- `required` — must be provided.\n- `nullable` — may be null.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n### `status`\n- **Description:** Status\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `pending`\n- **Validation rules:** `sometimes|in:\"pending\",\"active\",\"suspended\",\"rejected\"`\n- `sometimes` — validated only when the field is present.\n- `in:\"pending\",\"active\",\"suspended\",\"rejected\"` — must be one of: \"pending\", \"active\", \"suspended\", \"rejected\".\n### `tax_number`\n- **Description:** VAT Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `300012345600003`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_registration_no`\n- **Description:** Commercial Registration Number\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1010101010`\n- **Validation rules:** `required|string|max:50`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_register_expiry_date`\n- **Description:** Commercial Register Expiry Date\n- **Type:** `string`\n- **Required:** required\n- **Example:** `2026-09-24`\n- **Validation rules:** `required|date`\n- `required` — must be provided.\n- `date` — must be a valid date.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"legal_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"account_owner_phone\": \"1234567890\",\n \"account_owner_phone_code\": \"20\",\n \"password\": \"Password123!\",\n \"status\": \"pending\",\n \"tax_number\": \"300012345600003\",\n \"commercial_registration_no\": \"1010101010\",\n \"commercial_register_expiry_date\": \"2026-09-24\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Company Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/companies/:company", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "companies", ":company" ], "variable": [ { "key": "company", "value": "1", "description": "Company ID" } ] }, "description": "**Route:** `admin.companies.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Company", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/companies/:company", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "companies", ":company" ], "variable": [ { "key": "company", "value": "1", "description": "Company ID" } ] }, "description": "**Route:** `admin.companies.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `legal_name`\n- **Description:** Legal Company Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:200`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:200` — must not exceed 200.\n### `email`\n- **Description:** Official Email\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `user@example.com`\n- **Validation rules:** `sometimes|email|unique:users,email,NULL,id`\n- `sometimes` — validated only when the field is present.\n- `email` — must be a valid email address.\n- `unique:users,email,NULL,id` — must be unique (users, email, NULL, id).\n### `account_owner_phone`\n- **Description:** Account Owner Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `sometimes|string|max:20|unique:users,phone,NULL,id`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone,NULL,id` — must be unique (users, phone, NULL, id).\n### `account_owner_phone_code`\n- **Description:** Account Owner Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Password123!`\n- **Validation rules:** `sometimes|nullable|string|min:8`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n### `status`\n- **Description:** Status\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `pending`\n- **Validation rules:** `sometimes|in:\"pending\",\"active\",\"suspended\",\"rejected\"`\n- `sometimes` — validated only when the field is present.\n- `in:\"pending\",\"active\",\"suspended\",\"rejected\"` — must be one of: \"pending\", \"active\", \"suspended\", \"rejected\".\n### `tax_number`\n- **Description:** VAT Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `300012345600003`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_registration_no`\n- **Description:** Commercial Registration Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1010101010`\n- **Validation rules:** `sometimes|string|max:50`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_register_expiry_date`\n- **Description:** Commercial Register Expiry Date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2026-09-24`\n- **Validation rules:** `sometimes|date`\n- `sometimes` — validated only when the field is present.\n- `date` — must be a valid date.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"legal_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"account_owner_phone\": \"1234567890\",\n \"account_owner_phone_code\": \"20\",\n \"password\": \"Password123!\",\n \"status\": \"pending\",\n \"tax_number\": \"300012345600003\",\n \"commercial_registration_no\": \"1010101010\",\n \"commercial_register_expiry_date\": \"2026-09-24\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Company", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/companies/:company", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "companies", ":company" ], "variable": [ { "key": "company", "value": "1", "description": "Company ID" } ] }, "description": "**Route:** `admin.companies.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Toggle Company Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/companies/:id/toggle-active", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "companies", ":id", "toggle-active" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.companies.toggle`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Activate Company", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/companies/:id/activate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "companies", ":id", "activate" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.companies.activate`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject Company", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/companies/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "companies", ":id", "reject" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.companies.reject`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Does not meet platform requirements.`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Does not meet platform requirements.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approve Commercial register", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/companies/:id/commercial-register/approve", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "companies", ":id", "commercial-register", "approve" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.companies.commercial-register.approve`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject Commercial register", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/companies/:id/commercial-register/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "companies", ":id", "commercial-register", "reject" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.companies.commercial-register.reject`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Does not meet platform requirements.`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Does not meet platform requirements.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Branches", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/branches/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "branches", "bulk" ] }, "description": "**Route:** `admin.branches.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Branches", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/branches?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "branches" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.branches.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Branch", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/branches", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "branches" ] }, "description": "**Route:** `admin.branches.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `company_id`\n- **Description:** Company\n- **Type:** `file`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|exists:company_profiles,user_id`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `exists:company_profiles,user_id` — must reference an existing record (company_profiles, user_id).\n### `name`\n- **Description:** Branch Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:150`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `phone`\n- **Description:** Branch Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|string|max:20`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `address_text`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `latitude`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|between:-90,90`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `longitude`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|between:-180,180`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `working_hours`\n- **Description:** Working Hours\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[{\"day\":\"sunday\",\"from\":\"09:00\",\"to\":\"09:00\"}]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `working_hours.*.day`\n- **Description:** Day\n- **Type:** `string`\n- **Required:** required\n- **Example:** `sunday`\n- **Validation rules:** `required|distinct|in:\"sunday\",\"monday\",\"tuesday\",\"wednesday\",\"thursday\",\"friday\",\"saturday\"`\n- `required` — must be provided.\n- `distinct` — custom validation rule.\n- `in:\"sunday\",\"monday\",\"tuesday\",\"wednesday\",\"thursday\",\"friday\",\"saturday\"` — must be one of: \"sunday\", \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\".\n### `working_hours.*.from`\n- **Description:** From\n- **Type:** `string`\n- **Required:** required\n- **Example:** `09:00`\n- **Validation rules:** `required|date_format:H:i`\n- `required` — must be provided.\n- `date_format:H:i` — custom validation rule.\n### `working_hours.*.to`\n- **Description:** To\n- **Type:** `string`\n- **Required:** required\n- **Example:** `09:00`\n- **Validation rules:** `required|date_format:H:i`\n- `required` — must be provided.\n- `date_format:H:i` — custom validation rule.\n### `allowed_slots`\n- **Description:** Allowed Slots\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"morning\"]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `allowed_slots.*`\n- **Description:** Allowed slots item\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `morning`\n- **Validation rules:** `string|in:morning,afternoon,evening`\n- `string` — must be text.\n- `in:morning,afternoon,evening` — must be one of: morning, afternoon, evening.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": 1,\n \"name\": \"Example Name\",\n \"phone\": \"1234567890\",\n \"address_text\": \"123 Main Street, Building A\",\n \"latitude\": 10,\n \"longitude\": 10,\n \"working_hours\": [\n {\n \"day\": \"sunday\",\n \"from\": \"09:00\",\n \"to\": \"09:00\"\n }\n ],\n \"allowed_slots\": [\n \"morning\"\n ],\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Branch Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/branches/:branch", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "branches", ":branch" ], "variable": [ { "key": "branch", "value": "1", "description": "Branch ID" } ] }, "description": "**Route:** `admin.branches.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Branch", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/branches/:branch", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "branches", ":branch" ], "variable": [ { "key": "branch", "value": "1", "description": "Branch ID" } ] }, "description": "**Route:** `admin.branches.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `company_id`\n- **Description:** Company\n- **Type:** `file`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|exists:company_profiles,user_id`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `exists:company_profiles,user_id` — must reference an existing record (company_profiles, user_id).\n### `name`\n- **Description:** Branch Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:150`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `phone`\n- **Description:** Branch Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `sometimes|string|max:20`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `address_text`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `sometimes|string|max:500`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `latitude`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|between:-90,90`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `longitude`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|between:-180,180`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `working_hours`\n- **Description:** Working Hours\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[{\"day\":\"sunday\",\"from\":\"09:00\",\"to\":\"09:00\"}]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `working_hours.*.day`\n- **Description:** Day\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `sunday`\n- **Validation rules:** `sometimes|distinct|in:\"sunday\",\"monday\",\"tuesday\",\"wednesday\",\"thursday\",\"friday\",\"saturday\"`\n- `sometimes` — validated only when the field is present.\n- `distinct` — custom validation rule.\n- `in:\"sunday\",\"monday\",\"tuesday\",\"wednesday\",\"thursday\",\"friday\",\"saturday\"` — must be one of: \"sunday\", \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\".\n### `working_hours.*.from`\n- **Description:** From\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `09:00`\n- **Validation rules:** `sometimes|date_format:H:i`\n- `sometimes` — validated only when the field is present.\n- `date_format:H:i` — custom validation rule.\n### `working_hours.*.to`\n- **Description:** To\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `09:00`\n- **Validation rules:** `sometimes|date_format:H:i`\n- `sometimes` — validated only when the field is present.\n- `date_format:H:i` — custom validation rule.\n### `allowed_slots`\n- **Description:** Allowed Slots\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"morning\"]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `allowed_slots.*`\n- **Description:** Allowed slots item\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `morning`\n- **Validation rules:** `string|in:morning,afternoon,evening`\n- `string` — must be text.\n- `in:morning,afternoon,evening` — must be one of: morning, afternoon, evening.\n### `is_active`\n- **Description:** Is Active\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": 1,\n \"name\": \"Example Name\",\n \"phone\": \"1234567890\",\n \"address_text\": \"123 Main Street, Building A\",\n \"latitude\": 10,\n \"longitude\": 10,\n \"working_hours\": [\n {\n \"day\": \"sunday\",\n \"from\": \"09:00\",\n \"to\": \"09:00\"\n }\n ],\n \"allowed_slots\": [\n \"morning\"\n ],\n \"is_active\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Branch", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/branches/:branch", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "branches", ":branch" ], "variable": [ { "key": "branch", "value": "1", "description": "Branch ID" } ] }, "description": "**Route:** `admin.branches.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Toggle Active Branch", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/branches/:id/toggle-active", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "branches", ":id", "toggle-active" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.branches.toggle-active`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Contacts Branch", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/branches/:id/contacts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "branches", ":id", "contacts" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.branches.contacts`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `contacts`\n- **Description:** Contacts\n- **Type:** `array`\n- **Required:** required\n- **Example:** `[{\"name\":\"Example Name\",\"phone\":\"1234567890\",\"email\":\"user@example.com\",\"is_primary\":true}]`\n- **Validation rules:** `required|array`\n- `required` — must be provided.\n- `array` — must be an array.\n### `contacts.*.name`\n- **Description:** Contact Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:150`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `contacts.*.phone`\n- **Description:** Contact Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|string|max:20`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `contacts.*.email`\n- **Description:** Contact Email\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `user@example.com`\n- **Validation rules:** `nullable|email`\n- `nullable` — may be null.\n- `email` — must be a valid email address.\n### `contacts.*.is_primary`\n- **Description:** Is Primary\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"contacts\": [\n {\n \"name\": \"Example Name\",\n \"phone\": \"1234567890\",\n \"email\": \"user@example.com\",\n \"is_primary\": true\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Contracts", "item": [ { "name": "Contracts", "item": [ { "name": "Delete Bulk", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contracts/bulk", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contracts", "bulk" ] }, "description": "**Route:** `admin.contracts.bulk.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "List All Contracts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contracts?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contracts" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.contracts.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Contract", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contracts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contracts" ] }, "description": "**Route:** `admin.contracts.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `company_id`\n- **Description:** Company id\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:users,id`\n- `required` — must be provided.\n- `exists:users,id` — must reference an existing record (users, id).\n### `service_ids`\n- **Description:** Service ids\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[2]`\n- **Validation rules:** `sometimes|array|min:1`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `min:1` — must be at least 1.\n### `service_ids.*`\n- **Description:** Service ids item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `2`\n- **Validation rules:** `exists:categories,id`\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `branch_ids`\n- **Description:** Branch ids\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[1]`\n- **Validation rules:** `sometimes|array|min:1`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `min:1` — must be at least 1.\n### `branch_ids.*`\n- **Description:** Branch ids item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `exists:branches,id`\n- `exists:branches,id` — must reference an existing record (branches, id).\n### `start_date`\n- **Description:** Start date\n- **Type:** `string`\n- **Required:** required\n- **Example:** `2026-09-26`\n- **Validation rules:** `required|date|after_or_equal:today`\n- `required` — must be provided.\n- `date` — must be a valid date.\n- `after_or_equal:today` — custom validation rule.\n### `end_date`\n- **Description:** End date\n- **Type:** `string`\n- **Required:** required\n- **Example:** `2026-09-26`\n- **Validation rules:** `required|date|after:start_date`\n- `required` — must be provided.\n- `date` — must be a valid date.\n- `after:start_date` — custom validation rule.\n### `billing_cycle`\n- **Description:** Billing cycle\n- **Type:** `string`\n- **Required:** required\n- **Example:** `monthly`\n- **Validation rules:** `required|in:monthly,quarterly,annual`\n- `required` — must be provided.\n- `in:monthly,quarterly,annual` — must be one of: monthly, quarterly, annual.\n### `visits_allowed`\n- **Description:** Visits allowed\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|min:1`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n### `total_amount`\n- **Description:** Total amount\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|min:0`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `min:0` — must be at least .\n### `currency`\n- **Description:** Currency\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `EGP`\n- **Validation rules:** `sometimes|string|size:3`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `size:3` — custom validation rule.\n### `notes`\n- **Description:** Notes\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:1000`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:1000` — must not exceed 1000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": 1,\n \"service_ids\": [\n 2\n ],\n \"branch_ids\": [\n 1\n ],\n \"start_date\": \"2026-09-26\",\n \"end_date\": \"2026-09-26\",\n \"billing_cycle\": \"monthly\",\n \"visits_allowed\": 1,\n \"total_amount\": 10,\n \"currency\": \"EGP\",\n \"notes\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Contract Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contracts/:contract", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contracts", ":contract" ], "variable": [ { "key": "contract", "value": "1", "description": "Contract ID" } ] }, "description": "**Route:** `admin.contracts.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Update Contract", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contracts/:contract", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contracts", ":contract" ], "variable": [ { "key": "contract", "value": "1", "description": "Contract ID" } ] }, "description": "**Route:** `admin.contracts.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `company_id`\n- **Description:** Company id\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|exists:users,id`\n- `sometimes` — validated only when the field is present.\n- `exists:users,id` — must reference an existing record (users, id).\n### `service_ids`\n- **Description:** Service ids\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[2]`\n- **Validation rules:** `sometimes|array|min:1`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `min:1` — must be at least 1.\n### `service_ids.*`\n- **Description:** Service ids item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `2`\n- **Validation rules:** `exists:categories,id`\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `branch_ids`\n- **Description:** Branch ids\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[1]`\n- **Validation rules:** `sometimes|array|min:1`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `min:1` — must be at least 1.\n### `branch_ids.*`\n- **Description:** Branch ids item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `exists:branches,id`\n- `exists:branches,id` — must reference an existing record (branches, id).\n### `start_date`\n- **Description:** Start date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2026-09-26`\n- **Validation rules:** `sometimes|date|after_or_equal:today`\n- `sometimes` — validated only when the field is present.\n- `date` — must be a valid date.\n- `after_or_equal:today` — custom validation rule.\n### `end_date`\n- **Description:** End date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2026-09-26`\n- **Validation rules:** `sometimes|date|after:start_date`\n- `sometimes` — validated only when the field is present.\n- `date` — must be a valid date.\n- `after:start_date` — custom validation rule.\n### `billing_cycle`\n- **Description:** Billing cycle\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `monthly`\n- **Validation rules:** `sometimes|in:monthly,quarterly,annual`\n- `sometimes` — validated only when the field is present.\n- `in:monthly,quarterly,annual` — must be one of: monthly, quarterly, annual.\n### `visits_allowed`\n- **Description:** Visits allowed\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:1`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n### `total_amount`\n- **Description:** Total amount\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|min:0`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `min:0` — must be at least .\n### `currency`\n- **Description:** Currency\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `EGP`\n- **Validation rules:** `sometimes|string|size:3`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `size:3` — custom validation rule.\n### `notes`\n- **Description:** Notes\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:1000`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:1000` — must not exceed 1000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"company_id\": 1,\n \"service_ids\": [\n 2\n ],\n \"branch_ids\": [\n 1\n ],\n \"start_date\": \"2026-09-26\",\n \"end_date\": \"2026-09-26\",\n \"billing_cycle\": \"monthly\",\n \"visits_allowed\": 1,\n \"total_amount\": 10,\n \"currency\": \"EGP\",\n \"notes\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Contract", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contracts/:contract", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contracts", ":contract" ], "variable": [ { "key": "contract", "value": "1", "description": "Contract ID" } ] }, "description": "**Route:** `admin.contracts.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Approve Contract", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contracts/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contracts", ":id", "approve" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.contracts.approve`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject Contract", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contracts/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contracts", ":id", "reject" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.contracts.reject`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Does not meet platform requirements.`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Does not meet platform requirements.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Terminate Contract", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contracts/:id/terminate", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contracts", ":id", "terminate" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.contracts.terminate`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Manual adjustment by admin.`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Manual adjustment by admin.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Signed Document Contract", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contracts/:id/signed-document", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contracts", ":id", "signed-document" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.contracts.signed-document`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `signed_document`\n- **Description:** Signed document\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|string|custom:MediaExists`\n- `required` — must be provided.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"signed_document\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Renewal Contract", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contracts/:id/renewal/:action", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "contracts", ":id", "renewal", ":action" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" }, { "key": "action", "value": "1", "description": "Action ID" } ] }, "description": "**Route:** `admin.contracts.renewal`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Invoices", "item": [ { "name": "List All Invoices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/invoices?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "invoices" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.invoices.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Show Invoice Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/invoices/:invoice", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "invoices", ":invoice" ], "variable": [ { "key": "invoice", "value": "1", "description": "Invoice ID" } ] }, "description": "**Route:** `admin.invoices.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Cancel Invoice", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/invoices/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "invoices", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.invoices.cancel`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approve Receipt", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/invoices/:id/receipts/:receiptId/approve", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "invoices", ":id", "receipts", ":receiptId", "approve" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" }, { "key": "receiptId", "value": "1", "description": "ReceiptId ID" } ] }, "description": "**Route:** `admin.invoices.receipts.approve`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject Receipt", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/invoices/:id/receipts/:receiptId/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "invoices", ":id", "receipts", ":receiptId", "reject" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" }, { "key": "receiptId", "value": "1", "description": "ReceiptId ID" } ] }, "description": "**Route:** `admin.invoices.receipts.reject`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Does not meet platform requirements.`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Does not meet platform requirements.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Orders", "item": [ { "name": "List All Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/orders?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "orders" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.orders.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Show Order Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/orders/:order", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "orders", ":order" ], "variable": [ { "key": "order", "value": "1", "description": "Order ID" } ] }, "description": "**Route:** `admin.orders.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Quote Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/orders/:id/quote", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "orders", ":id", "quote" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.orders.quote`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `items`\n- **Description:** Items\n- **Type:** `array`\n- **Required:** required\n- **Example:** `[{\"id\":1,\"unit_price\":10}]`\n- **Validation rules:** `required|array|min:1`\n- `required` — must be provided.\n- `array` — must be an array.\n- `min:1` — must be at least 1.\n### `items.*.id`\n- **Description:** Order Item\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|exists:order_items,id`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `exists:order_items,id` — must reference an existing record (order_items, id).\n### `items.*.unit_price`\n- **Description:** Unit Price\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|min:0`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `min:0` — must be at least .\n### `vat_amount`\n- **Description:** VAT Amount\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|min:0`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `min:0` — must be at least .\n### `fees_amount`\n- **Description:** Fees Amount\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|min:0`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `min:0` — must be at least .\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"id\": 1,\n \"unit_price\": 10\n }\n ],\n \"vat_amount\": 10,\n \"fees_amount\": 10\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Assign Technician Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/orders/:id/assign-technician", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "orders", ":id", "assign-technician" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.orders.assign-technician`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `technician_id`\n- **Description:** Technician\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `bail|required|integer|exists:technicians,id|custom:Closure`\n- `bail` — custom validation rule.\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `exists:technicians,id` — must reference an existing record (technicians, id).\n- `custom:Closure` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"technician_id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Status Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/orders/:id/status", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "orders", ":id", "status" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.orders.status`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `status`\n- **Description:** Status\n- **Type:** `string`\n- **Required:** required\n- **Example:** `pending`\n- **Validation rules:** `required|string|in:\"pending\",\"waiting_price\",\"priced\",\"accepted\",\"on_the_way\",\"start\",\"finish\",\"confirmed\",\"cancelled\"`\n- `required` — must be provided.\n- `string` — must be text.\n- `in:\"pending\",\"waiting_price\",\"priced\",\"accepted\",\"on_the_way\",\"start\",\"finish\",\"confirmed\",\"cancelled\"` — must be one of: \"pending\", \"waiting_price\", \"priced\", \"accepted\", \"on_the_way\", \"start\", \"finish\", \"confirmed\", \"cancelled\".\n### `notes`\n- **Description:** Notes\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"status\": \"pending\",\n \"notes\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/orders/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "orders", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.orders.cancel`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `reason`\n- **Description:** Cancellation Reason\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Manual adjustment by admin.`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Manual adjustment by admin.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reschedule Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/orders/:id/reschedule", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "orders", ":id", "reschedule" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.orders.reschedule`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `scheduled_date`\n- **Description:** Scheduled Date\n- **Type:** `string`\n- **Required:** required\n- **Example:** `2026-09-26`\n- **Validation rules:** `required|date|after_or_equal:today`\n- `required` — must be provided.\n- `date` — must be a valid date.\n- `after_or_equal:today` — custom validation rule.\n### `reason`\n- **Description:** Reschedule Reason\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Manual adjustment by admin.`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"scheduled_date\": \"2026-09-26\",\n \"reason\": \"Manual adjustment by admin.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Visits", "item": [ { "name": "Visits Order", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/visits", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "visits" ] }, "description": "**Route:** `admin.orders.visits`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] } ] }, { "name": "General", "item": [ { "name": "Ratings", "item": [ { "name": "List All Ratings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/ratings?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "ratings" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.ratings.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Show Rating Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/ratings/:rating", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "ratings", ":rating" ], "variable": [ { "key": "rating", "value": "1", "description": "Rating ID" } ] }, "description": "**Route:** `admin.ratings.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Wallets", "item": [ { "name": "List All Wallets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/wallets?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "wallets" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.wallets.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Show Wallet Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/wallets/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "wallets", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.wallets.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Transactions Wallet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/wallets/:id/transactions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "wallets", ":id", "transactions" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.wallets.transactions`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Credit Wallet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/wallets/:id/credit", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "wallets", ":id", "credit" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.wallets.credit`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `amount`\n- **Description:** Amount\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|min:0.01|max:999999.99`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `min:0.01` — must be at least 0.01.\n- `max:999999.99` — must not exceed 999999.99.\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Manual adjustment by admin.`\n- **Validation rules:** `sometimes|nullable|string|max:500`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 10,\n \"reason\": \"Manual adjustment by admin.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Zero Out Wallet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/wallets/:id/zero-out", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "wallets", ":id", "zero-out" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.wallets.zero-out`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Manual adjustment by admin.`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Manual adjustment by admin.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Block Refund Wallet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/wallets/:id/block-refund", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "wallets", ":id", "block-refund" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.wallets.block-refund`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `order_id`\n- **Description:** Order\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|exists:orders,id`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `exists:orders,id` — must reference an existing record (orders, id).\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Manual adjustment by admin.`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"order_id\": 1,\n \"reason\": \"Manual adjustment by admin.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Lock Wallet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/wallets/:id/lock", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "wallets", ":id", "lock" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.wallets.lock`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Unlock Wallet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/wallets/:id/unlock", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "wallets", ":id", "unlock" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.wallets.unlock`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Conversations", "item": [ { "name": "List All Conversations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/conversations?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "conversations" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.conversations.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Show Conversation Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/conversations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "conversations", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.conversations.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Reply Conversation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/conversations/:id/reply", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "conversations", ":id", "reply" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.conversations.reply`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `body`\n- **Description:** Reply\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example message body text.`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Example message body text.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Close Conversation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/conversations/:id/close", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "conversations", ":id", "close" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.conversations.close`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Conversation", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/conversations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "conversations", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.conversations.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "{entityType}", "item": [ { "name": "List All Internal notes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/:entityType/:entityId/notes?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", ":entityType", ":entityId", "notes" ], "variable": [ { "key": "entityType", "value": "1", "description": "EntityType ID" }, { "key": "entityId", "value": "1", "description": "EntityId ID" } ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.internal-notes.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Create New Internal note", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/:entityType/:entityId/notes", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", ":entityType", ":entityId", "notes" ], "variable": [ { "key": "entityType", "value": "1", "description": "EntityType ID" }, { "key": "entityId", "value": "1", "description": "EntityId ID" } ] }, "description": "**Route:** `admin.internal-notes.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `note`\n- **Description:** Note\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"note\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Internal note", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/:entityType/:entityId/notes/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", ":entityType", ":entityId", "notes", ":id" ], "variable": [ { "key": "entityType", "value": "1", "description": "EntityType ID" }, { "key": "entityId", "value": "1", "description": "EntityId ID" }, { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.internal-notes.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] }, { "name": "Reports", "item": [ { "name": "Operational Report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/reports/operational?date_from=2026-08-01&date_to=2026-08-31&date_basis=created&timezone=Africa/Cairo&statuses[]=pending&order_sources[]=individual&booking_types[]=scheduled&customer_id=1&technician_id=1&branch_id=1&contract_id=1&needs_attention=true&risk_limit=20", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "reports", "operational" ], "query": [ { "key": "date_from", "value": "2026-08-01", "description": "Inclusive report date (maximum range: 366 days)", "disabled": false }, { "key": "date_to", "value": "2026-08-31", "description": "Inclusive report date", "disabled": false }, { "key": "date_basis", "value": "created", "description": "created or scheduled", "disabled": false }, { "key": "timezone", "value": "Africa/Cairo", "description": "IANA timezone used for date boundaries", "disabled": false }, { "key": "statuses[]", "value": "pending", "description": "Optional current order status", "disabled": true }, { "key": "order_sources[]", "value": "individual", "description": "Optional: individual or job_order", "disabled": true }, { "key": "booking_types[]", "value": "scheduled", "description": "Optional: instant or scheduled", "disabled": true }, { "key": "customer_id", "value": "1", "description": "Optional customer ID", "disabled": true }, { "key": "technician_id", "value": "1", "description": "Optional technician ID", "disabled": true }, { "key": "branch_id", "value": "1", "description": "Optional branch ID", "disabled": true }, { "key": "contract_id", "value": "1", "description": "Optional contract ID", "disabled": true }, { "key": "needs_attention", "value": "true", "description": "Optional boolean filter", "disabled": true }, { "key": "risk_limit", "value": "20", "description": "Rows returned per risk queue (1–50)", "disabled": true } ] }, "description": "**Route:** `admin.reports.operational`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `date_from` — Inclusive report date (maximum range: 366 days) (supported)\n- `date_to` — Inclusive report date (supported)\n- `date_basis` — created or scheduled (supported)\n- `timezone` — IANA timezone used for date boundaries (supported)\n- `statuses[]` — Optional current order status (optional)\n- `order_sources[]` — Optional: individual or job_order (optional)\n- `booking_types[]` — Optional: instant or scheduled (optional)\n- `customer_id` — Optional customer ID (optional)\n- `technician_id` — Optional technician ID (optional)\n- `branch_id` — Optional branch ID (optional)\n- `contract_id` — Optional contract ID (optional)\n- `needs_attention` — Optional boolean filter (optional)\n- `risk_limit` — Rows returned per risk queue (1–50) (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Wallet", "item": [ { "name": "Withdraw requests", "item": [ { "name": "List All Withdraw requests", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/withdraw-requests?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "withdraw-requests" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `admin.withdraw-requests.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] } } }, { "name": "Approve Withdraw request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/withdraw-requests/:id/approve", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "withdraw-requests", ":id", "approve" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.withdraw-requests.approve`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject Withdraw request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/withdraw-requests/:id/reject", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "withdraw-requests", ":id", "reject" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.withdraw-requests.reject`\n**Middleware:** `api, set_locale, cors, auth:api, user:admin,super_admin, active, rbac.auto`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Does not meet platform requirements.`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{admin_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Does not meet platform requirements.\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] } ] }, { "name": "Client", "item": [ { "name": "Media", "item": [ { "name": "Upload", "item": [ { "name": "Upload Client", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/upload", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "upload" ] }, "description": "**Route:** `client.upload`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `multipart/form-data`. Select a local file for fields marked as `file`.\n\n**Field documentation:**\n### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|file|max:10240`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240.\n### `type`\n- **Description:** File Type\n- **Type:** `file`\n- **Required:** optional\n- **Example:** `image`\n- **Validation rules:** `nullable|string|in:image,document,video,audio`\n- `nullable` — may be null.\n- `string` — must be text.\n- `in:image,document,video,audio` — must be one of: image, document, video, audio.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "", "description": "### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `null`\n- **Validation rules:** `required|file|max:10240`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240." }, { "key": "type", "type": "text", "src": "image", "description": "### `type`\n- **Description:** Type\n- **Type:** `file`\n- **Required:** optional\n- **Example:** `null`\n- **Validation rules:** `nullable|string|in:image,document,video,audio`\n- `nullable` — may be null.\n- `string` — must be text.\n- `in:image,document,video,audio` — must be one of: image, document, video, audio." } ] } } } ] }, { "name": "List All Media", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "media" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.media.index`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Create New Medium", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media", "host": [ "{{base_url}}" ], "path": [ "media" ] }, "description": "**Route:** `shared.media.store`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nSend as `multipart/form-data`. Select a local file for fields marked as `file`.\n\n**Field documentation:**\n### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|file|max:10240|mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240.\n- `mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav` — custom validation rule.\n### `collection`\n- **Description:** Collection\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "", "description": "### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `null`\n- **Validation rules:** `required|file|max:10240|mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240.\n- `mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav` — custom validation rule." }, { "key": "collection", "type": "text", "src": "value", "description": "### `collection`\n- **Description:** Collection\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `null`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255." } ] } } }, { "name": "Delete Medium", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media/:media_id", "host": [ "{{base_url}}" ], "path": [ "media", ":media_id" ], "variable": [ { "key": "media_id", "value": "1", "description": "Media_id ID" } ] }, "description": "**Route:** `shared.media.destroy`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } } ] }, { "name": "Account", "item": [ { "name": "Auth", "item": [ { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/login", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "login" ] }, "description": "**Route:** `client.auth.login`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `individual@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `password`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string`\n- `nullable` — may be null.\n- `string` — must be text.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"individual@info.com\",\n \"password\": \"password\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "var response = pm.response.json();", "var token = response.data ? (response.data.token || response.data.access_token) : (response.token || response.access_token);", "if (token) {", " pm.collectionVariables.set(\"client_token\", token);", "}" ] } } ] }, { "name": "Register New Account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/register", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "register" ] }, "description": "**Route:** `client.auth.register`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:150`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|unique:users,email`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `unique:users,email` — must be unique (users, email).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20|unique:users,phone`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone` — must be unique (users, phone).\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string`\n- `nullable` — may be null.\n- `string` — must be text.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"password\": \"Password123!\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Account (OTP)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/verify", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "verify" ] }, "description": "**Route:** `client.auth.verify`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `individual@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"individual@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resend Verification Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "resend-code" ] }, "description": "**Route:** `client.auth.resend`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `verification_token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"verification_token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Request Password Reset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/forgot-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "forgot-password" ] }, "description": "**Route:** `client.auth.forgot`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `individual@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"individual@info.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Reset Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/verify-reset-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "verify-reset-code" ] }, "description": "**Route:** `client.auth.verify-reset-code`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `individual@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"individual@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reset Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "reset-password" ] }, "description": "**Route:** `client.auth.reset`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `individual@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `password_confirmation`\n- **Description:** Password confirmation\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"individual@info.com\",\n \"token\": \"\",\n \"password\": \"Password123!\",\n \"password_confirmation\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Logout", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/logout", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "logout" ] }, "description": "**Route:** `client.auth.logout`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `device_id`\n- **Description:** Device ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"device_id\": \"device-uuid-123\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Refresh Access Token", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/refresh", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "refresh" ] }, "description": "**Route:** `client.auth.refresh`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Profile", "item": [ { "name": "Show Profile Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "profile" ] }, "description": "**Route:** `client.profile.view`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Update Profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "profile" ] }, "description": "**Route:** `client.profile.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:100`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `sometimes|string|max:20|unique:users,phone,\"1\",id`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone,\"1\",id` — must be unique (users, phone, \"1\", id).\n### `locale`\n- **Description:** Locale\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `en`\n- **Validation rules:** `nullable|in:\"en\",\"ar\"`\n- `nullable` — may be null.\n- `in:\"en\",\"ar\"` — must be one of: \"en\", \"ar\".\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `current_password`\n- **Description:** Current Password\n- **Type:** `string`\n- **Required:** conditional\n- **Example:** `Password123!`\n- **Validation rules:** `required_with:password|string`\n- `required_with:password` — required when password is present.\n- `string` — must be text.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** conditional\n- **Example:** `Password123!`\n- **Validation rules:** `sometimes|required_with:current_password|string|min:8|confirmed`\n- `sometimes` — validated only when the field is present.\n- `required_with:current_password` — required when current_password is present.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `password_confirmation`\n- **Description:** Password confirmation\n- **Type:** `string`\n- **Required:** conditional\n- **Example:** `Password123!`\n- **Validation rules:** `required_with:password|string`\n- `required_with:password` — required when password is present.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Example Name\",\n \"phone\": \"1234567890\",\n \"locale\": \"en\",\n \"image\": \"value\",\n \"current_password\": \"Password123!\",\n \"password\": \"Password123!\",\n \"password_confirmation\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Profile", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "profile" ] }, "description": "**Route:** `client.profile.delete`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Change Password Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/profile/change-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "profile", "change-password" ] }, "description": "**Route:** `client.profile.change-password`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `current_password`\n- **Description:** Current Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"current_password\": \"Password123!\",\n \"password\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Email Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/profile/change-email", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "profile", "change-email" ] }, "description": "**Route:** `client.profile.change-email`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `new_email`\n- **Description:** New Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|unique:users,email,\"1\",id`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `unique:users,email,\"1\",id` — must be unique (users, email, \"1\", id).\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"new_email\": \"user@example.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Email Change Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/profile/verify-email-change", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "profile", "verify-email-change" ] }, "description": "**Route:** `client.profile.verify-email-change`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"\",\n \"code\": \"123456\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Addresses", "item": [ { "name": "List All Addresses", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/addresses?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "addresses" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `client.addresses.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Create New Address", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/addresses", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "addresses" ] }, "description": "**Route:** `client.addresses.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `title`\n- **Description:** Title\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Title`\n- **Validation rules:** `required|string|max:100`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:countries,id`\n- `required` — must be provided.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `governorate_id`\n- **Description:** Governorate\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:governorates,id`\n- `nullable` — may be null.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `region_id`\n- **Description:** Region\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:regions,id`\n- `nullable` — may be null.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `lat`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|between:-90,90`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `lng`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|between:-180,180`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `phone_code`\n- **Description:** Phone code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `notes`\n- **Description:** Notes\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `is_default`\n- **Description:** Default\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Example Title\",\n \"address\": \"123 Main Street, Building A\",\n \"country_id\": 1,\n \"governorate_id\": 1,\n \"region_id\": 1,\n \"lat\": 10,\n \"lng\": 10,\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"notes\": \"value\",\n \"is_default\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Address Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/addresses/:address", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "addresses", ":address" ], "variable": [ { "key": "address", "value": "1", "description": "Address ID" } ] }, "description": "**Route:** `client.addresses.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Update Address", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/addresses/:address", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "addresses", ":address" ], "variable": [ { "key": "address", "value": "1", "description": "Address ID" } ] }, "description": "**Route:** `client.addresses.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `title`\n- **Description:** Title\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Title`\n- **Validation rules:** `sometimes|string|max:100`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `sometimes|string|max:500`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|exists:countries,id`\n- `sometimes` — validated only when the field is present.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `governorate_id`\n- **Description:** Governorate\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:governorates,id`\n- `nullable` — may be null.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `region_id`\n- **Description:** Region\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|exists:regions,id`\n- `nullable` — may be null.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `lat`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|between:-90,90`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `lng`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|between:-180,180`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `phone_code`\n- **Description:** Phone code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `notes`\n- **Description:** Notes\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `is_default`\n- **Description:** Default\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"title\": \"Example Title\",\n \"address\": \"123 Main Street, Building A\",\n \"country_id\": 1,\n \"governorate_id\": 1,\n \"region_id\": 1,\n \"lat\": 10,\n \"lng\": 10,\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"notes\": \"value\",\n \"is_default\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Address", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/addresses/:address", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "addresses", ":address" ], "variable": [ { "key": "address", "value": "1", "description": "Address ID" } ] }, "description": "**Route:** `client.addresses.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Default Address", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/addresses/:address/default", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "addresses", ":address", "default" ], "variable": [ { "key": "address", "value": "1", "description": "Address ID" } ] }, "description": "**Route:** `client.addresses.default`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Content", "item": [ { "name": "Faqs", "item": [ { "name": "List All Faqs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/faqs?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "faqs" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `client.faqs.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } } ] }, { "name": "Pages", "item": [ { "name": "Page Content", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/pages/:type", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "pages", ":type" ], "variable": [ { "key": "type", "value": "1", "description": "Type ID" } ] }, "description": "**Route:** `client.content.page`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Sliders", "item": [ { "name": "Sliders Content", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/sliders?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "sliders" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true } ] }, "description": "**Route:** `client.content.sliders`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Categories", "item": [ { "name": "Categories Category", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/categories", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "categories" ] }, "description": "**Route:** `client.categories.categories`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "List Category Services", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/categories/:id/services", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "categories", ":id", "services" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `client.categories.services`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Geo", "item": [ { "name": "Countries", "item": [ { "name": "Countries Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/countries?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[continent]=asia", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "countries" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true }, { "key": "filters[continent]", "value": "asia", "description": "Filter by continent", "disabled": true } ] }, "description": "**Route:** `client.geo.countries`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n- `filters[continent]` — Filter by continent (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } }, { "name": "Countries Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/countries?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[continent]=asia", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "countries" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true }, { "key": "filters[continent]", "value": "asia", "description": "Filter by continent", "disabled": true } ] }, "description": "**Route:** `client.geo.countries`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n- `filters[continent]` — Filter by continent (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Governorates", "item": [ { "name": "Governorates Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/governorates?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[country_id]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "governorates" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[country_id]", "value": "1", "description": "Filter by country ID", "disabled": true } ] }, "description": "**Route:** `client.geo.governorates`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n- `filters[country_id]` — Filter by country ID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } }, { "name": "Governorates Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/governorates?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[country_id]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "governorates" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[country_id]", "value": "1", "description": "Filter by country ID", "disabled": true } ] }, "description": "**Route:** `client.geo.governorates`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n- `filters[country_id]` — Filter by country ID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Regions", "item": [ { "name": "Regions Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/regions?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[governorate_id]=1&filters[shipping_zone_id]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "regions" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[governorate_id]", "value": "1", "description": "Filter by governorate ID", "disabled": true }, { "key": "filters[shipping_zone_id]", "value": "1", "description": "Filter by shipping zone ID", "disabled": true } ] }, "description": "**Route:** `client.geo.regions`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n- `filters[governorate_id]` — Filter by governorate ID (optional)\n- `filters[shipping_zone_id]` — Filter by shipping zone ID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } }, { "name": "Regions Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/regions?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[governorate_id]=1&filters[shipping_zone_id]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "regions" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[governorate_id]", "value": "1", "description": "Filter by governorate ID", "disabled": true }, { "key": "filters[shipping_zone_id]", "value": "1", "description": "Filter by shipping zone ID", "disabled": true } ] }, "description": "**Route:** `client.geo.regions`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n- `filters[governorate_id]` — Filter by governorate ID (optional)\n- `filters[shipping_zone_id]` — Filter by shipping zone ID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] }, { "name": "Communication", "item": [ { "name": "Contact", "item": [ { "name": "Contact Client", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/contact", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "contact" ] }, "description": "**Route:** `client.contact`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `name`\n- **Description:** Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:100`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `subject`\n- **Description:** Subject\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Inquiry about your service`\n- **Validation rules:** `required|string|max:200`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:200` — must not exceed 200.\n### `message`\n- **Description:** Message\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example message body text.`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"subject\": \"Inquiry about your service\",\n \"message\": \"Example message body text.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Notifications", "item": [ { "name": "List All Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/notifications?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "notifications" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `client.notifications.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Read Notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/notifications/read", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "notifications", "read" ] }, "description": "**Route:** `client.notifications.read`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `ids`\n- **Description:** Ids\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"00000000-0000-0000-0000-000000000000\"]`\n- **Validation rules:** `sometimes|array`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n### `ids.*`\n- **Description:** Ids item\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-0000-0000-000000000000`\n- **Validation rules:** `uuid`\n- `uuid` — custom validation rule.\n### `all`\n- **Description:** All\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-0000-0000-000000000000\"\n ],\n \"all\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Preferences Notification", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/notifications/preferences", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "notifications", "preferences" ] }, "description": "**Route:** `client.notifications.preferences`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `allow_notifications`\n- **Description:** Allow Notifications\n- **Type:** `boolean`\n- **Required:** required\n- **Example:** `true`\n- **Validation rules:** `required|boolean`\n- `required` — must be provided.\n- `boolean` — must be true, false, 1, or 0.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"allow_notifications\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Device Notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/notifications/device", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "notifications", "device" ] }, "description": "**Route:** `client.notifications.device`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `device_id`\n- **Description:** Device ID\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `device-uuid-123`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** `fcm-token-here`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** required\n- **Example:** `ios`\n- **Validation rules:** `required|in:ios,android,web,huawei`\n- `required` — must be provided.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"device_id\": \"device-uuid-123\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List All Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.notifications.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Mark All Read Notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/mark-all-read", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", "mark-all-read" ] }, "description": "**Route:** `shared.notifications.mark-all-read`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Clear All Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/clear-all", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", "clear-all" ] }, "description": "**Route:** `shared.notifications.clear-all`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Show Notification Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Mark Read Notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id/read", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id", "read" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.mark-read`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Home", "item": [ { "name": "Home", "item": [ { "name": "List All Home", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/home?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "home" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `client.home.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } } ] } ] }, { "name": "System", "item": [ { "name": "Settings", "item": [ { "name": "Show Setting Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/settings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "settings" ] }, "description": "**Route:** `client.settings.view`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Update Setting", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/settings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "settings" ] }, "description": "**Route:** `client.settings.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `allow_notifications`\n- **Description:** Allow Notifications\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `locale`\n- **Description:** Language\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `en`\n- **Validation rules:** `sometimes|string|in:en,ar`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `in:en,ar` — must be one of: en, ar.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"allow_notifications\": true,\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Health", "item": [ { "name": "List All Health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/health?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "health" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.health.index`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Config", "item": [ { "name": "Bootstrap Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/config/bootstrap", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "config", "bootstrap" ] }, "description": "**Route:** `shared.config.bootstrap`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] }, { "name": "Wallet", "item": [ { "name": "Wallet", "item": [ { "name": "Balance Wallet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/wallet", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "wallet" ] }, "description": "**Route:** `client.wallet.balance`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Transactions Wallet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/wallet/transactions?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&type=credit&from=2024-01-01&to=2024-12-31", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "wallet", "transactions" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "type", "value": "credit", "description": "Filter by type: credit, debit", "disabled": true }, { "key": "from", "value": "2024-01-01", "description": "Filter from date", "disabled": true }, { "key": "to", "value": "2024-12-31", "description": "Filter to date", "disabled": true } ] }, "description": "**Route:** `client.wallet.transactions`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `type` — Filter by type: credit, debit (optional)\n- `from` — Filter from date (optional)\n- `to` — Filter to date (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Withdraw Wallet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/wallet/withdraw", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "wallet", "withdraw" ] }, "description": "**Route:** `client.wallet.withdraw`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `amount`\n- **Description:** Amount\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|min:1`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `min:1` — must be at least 1.\n### `bank_name`\n- **Description:** Bank Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:100`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `account_number`\n- **Description:** Account Number\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890123`\n- **Validation rules:** `required|string|max:100`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `iban`\n- **Description:** IBAN\n- **Type:** `string`\n- **Required:** required\n- **Example:** `EG123456789012345678901234`\n- **Validation rules:** `required|string|max:50`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 10,\n \"bank_name\": \"Example Name\",\n \"account_number\": \"1234567890123\",\n \"iban\": \"EG123456789012345678901234\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Search", "item": [ { "name": "Search", "item": [ { "name": "List All Search", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/search?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "search" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `client.search.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Cart", "item": [ { "name": "Cart", "item": [ { "name": "Show Cart Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/cart", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "cart" ] }, "description": "**Route:** `client.cart.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Clear Cart", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/cart", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "cart" ] }, "description": "**Route:** `client.cart.clear`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Add Item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/cart/items", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "cart", "items" ] }, "description": "**Route:** `client.cart.items.add`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `category_id`\n- **Description:** Service\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `2`\n- **Validation rules:** `required|exists:categories,id,is_active,\"1\",price,\"NOT_NULL\"`\n- `required` — must be provided.\n- `exists:categories,id,is_active,\"1\",price,\"NOT_NULL\"` — must reference an existing record (categories, id, is_active, \"1\", price, \"NOT_NULL\").\n### `quantity`\n- **Description:** Quantity\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:1|max:100`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:100` — must not exceed 100.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"category_id\": 2,\n \"quantity\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Item", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/cart/items/:itemId", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "cart", "items", ":itemId" ], "variable": [ { "key": "itemId", "value": "1", "description": "ItemId ID" } ] }, "description": "**Route:** `client.cart.items.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `quantity`\n- **Description:** Quantity\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|min:1|max:100`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:100` — must not exceed 100.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"quantity\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove Item", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/cart/items/:itemId", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "cart", "items", ":itemId" ], "variable": [ { "key": "itemId", "value": "1", "description": "ItemId ID" } ] }, "description": "**Route:** `client.cart.items.remove`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Checkout Cart", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/cart/checkout", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "cart", "checkout" ] }, "description": "**Route:** `client.cart.checkout`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context, idempotency`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `payment_method`\n- **Description:** Payment Method\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gateway`\n- **Validation rules:** `required|in:\"gateway\",\"wallet\"`\n- `required` — must be provided.\n- `in:\"gateway\",\"wallet\"` — must be one of: \"gateway\", \"wallet\".\n### `booking_type`\n- **Description:** Booking Type\n- **Type:** `string`\n- **Required:** required\n- **Example:** `instant`\n- **Validation rules:** `required|in:\"instant\",\"scheduled\"`\n- `required` — must be provided.\n- `in:\"instant\",\"scheduled\"` — must be one of: \"instant\", \"scheduled\".\n### `address_id`\n- **Description:** Address\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:addresses,id,user_id,\"1\"`\n- `required` — must be provided.\n- `exists:addresses,id,user_id,\"1\"` — must reference an existing record (addresses, id, user_id, \"1\").\n### `branch_id`\n- **Description:** Branch\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `exists:branches,id,company_id,\"1\"`\n- `exists:branches,id,company_id,\"1\"` — must reference an existing record (branches, id, company_id, \"1\").\n### `scheduled_date`\n- **Description:** Scheduled Date\n- **Type:** `string`\n- **Required:** conditional\n- **Example:** `2026-09-26`\n- **Validation rules:** `required_if:booking_type,scheduled|date|after_or_equal:today`\n- `required_if:booking_type,scheduled` — required when booking_type, scheduled.\n- `date` — must be a valid date.\n- `after_or_equal:today` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"payment_method\": \"gateway\",\n \"booking_type\": \"instant\",\n \"address_id\": 1,\n \"branch_id\": 1,\n \"scheduled_date\": \"2026-09-26\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Custom Request Cart", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/cart/custom-request", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "cart", "custom-request" ] }, "description": "**Route:** `client.cart.custom-request`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `category_id`\n- **Description:** Category\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `2`\n- **Validation rules:** `nullable|exists:categories,id`\n- `nullable` — may be null.\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `description`\n- **Description:** Description\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example content text`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `address_id`\n- **Description:** Address\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:addresses,id`\n- `required` — must be provided.\n- `exists:addresses,id` — must reference an existing record (addresses, id).\n### `branch_id`\n- **Description:** Branch\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `exists:branches,id,company_id,\"1\"`\n- `exists:branches,id,company_id,\"1\"` — must reference an existing record (branches, id, company_id, \"1\").\n### `request_media`\n- **Description:** Attachment\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"category_id\": 2,\n \"description\": \"Example content text\",\n \"address_id\": 1,\n \"branch_id\": 1,\n \"request_media\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Contracts", "item": [ { "name": "Orders", "item": [ { "name": "List All Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/orders?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "orders" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `client.orders.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Show Order Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/orders/:order", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "orders", ":order" ], "variable": [ { "key": "order", "value": "1", "description": "Order ID" } ] }, "description": "**Route:** `client.orders.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Accept Price Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/orders/:id/accept-price", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "orders", ":id", "accept-price" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `client.orders.accept-price`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `payment_method`\n- **Description:** Payment Method\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gateway`\n- **Validation rules:** `required|in:\"gateway\",\"wallet\"|custom:WalletCoversCartRule`\n- `required` — must be provided.\n- `in:\"gateway\",\"wallet\"` — must be one of: \"gateway\", \"wallet\".\n- `custom:WalletCoversCartRule` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"payment_method\": \"gateway\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject Price Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/orders/:id/reject-price", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "orders", ":id", "reject-price" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `client.orders.reject-price`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Confirm Completion Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/orders/:id/confirm-completion", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "orders", ":id", "confirm-completion" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `client.orders.confirm-completion`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `stars`\n- **Description:** Rating\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|min:1|max:5`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:5` — must not exceed 5.\n### `comment`\n- **Description:** Comment\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"stars\": 1,\n \"comment\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/orders/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "orders", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `client.orders.cancel`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `reason`\n- **Description:** Cancellation Reason\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Manual adjustment by admin.`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Manual adjustment by admin.\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "General", "item": [ { "name": "Conversations", "item": [ { "name": "List All Conversations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/conversations?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "conversations" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `client.conversations.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Create New Conversation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/conversations", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "conversations" ] }, "description": "**Route:** `client.conversations.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `subject`\n- **Description:** Subject\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Inquiry about your service`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `body`\n- **Description:** Message\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example message body text.`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `entity_id`\n- **Description:** Related entity ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"subject\": \"Inquiry about your service\",\n \"body\": \"Example message body text.\",\n \"entity_id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Conversation Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/conversations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "conversations", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `client.conversations.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Create New Message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/conversations/:id/messages", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "conversations", ":id", "messages" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `client.conversations.messages.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `body`\n- **Description:** Message\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example message body text.`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Example message body text.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Static_pages", "item": [ { "name": "About Us Static page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/static_pages/about_us", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "static_pages", "about_us" ] }, "description": "**Route:** `client.static_pages.about_us`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } }, { "name": "Privacy Policies Static page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/static_pages/privacy_policies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "static_pages", "privacy_policies" ] }, "description": "**Route:** `client.static_pages.privacy_policies`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual, active, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{client_token}}", "type": "string" } ] } } } ] } ] } ] }, { "name": "Company", "item": [ { "name": "Media", "item": [ { "name": "List All Media", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "media" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.media.index`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Create New Medium", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media", "host": [ "{{base_url}}" ], "path": [ "media" ] }, "description": "**Route:** `shared.media.store`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nSend as `multipart/form-data`. Select a local file for fields marked as `file`.\n\n**Field documentation:**\n### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|file|max:10240|mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240.\n- `mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav` — custom validation rule.\n### `collection`\n- **Description:** Collection\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "", "description": "### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `null`\n- **Validation rules:** `required|file|max:10240|mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240.\n- `mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav` — custom validation rule." }, { "key": "collection", "type": "text", "src": "value", "description": "### `collection`\n- **Description:** Collection\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `null`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255." } ] } } }, { "name": "Delete Medium", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media/:media_id", "host": [ "{{base_url}}" ], "path": [ "media", ":media_id" ], "variable": [ { "key": "media_id", "value": "1", "description": "Media_id ID" } ] }, "description": "**Route:** `shared.media.destroy`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } } ] }, { "name": "Account", "item": [ { "name": "Auth", "item": [ { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/login", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "login" ] }, "description": "**Route:** `company.auth.login`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gulf.maintenance@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `password`\n- **Validation rules:** `required|string|min:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:6` — must be at least 6.\n### `device_id`\n- **Description:** Device ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"gulf.maintenance@info.com\",\n \"password\": \"password\",\n \"device_id\": \"device-uuid-123\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "var response = pm.response.json();", "var token = response.data ? (response.data.token || response.data.access_token) : (response.token || response.access_token);", "if (token) {", " pm.collectionVariables.set(\"company_token\", token);", "}" ] } } ] }, { "name": "Register New Account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/register", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "register" ] }, "description": "**Route:** `company.auth.register`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `legal_name`\n- **Description:** Legal Company Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:200`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:200` — must not exceed 200.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|unique:users,email`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `unique:users,email` — must be unique (users, email).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|string|max:20|unique:users,phone`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone` — must be unique (users, phone).\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `vat_number`\n- **Description:** VAT Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `300012345600003`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_registration_no`\n- **Description:** Commercial Registration Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1010101010`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_register`\n- **Description:** Commercial Register File\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `commercial_register_expiry_date`\n- **Description:** Commercial Register Expiry Date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2026-09-24`\n- **Validation rules:** `nullable|date`\n- `nullable` — may be null.\n- `date` — must be a valid date.\n### `account_owner_phone`\n- **Description:** Account Owner Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `device_id`\n- **Description:** Device id\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `device_token`\n- **Description:** Device token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"legal_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"password\": \"Password123!\",\n \"vat_number\": \"300012345600003\",\n \"commercial_registration_no\": \"1010101010\",\n \"commercial_register\": \"value\",\n \"commercial_register_expiry_date\": \"2026-09-24\",\n \"account_owner_phone\": \"1234567890\",\n \"device_id\": \"device-uuid-123\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Account (OTP)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/verify", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "verify" ] }, "description": "**Route:** `company.auth.verify`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gulf.maintenance@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"gulf.maintenance@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resend Verification Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "resend-code" ] }, "description": "**Route:** `company.auth.resend`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `verification_token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"verification_token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Request Password Reset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/forgot-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "forgot-password" ] }, "description": "**Route:** `company.auth.forgot`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gulf.maintenance@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"gulf.maintenance@info.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Reset Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/verify-reset-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "verify-reset-code" ] }, "description": "**Route:** `company.auth.verify-reset-code`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gulf.maintenance@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"gulf.maintenance@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reset Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "reset-password" ] }, "description": "**Route:** `company.auth.reset`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gulf.maintenance@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `password_confirmation`\n- **Description:** Password confirmation\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"gulf.maintenance@info.com\",\n \"token\": \"\",\n \"password\": \"Password123!\",\n \"password_confirmation\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Logout", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/logout", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "logout" ] }, "description": "**Route:** `company.auth.logout`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `device_id`\n- **Description:** Device ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"device_id\": \"device-uuid-123\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Profile", "item": [ { "name": "Show Profile Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "profile" ] }, "description": "**Route:** `company.profile.view`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Update Profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "profile" ] }, "description": "**Route:** `company.profile.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `legal_name`\n- **Description:** Legal Company Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:200`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:200` — must not exceed 200.\n### `tax_number`\n- **Description:** VAT Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `300012345600003`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_registration_no`\n- **Description:** Commercial Registration Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1010101010`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_register`\n- **Description:** Commercial Register File\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `commercial_register_expiry_date`\n- **Description:** Commercial Register Expiry Date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2026-09-24`\n- **Validation rules:** `nullable|date`\n- `nullable` — may be null.\n- `date` — must be a valid date.\n### `locale`\n- **Description:** Locale\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `en`\n- **Validation rules:** `nullable|in:\"en\",\"ar\"`\n- `nullable` — may be null.\n- `in:\"en\",\"ar\"` — must be one of: \"en\", \"ar\".\n### `image`\n- **Description:** Image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"legal_name\": \"Example Name\",\n \"tax_number\": \"300012345600003\",\n \"commercial_registration_no\": \"1010101010\",\n \"commercial_register\": \"value\",\n \"commercial_register_expiry_date\": \"2026-09-24\",\n \"locale\": \"en\",\n \"image\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Password Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/profile/change-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "profile", "change-password" ] }, "description": "**Route:** `company.profile.change-password`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `current_password`\n- **Description:** Current Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"current_password\": \"Password123!\",\n \"password\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Email Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/profile/change-email", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "profile", "change-email" ] }, "description": "**Route:** `company.profile.change-email`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `new_email`\n- **Description:** New Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|unique:users,email,\"1\",id`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `unique:users,email,\"1\",id` — must be unique (users, email, \"1\", id).\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"new_email\": \"user@example.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Email Change Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/profile/verify-email-change", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "profile", "verify-email-change" ] }, "description": "**Route:** `company.profile.verify-email-change`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"\",\n \"code\": \"123456\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Phone Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/profile/change-phone", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "profile", "change-phone" ] }, "description": "**Route:** `company.profile.change-phone`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `new_phone`\n- **Description:** New Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|string|max:20|unique:users,phone,\"1\",id`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone,\"1\",id` — must be unique (users, phone, \"1\", id).\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"new_phone\": \"1234567890\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Phone Change Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/profile/verify-phone-change", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "profile", "verify-phone-change" ] }, "description": "**Route:** `company.profile.verify-phone-change`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"token\": \"\",\n \"code\": \"123456\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Geo", "item": [ { "name": "Countries", "item": [ { "name": "Countries Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/countries", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "countries" ] }, "description": "**Route:** `company.geo.countries`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Governorates", "item": [ { "name": "Governorates Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/governorates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "governorates" ] }, "description": "**Route:** `company.geo.governorates`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Regions", "item": [ { "name": "Regions Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/regions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "regions" ] }, "description": "**Route:** `company.geo.regions`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] }, { "name": "System", "item": [ { "name": "Settings", "item": [ { "name": "Show Setting Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/settings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "settings" ] }, "description": "**Route:** `company.settings.view`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Update Setting", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/settings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "settings" ] }, "description": "**Route:** `company.settings.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `allow_notifications`\n- **Description:** Allow Notifications\n- **Type:** `boolean`\n- **Required:** optional\n- **Example:** `true`\n- **Validation rules:** `sometimes|boolean`\n- `sometimes` — validated only when the field is present.\n- `boolean` — must be true, false, 1, or 0.\n### `locale`\n- **Description:** Language\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `en`\n- **Validation rules:** `sometimes|string|in:en,ar`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `in:en,ar` — must be one of: en, ar.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"allow_notifications\": true,\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Health", "item": [ { "name": "List All Health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/health?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "health" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.health.index`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Config", "item": [ { "name": "Bootstrap Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/config/bootstrap", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "config", "bootstrap" ] }, "description": "**Route:** `shared.config.bootstrap`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] }, { "name": "Wallet", "item": [ { "name": "Wallet", "item": [ { "name": "Balance Wallet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/wallet", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "wallet" ] }, "description": "**Route:** `company.wallet.balance`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Transactions Wallet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/wallet/transactions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "wallet", "transactions" ] }, "description": "**Route:** `company.wallet.transactions`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Organization", "item": [ { "name": "Branches", "item": [ { "name": "List All Branches", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/branches?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "branches" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `company.branches.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Create New Branch", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/branches", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "branches" ] }, "description": "**Route:** `company.branches.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `name`\n- **Description:** Branch Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:150`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `phone`\n- **Description:** Branch Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|string|max:20`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `address_text`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `latitude`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|between:-90,90`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `longitude`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|between:-180,180`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `allowed_slots`\n- **Description:** Available Visit Slots\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"morning\"]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `allowed_slots.*`\n- **Description:** Allowed slots item\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `morning`\n- **Validation rules:** `string|in:morning,afternoon,evening`\n- `string` — must be text.\n- `in:morning,afternoon,evening` — must be one of: morning, afternoon, evening.\n### `working_hours`\n- **Description:** Working Hours\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[{\"day\":\"sunday\",\"from\":\"09:00\",\"to\":\"09:00\"}]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `working_hours.*.day`\n- **Description:** Day\n- **Type:** `string`\n- **Required:** required\n- **Example:** `sunday`\n- **Validation rules:** `required|distinct|in:\"sunday\",\"monday\",\"tuesday\",\"wednesday\",\"thursday\",\"friday\",\"saturday\"`\n- `required` — must be provided.\n- `distinct` — custom validation rule.\n- `in:\"sunday\",\"monday\",\"tuesday\",\"wednesday\",\"thursday\",\"friday\",\"saturday\"` — must be one of: \"sunday\", \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\".\n### `working_hours.*.from`\n- **Description:** From\n- **Type:** `string`\n- **Required:** required\n- **Example:** `09:00`\n- **Validation rules:** `required|date_format:H:i`\n- `required` — must be provided.\n- `date_format:H:i` — custom validation rule.\n### `working_hours.*.to`\n- **Description:** To\n- **Type:** `string`\n- **Required:** required\n- **Example:** `09:00`\n- **Validation rules:** `required|date_format:H:i`\n- `required` — must be provided.\n- `date_format:H:i` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Name\",\n \"phone\": \"1234567890\",\n \"address_text\": \"123 Main Street, Building A\",\n \"latitude\": 10,\n \"longitude\": 10,\n \"allowed_slots\": [\n \"morning\"\n ],\n \"working_hours\": [\n {\n \"day\": \"sunday\",\n \"from\": \"09:00\",\n \"to\": \"09:00\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Branch Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/branches/:branch", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "branches", ":branch" ], "variable": [ { "key": "branch", "value": "1", "description": "Branch ID" } ] }, "description": "**Route:** `company.branches.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Update Branch", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/branches/:branch", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "branches", ":branch" ], "variable": [ { "key": "branch", "value": "1", "description": "Branch ID" } ] }, "description": "**Route:** `company.branches.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `name`\n- **Description:** Branch Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:150`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `phone`\n- **Description:** Branch Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `sometimes|string|max:20`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `address_text`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `sometimes|string|max:500`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `latitude`\n- **Description:** Latitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|between:-90,90`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `between:-90,90` — must be between -90, 90.\n### `longitude`\n- **Description:** Longitude\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|between:-180,180`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `between:-180,180` — must be between -180, 180.\n### `allowed_slots`\n- **Description:** Available Visit Slots\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"morning\"]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `allowed_slots.*`\n- **Description:** Allowed slots item\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `morning`\n- **Validation rules:** `string|in:morning,afternoon,evening`\n- `string` — must be text.\n- `in:morning,afternoon,evening` — must be one of: morning, afternoon, evening.\n### `working_hours`\n- **Description:** Working Hours\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[{\"day\":\"sunday\",\"from\":\"09:00\",\"to\":\"09:00\"}]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `working_hours.*.day`\n- **Description:** Day\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `sunday`\n- **Validation rules:** `sometimes|distinct|in:\"sunday\",\"monday\",\"tuesday\",\"wednesday\",\"thursday\",\"friday\",\"saturday\"`\n- `sometimes` — validated only when the field is present.\n- `distinct` — custom validation rule.\n- `in:\"sunday\",\"monday\",\"tuesday\",\"wednesday\",\"thursday\",\"friday\",\"saturday\"` — must be one of: \"sunday\", \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\", \"saturday\".\n### `working_hours.*.from`\n- **Description:** From\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `09:00`\n- **Validation rules:** `sometimes|date_format:H:i`\n- `sometimes` — validated only when the field is present.\n- `date_format:H:i` — custom validation rule.\n### `working_hours.*.to`\n- **Description:** To\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `09:00`\n- **Validation rules:** `sometimes|date_format:H:i`\n- `sometimes` — validated only when the field is present.\n- `date_format:H:i` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Name\",\n \"phone\": \"1234567890\",\n \"address_text\": \"123 Main Street, Building A\",\n \"latitude\": 10,\n \"longitude\": 10,\n \"allowed_slots\": [\n \"morning\"\n ],\n \"working_hours\": [\n {\n \"day\": \"sunday\",\n \"from\": \"09:00\",\n \"to\": \"09:00\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Branch", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/branches/:branch", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "branches", ":branch" ], "variable": [ { "key": "branch", "value": "1", "description": "Branch ID" } ] }, "description": "**Route:** `company.branches.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Content", "item": [ { "name": "Categories", "item": [ { "name": "List All Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/categories?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "categories" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `company.categories.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "List Category Services", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/categories/:id/services", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "categories", ":id", "services" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.categories.services`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } } ] }, { "name": "Faqs", "item": [ { "name": "List All Faqs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/faqs?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "faqs" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `company.faqs.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Contracts", "item": [ { "name": "Contracts", "item": [ { "name": "List All Contracts", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/contracts?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "contracts" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `company.contracts.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Create New Contract", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/contracts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "contracts" ] }, "description": "**Route:** `company.contracts.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `billing_cycle`\n- **Description:** Billing cycle\n- **Type:** `string`\n- **Required:** required\n- **Example:** `monthly`\n- **Validation rules:** `required|in:monthly,quarterly,annual`\n- `required` — must be provided.\n- `in:monthly,quarterly,annual` — must be one of: monthly, quarterly, annual.\n### `start_date`\n- **Description:** Start date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2026-09-26`\n- **Validation rules:** `nullable|date|after_or_equal:today`\n- `nullable` — may be null.\n- `date` — must be a valid date.\n- `after_or_equal:today` — custom validation rule.\n### `end_date`\n- **Description:** End date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2026-09-26`\n- **Validation rules:** `nullable|date|after:start_date`\n- `nullable` — may be null.\n- `date` — must be a valid date.\n- `after:start_date` — custom validation rule.\n### `currency`\n- **Description:** Currency\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `EGP`\n- **Validation rules:** `sometimes|string|size:3`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `size:3` — custom validation rule.\n### `notes`\n- **Description:** Notes\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:1000`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:1000` — must not exceed 1000.\n### `branches`\n- **Description:** Branches\n- **Type:** `array`\n- **Required:** required\n- **Example:** `[{\"branch_id\":1,\"service_ids\":[1],\"visits_allowed\":1}]`\n- **Validation rules:** `required|array|min:1`\n- `required` — must be provided.\n- `array` — must be an array.\n- `min:1` — must be at least 1.\n### `branches.*.branch_id`\n- **Description:** Branches item branch id\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:branches,id,company_id,\"1\"`\n- `required` — must be provided.\n- `exists:branches,id,company_id,\"1\"` — must reference an existing record (branches, id, company_id, \"1\").\n### `branches.*.service_ids`\n- **Description:** Branches item service ids\n- **Type:** `array`\n- **Required:** required\n- **Example:** `[1]`\n- **Validation rules:** `required|array|min:1`\n- `required` — must be provided.\n- `array` — must be an array.\n- `min:1` — must be at least 1.\n### `branches.*.service_ids.*`\n- **Description:** Branches item service ids item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `exists:categories,id`\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `branches.*.visits_allowed`\n- **Description:** Branches item visits allowed\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|min:1`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n### `signed_media_id`\n- **Description:** Signed media id\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|exists:media,id`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `exists:media,id` — must reference an existing record (media, id).\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"billing_cycle\": \"monthly\",\n \"start_date\": \"2026-09-26\",\n \"end_date\": \"2026-09-26\",\n \"currency\": \"EGP\",\n \"notes\": \"value\",\n \"branches\": [\n {\n \"branch_id\": 1,\n \"service_ids\": [\n 1\n ],\n \"visits_allowed\": 1\n }\n ],\n \"signed_media_id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Contract Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/contracts/:contract", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "contracts", ":contract" ], "variable": [ { "key": "contract", "value": "1", "description": "Contract ID" } ] }, "description": "**Route:** `company.contracts.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Delete Contract", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/contracts/:contract", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "contracts", ":contract" ], "variable": [ { "key": "contract", "value": "1", "description": "Contract ID" } ] }, "description": "**Route:** `company.contracts.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Template Contract", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/contracts/:id/template", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "contracts", ":id", "template" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.contracts.template`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Sign Contract", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/contracts/:id/sign", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "contracts", ":id", "sign" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.contracts.sign`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `signed_media_id`\n- **Description:** Signed media id\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|exists:media,id`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `exists:media,id` — must reference an existing record (media, id).\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"signed_media_id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Renew Contract", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/contracts/:id/renew", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "contracts", ":id", "renew" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.contracts.renew`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Invoices", "item": [ { "name": "List All Invoices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/invoices?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "invoices" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `company.invoices.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Show Invoice Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/invoices/:invoice", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "invoices", ":invoice" ], "variable": [ { "key": "invoice", "value": "1", "description": "Invoice ID" } ] }, "description": "**Route:** `company.invoices.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Payment Options Invoice", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/invoices/:invoice/payment-options", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "invoices", ":invoice", "payment-options" ], "variable": [ { "key": "invoice", "value": "1", "description": "Invoice ID" } ] }, "description": "**Route:** `company.invoices.payment-options`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Gateway Payment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/invoices/:invoice/payments/gateway", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "invoices", ":invoice", "payments", "gateway" ], "variable": [ { "key": "invoice", "value": "1", "description": "Invoice ID" } ] }, "description": "**Route:** `company.invoices.payments.gateway`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active, idempotency`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `callback_url`\n- **Description:** Callback URL\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"callback_url\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Status Payment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/invoices/:invoice/payments/:payment/status", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "invoices", ":invoice", "payments", ":payment", "status" ], "variable": [ { "key": "invoice", "value": "1", "description": "Invoice ID" }, { "key": "payment", "value": "1", "description": "Payment ID" } ] }, "description": "**Route:** `company.invoices.payments.status`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Create New Receipt", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/invoices/:invoice/receipts", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "invoices", ":invoice", "receipts" ], "variable": [ { "key": "invoice", "value": "1", "description": "Invoice ID" } ] }, "description": "**Route:** `company.invoices.receipts.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `receipt_hash`\n- **Description:** Receipt\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|string|exists:media,hash`\n- `required` — must be provided.\n- `string` — must be text.\n- `exists:media,hash` — must reference an existing record (media, hash).\n### `transfer_reference`\n- **Description:** Transfer Reference\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `transferred_at`\n- **Description:** Transfer Date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2026-09-24`\n- **Validation rules:** `nullable|date`\n- `nullable` — may be null.\n- `date` — must be a valid date.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"receipt_hash\": \"value\",\n \"transfer_reference\": \"value\",\n \"transferred_at\": \"2026-09-24\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resubmit Receipt", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/invoices/:invoice/receipts/:receipt/resubmit", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "invoices", ":invoice", "receipts", ":receipt", "resubmit" ], "variable": [ { "key": "invoice", "value": "1", "description": "Invoice ID" }, { "key": "receipt", "value": "1", "description": "Receipt ID" } ] }, "description": "**Route:** `company.invoices.receipts.resubmit`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `receipt_hash`\n- **Description:** Receipt\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|string|exists:media,hash`\n- `required` — must be provided.\n- `string` — must be text.\n- `exists:media,hash` — must reference an existing record (media, hash).\n### `transfer_reference`\n- **Description:** Transfer Reference\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `transferred_at`\n- **Description:** Transfer Date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2026-09-24`\n- **Validation rules:** `nullable|date`\n- `nullable` — may be null.\n- `date` — must be a valid date.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"receipt_hash\": \"value\",\n \"transfer_reference\": \"value\",\n \"transferred_at\": \"2026-09-24\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Orders", "item": [ { "name": "List All Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/orders?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "orders" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `company.orders.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Show Order Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/orders/:order", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "orders", ":order" ], "variable": [ { "key": "order", "value": "1", "description": "Order ID" } ] }, "description": "**Route:** `company.orders.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Accept Price Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/orders/:id/accept-price", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "orders", ":id", "accept-price" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.orders.accept-price`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `payment_method`\n- **Description:** Payment Method\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gateway`\n- **Validation rules:** `required|in:\"gateway\",\"wallet\"|custom:WalletCoversCartRule`\n- `required` — must be provided.\n- `in:\"gateway\",\"wallet\"` — must be one of: \"gateway\", \"wallet\".\n- `custom:WalletCoversCartRule` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"payment_method\": \"gateway\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject Price Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/orders/:id/reject-price", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "orders", ":id", "reject-price" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.orders.reject-price`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Confirm Completion Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/orders/:id/confirm-completion", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "orders", ":id", "confirm-completion" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.orders.confirm-completion`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `stars`\n- **Description:** Rating\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|min:1|max:5`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:5` — must not exceed 5.\n### `comment`\n- **Description:** Comment\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"stars\": 1,\n \"comment\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/orders/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "orders", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.orders.cancel`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `reason`\n- **Description:** Cancellation Reason\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Manual adjustment by admin.`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Manual adjustment by admin.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Visits", "item": [ { "name": "List All Visits", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/visits?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "visits" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `company.visits.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Show Visit Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/visits/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "visits", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.visits.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Cancel Visit", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/visits/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "visits", ":id", "cancel" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.visits.cancel`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `reason`\n- **Description:** Cancellation Reason\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Manual adjustment by admin.`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Manual adjustment by admin.\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "General", "item": [ { "name": "Reports", "item": [ { "name": "List All Reports", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/reports?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "reports" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `company.reports.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Summary Report", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/reports/summary", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "reports", "summary" ] }, "description": "**Route:** `company.reports.summary`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } } ] }, { "name": "Conversations", "item": [ { "name": "List All Conversations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/conversations?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "conversations" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `company.conversations.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Create New Conversation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/conversations", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "conversations" ] }, "description": "**Route:** `company.conversations.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `subject`\n- **Description:** Subject\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Inquiry about your service`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `body`\n- **Description:** Message\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example message body text.`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `entity_id`\n- **Description:** Related entity ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"subject\": \"Inquiry about your service\",\n \"body\": \"Example message body text.\",\n \"entity_id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Conversation Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/conversations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "conversations", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.conversations.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Create New Message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/conversations/:id/messages", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "conversations", ":id", "messages" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `company.conversations.messages.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `body`\n- **Description:** Message\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example message body text.`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Example message body text.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Static_pages", "item": [ { "name": "About Us Static page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/static_pages/about_us", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "static_pages", "about_us" ] }, "description": "**Route:** `company.static_pages.about_us`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Privacy Policies Static page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/static_pages/privacy_policies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "static_pages", "privacy_policies" ] }, "description": "**Route:** `company.static_pages.privacy_policies`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Cart", "item": [ { "name": "Cart", "item": [ { "name": "Show Cart Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/cart", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "cart" ] }, "description": "**Route:** `company.cart.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Clear Cart", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/cart", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "cart" ] }, "description": "**Route:** `company.cart.clear`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Add Item", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/cart/items", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "cart", "items" ] }, "description": "**Route:** `company.cart.items.add`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `category_id`\n- **Description:** Service\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `2`\n- **Validation rules:** `required|exists:categories,id,is_active,\"1\",price,\"NOT_NULL\"`\n- `required` — must be provided.\n- `exists:categories,id,is_active,\"1\",price,\"NOT_NULL\"` — must reference an existing record (categories, id, is_active, \"1\", price, \"NOT_NULL\").\n### `quantity`\n- **Description:** Quantity\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:1|max:100`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:100` — must not exceed 100.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"category_id\": 2,\n \"quantity\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update Item", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/cart/items/:itemId", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "cart", "items", ":itemId" ], "variable": [ { "key": "itemId", "value": "1", "description": "ItemId ID" } ] }, "description": "**Route:** `company.cart.items.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `quantity`\n- **Description:** Quantity\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|min:1|max:100`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:100` — must not exceed 100.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"quantity\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Remove Item", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/cart/items/:itemId", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "cart", "items", ":itemId" ], "variable": [ { "key": "itemId", "value": "1", "description": "ItemId ID" } ] }, "description": "**Route:** `company.cart.items.remove`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Create New Custom request", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/cart/custom-requests", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "cart", "custom-requests" ] }, "description": "**Route:** `company.cart.custom-requests.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `category_id`\n- **Description:** Category\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `2`\n- **Validation rules:** `nullable|exists:categories,id`\n- `nullable` — may be null.\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `description`\n- **Description:** Description\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example content text`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `address_id`\n- **Description:** Address\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:addresses,id`\n- `required` — must be provided.\n- `exists:addresses,id` — must reference an existing record (addresses, id).\n### `branch_id`\n- **Description:** Branch\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `exists:branches,id,company_id,\"1\"`\n- `exists:branches,id,company_id,\"1\"` — must reference an existing record (branches, id, company_id, \"1\").\n### `request_media`\n- **Description:** Attachment\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"category_id\": 2,\n \"description\": \"Example content text\",\n \"address_id\": 1,\n \"branch_id\": 1,\n \"request_media\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Checkout Cart", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/cart/checkout", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "cart", "checkout" ] }, "description": "**Route:** `company.cart.checkout`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active, idempotency`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `payment_method`\n- **Description:** Payment Method\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gateway`\n- **Validation rules:** `required|in:\"gateway\",\"wallet\"`\n- `required` — must be provided.\n- `in:\"gateway\",\"wallet\"` — must be one of: \"gateway\", \"wallet\".\n### `booking_type`\n- **Description:** Booking Type\n- **Type:** `string`\n- **Required:** required\n- **Example:** `instant`\n- **Validation rules:** `required|in:\"instant\",\"scheduled\"`\n- `required` — must be provided.\n- `in:\"instant\",\"scheduled\"` — must be one of: \"instant\", \"scheduled\".\n### `address_id`\n- **Description:** Address\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|exists:addresses,id,user_id,\"1\"`\n- `required` — must be provided.\n- `exists:addresses,id,user_id,\"1\"` — must reference an existing record (addresses, id, user_id, \"1\").\n### `branch_id`\n- **Description:** Branch\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `exists:branches,id,company_id,\"1\"`\n- `exists:branches,id,company_id,\"1\"` — must reference an existing record (branches, id, company_id, \"1\").\n### `scheduled_date`\n- **Description:** Scheduled Date\n- **Type:** `string`\n- **Required:** conditional\n- **Example:** `2026-09-26`\n- **Validation rules:** `required_if:booking_type,scheduled|date|after_or_equal:today`\n- `required_if:booking_type,scheduled` — required when booking_type, scheduled.\n- `date` — must be a valid date.\n- `after_or_equal:today` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"payment_method\": \"gateway\",\n \"booking_type\": \"instant\",\n \"address_id\": 1,\n \"branch_id\": 1,\n \"scheduled_date\": \"2026-09-26\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Home", "item": [ { "name": "Home", "item": [ { "name": "List All Home", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/home?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "home" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `company.home.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:company, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Communication", "item": [ { "name": "Notifications", "item": [ { "name": "List All Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.notifications.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Mark All Read Notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/mark-all-read", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", "mark-all-read" ] }, "description": "**Route:** `shared.notifications.mark-all-read`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Clear All Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/clear-all", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", "clear-all" ] }, "description": "**Route:** `shared.notifications.clear-all`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Show Notification Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } }, { "name": "Mark Read Notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id/read", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id", "read" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.mark-read`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{company_token}}", "type": "string" } ] } } } ] } ] } ] }, { "name": "Technician", "item": [ { "name": "Media", "item": [ { "name": "List All Media", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "media" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.media.index`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Create New Medium", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media", "host": [ "{{base_url}}" ], "path": [ "media" ] }, "description": "**Route:** `shared.media.store`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nSend as `multipart/form-data`. Select a local file for fields marked as `file`.\n\n**Field documentation:**\n### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|file|max:10240|mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240.\n- `mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav` — custom validation rule.\n### `collection`\n- **Description:** Collection\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "", "description": "### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `null`\n- **Validation rules:** `required|file|max:10240|mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240.\n- `mimes:jpg,jpeg,png,gif,webp,pdf,avi,mov,wmv,flv,mkv,mp4,mp3,wav` — custom validation rule." }, { "key": "collection", "type": "text", "src": "value", "description": "### `collection`\n- **Description:** Collection\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `null`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255." } ] } } }, { "name": "Delete Medium", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/media/:media_id", "host": [ "{{base_url}}" ], "path": [ "media", ":media_id" ], "variable": [ { "key": "media_id", "value": "1", "description": "Media_id ID" } ] }, "description": "**Route:** `shared.media.destroy`\n**Middleware:** `auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } } ] }, { "name": "Account", "item": [ { "name": "Auth", "item": [ { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/login", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "login" ] }, "description": "**Route:** `technician.auth.login`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `technician@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `password`\n- **Validation rules:** `required|string|min:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:6` — must be at least 6.\n### `device_id`\n- **Description:** Device ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"technician@info.com\",\n \"password\": \"password\",\n \"device_id\": \"device-uuid-123\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "var response = pm.response.json();", "var token = response.data ? (response.data.token || response.data.access_token) : (response.token || response.access_token);", "if (token) {", " pm.collectionVariables.set(\"technician_token\", token);", "}" ] } } ] }, { "name": "Register New Account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/register", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "register" ] }, "description": "**Route:** `technician.auth.register`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:100`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|unique:users,email`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `unique:users,email` — must be unique (users, email).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|string|max:20|unique:users,phone`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone` — must be unique (users, phone).\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `id_number`\n- **Description:** ID Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:countries,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `governorate_id`\n- **Description:** City\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:governorates,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `region_id`\n- **Description:** District\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:regions,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `category_id`\n- **Description:** Service Category\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `2`\n- **Validation rules:** `required|integer|exists:categories,id`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `region_ids`\n- **Description:** Coverage Areas\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[1]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `region_ids.*`\n- **Description:** Region ids item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `integer|exists:regions,id`\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `years_experience`\n- **Description:** Years of Experience\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|min:0|max:50`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:0` — must be at least .\n- `max:50` — must not exceed 50.\n### `daily_order_capacity`\n- **Description:** Daily Order Capacity\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|min:1|max:50`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:50` — must not exceed 50.\n### `personal_photo`\n- **Description:** Personal Photo\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `national_id_front`\n- **Description:** National ID (Front)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `national_id_back`\n- **Description:** National ID (Back)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `cv_file`\n- **Description:** CV/Resume\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `device_id`\n- **Description:** Device id\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `device_token`\n- **Description:** Device token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `device_type`\n- **Description:** Device type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"id_number\": \"1234567890\",\n \"address\": \"123 Main Street, Building A\",\n \"country_id\": 1,\n \"governorate_id\": 1,\n \"region_id\": 1,\n \"password\": \"Password123!\",\n \"category_id\": 2,\n \"region_ids\": [\n 1\n ],\n \"years_experience\": 1,\n \"daily_order_capacity\": 1,\n \"personal_photo\": 1,\n \"national_id_front\": 1,\n \"national_id_back\": 1,\n \"cv_file\": 1,\n \"device_id\": \"device-uuid-123\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Account (OTP)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/verify", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "verify" ] }, "description": "**Route:** `technician.auth.verify`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `technician@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"technician@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resend Verification Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "resend-code" ] }, "description": "**Route:** `technician.auth.resend`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `verification_token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"verification_token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Request Password Reset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/forgot-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "forgot-password" ] }, "description": "**Route:** `technician.auth.forgot`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `technician@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"technician@info.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Reset Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/verify-reset-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "verify-reset-code" ] }, "description": "**Route:** `technician.auth.verify-reset-code`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `technician@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"technician@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reset Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "reset-password" ] }, "description": "**Route:** `technician.auth.reset`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `technician@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `password_confirmation`\n- **Description:** Password confirmation\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"technician@info.com\",\n \"token\": \"\",\n \"password\": \"Password123!\",\n \"password_confirmation\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Logout", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/logout", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "logout" ] }, "description": "**Route:** `technician.auth.logout`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `device_id`\n- **Description:** Device ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"device_id\": \"device-uuid-123\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Profile", "item": [ { "name": "Show Profile Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "profile" ] }, "description": "**Route:** `technician.profile.view`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Update Profile", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "profile" ] }, "description": "**Route:** `technician.profile.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `name`\n- **Description:** Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:160`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:160` — must not exceed 160.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `user@example.com`\n- **Validation rules:** `sometimes|email|unique:users,email,1`\n- `sometimes` — validated only when the field is present.\n- `email` — must be a valid email address.\n- `unique:users,email,1` — must be unique (users, email, 1).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `sometimes|string|max:20|unique:users,phone,1`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone,1` — must be unique (users, phone, 1).\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\n- **Validation rules:** `sometimes|string|max:150`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `id_number`\n- **Description:** ID Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `sometimes|nullable|string|max:50`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `sometimes|nullable|string|max:255`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|nullable|integer|exists:countries,id`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `governorate_id`\n- **Description:** City\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|nullable|integer|exists:governorates,id`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `region_id`\n- **Description:** District\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|nullable|integer|exists:regions,id`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `category_id`\n- **Description:** Service Category\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `2`\n- **Validation rules:** `sometimes|integer|exists:categories,id`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `coverage_areas`\n- **Description:** Coverage Areas (Regions)\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[1]`\n- **Validation rules:** `sometimes|nullable|array`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `array` — must be an array.\n### `coverage_areas.*`\n- **Description:** Coverage areas item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `integer|exists:regions,id`\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `years_experience`\n- **Description:** Years of Experience\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|nullable|integer|min:0|max:50`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:0` — must be at least .\n- `max:50` — must not exceed 50.\n### `daily_order_capacity`\n- **Description:** Daily Order Capacity\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|nullable|integer|min:1|max:50`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:50` — must not exceed 50.\n### `personal_photo`\n- **Description:** Personal Photo\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|nullable|string|custom:MediaExists`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `national_id_front`\n- **Description:** National ID (Front)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|nullable|string|custom:MediaExists`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `national_id_back`\n- **Description:** National ID (Back)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|nullable|string|custom:MediaExists`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `cv_file`\n- **Description:** CV/Resume\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|nullable|string|custom:MediaExists`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"full_name\": \"Example Name\",\n \"id_number\": \"1234567890\",\n \"address\": \"123 Main Street, Building A\",\n \"country_id\": 1,\n \"governorate_id\": 1,\n \"region_id\": 1,\n \"category_id\": 2,\n \"coverage_areas\": [\n 1\n ],\n \"years_experience\": 1,\n \"daily_order_capacity\": 1,\n \"personal_photo\": 1,\n \"national_id_front\": 1,\n \"national_id_back\": 1,\n \"cv_file\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Password Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/profile/change-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "profile", "change-password" ] }, "description": "**Route:** `technician.profile.change-password`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `current_password`\n- **Description:** Current password\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `OldPassword123!`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `NewPassword123!`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n### `password_confirmation`\n- **Description:** Password confirmation\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `NewPassword123!`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"current_password\": \"OldPassword123!\",\n \"password\": \"NewPassword123!\",\n \"password_confirmation\": \"NewPassword123!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Toggle Availability Profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/profile/toggle-availability", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "profile", "toggle-availability" ] }, "description": "**Route:** `technician.profile.toggle-availability`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Content", "item": [ { "name": "Categories", "item": [ { "name": "List All Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/categories?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "categories" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `technician.categories.index`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Faqs", "item": [ { "name": "List All Faqs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/faqs?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "faqs" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `technician.faqs.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Home", "item": [ { "name": "Home", "item": [ { "name": "Home Technician", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/home", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "home" ] }, "description": "**Route:** `technician.home`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } } ] } ] }, { "name": "System", "item": [ { "name": "Settings", "item": [ { "name": "Update Setting", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/settings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "settings" ] }, "description": "**Route:** `technician.settings.update`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `allow_notifications`\n- **Description:** Allow Notifications\n- **Type:** `boolean`\n- **Required:** required\n- **Example:** `true`\n- **Validation rules:** `required|boolean`\n- `required` — must be provided.\n- `boolean` — must be true, false, 1, or 0.\n### `locale`\n- **Description:** Language\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `en`\n- **Validation rules:** `sometimes|nullable|string|in:en,ar`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `in:en,ar` — must be one of: en, ar.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"allow_notifications\": true,\n \"locale\": \"en\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Health", "item": [ { "name": "List All Health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/health?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "health" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.health.index`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Config", "item": [ { "name": "Bootstrap Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/config/bootstrap", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "config", "bootstrap" ] }, "description": "**Route:** `shared.config.bootstrap`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] }, { "name": "Contracts", "item": [ { "name": "Orders", "item": [ { "name": "List All Orders", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/orders?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "orders" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `technician.orders.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Show Order Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/orders/:order", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "orders", ":order" ], "variable": [ { "key": "order", "value": "1", "description": "Order ID" } ] }, "description": "**Route:** `technician.orders.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Accept Assignment Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/orders/:id/accept-assignment", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "orders", ":id", "accept-assignment" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `technician.orders.accept-assignment`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reject Assignment Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/orders/:id/reject-assignment", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "orders", ":id", "reject-assignment" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `technician.orders.reject-assignment`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Start Heading Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/orders/:id/start-heading", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "orders", ":id", "start-heading" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `technician.orders.start-heading`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Start Execution Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/orders/:id/start-execution", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "orders", ":id", "start-execution" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `technician.orders.start-execution`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Finish Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/orders/:id/finish", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "orders", ":id", "finish" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `technician.orders.finish`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Unreachable Order", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/orders/:id/unreachable", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "orders", ":id", "unreachable" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `technician.orders.unreachable`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `reason`\n- **Description:** Reason\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Manual adjustment by admin.`\n- **Validation rules:** `required|string|max:500`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"Manual adjustment by admin.\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create New Attachment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/orders/:id/attachments", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "orders", ":id", "attachments" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `technician.orders.attachments.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `hash`\n- **Description:** File\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|string|custom:MediaExists`\n- `required` — must be provided.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `type`\n- **Description:** Attachment type\n- **Type:** `string`\n- **Required:** required\n- **Example:** `before`\n- **Validation rules:** `required|string|in:\"before\",\"after\",\"report\",\"issue\",\"signature\",\"other\"`\n- `required` — must be provided.\n- `string` — must be text.\n- `in:\"before\",\"after\",\"report\",\"issue\",\"signature\",\"other\"` — must be one of: \"before\", \"after\", \"report\", \"issue\", \"signature\", \"other\".\n### `note`\n- **Description:** Note\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"hash\": \"value\",\n \"type\": \"before\",\n \"note\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Wallet", "item": [ { "name": "Wallet", "item": [ { "name": "Balance Wallet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/wallet", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "wallet" ] }, "description": "**Route:** `technician.wallet.balance`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Transactions Wallet", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/wallet/transactions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "wallet", "transactions" ] }, "description": "**Route:** `technician.wallet.transactions`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Withdraw Wallet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/wallet/withdraw", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "wallet", "withdraw" ] }, "description": "**Route:** `technician.wallet.withdraw`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `amount`\n- **Description:** Amount\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|min:1`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `min:1` — must be at least 1.\n### `bank_name`\n- **Description:** Bank Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:100`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `account_number`\n- **Description:** Account Number\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890123`\n- **Validation rules:** `required|string|max:100`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `iban`\n- **Description:** IBAN\n- **Type:** `string`\n- **Required:** required\n- **Example:** `EG123456789012345678901234`\n- **Validation rules:** `required|string|max:50`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 10,\n \"bank_name\": \"Example Name\",\n \"account_number\": \"1234567890123\",\n \"iban\": \"EG123456789012345678901234\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "General", "item": [ { "name": "Conversations", "item": [ { "name": "List All Conversations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/conversations?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "conversations" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `technician.conversations.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Create New Conversation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/conversations", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "conversations" ] }, "description": "**Route:** `technician.conversations.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `subject`\n- **Description:** Subject\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Inquiry about your service`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `body`\n- **Description:** Message\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example message body text.`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `entity_id`\n- **Description:** Related entity ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"subject\": \"Inquiry about your service\",\n \"body\": \"Example message body text.\",\n \"entity_id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Conversation Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/conversations/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "conversations", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `technician.conversations.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Create New Message", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/conversations/:id/messages", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "conversations", ":id", "messages" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `technician.conversations.messages.store`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `body`\n- **Description:** Message\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example message body text.`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"body\": \"Example message body text.\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Static_pages", "item": [ { "name": "About Us Static page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/static_pages/about_us", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "static_pages", "about_us" ] }, "description": "**Route:** `technician.static_pages.about_us`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Privacy Policies Static page", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/static_pages/privacy_policies", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "static_pages", "privacy_policies" ] }, "description": "**Route:** `technician.static_pages.privacy_policies`\n**Middleware:** `api, set_locale, cors, auth:api, user:technician, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } } ] } ] }, { "name": "Communication", "item": [ { "name": "Notifications", "item": [ { "name": "List All Notifications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.notifications.index`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Mark All Read Notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/mark-all-read", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", "mark-all-read" ] }, "description": "**Route:** `shared.notifications.mark-all-read`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Clear All Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/clear-all", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", "clear-all" ] }, "description": "**Route:** `shared.notifications.clear-all`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Show Notification Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.show`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } }, { "name": "Mark Read Notification", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id/read", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id", "read" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.mark-read`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `key`\n- **Description:** Key\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `not specified`\n- `not specified` — no validation rule was declared.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] }, "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Notification", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/notifications/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "notifications", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `shared.notifications.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, user:individual,company,technician,admin,super_admin, active`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{technician_token}}", "type": "string" } ] } } } ] } ] } ] }, { "name": "Guest", "item": [ { "name": "Admin", "item": [ { "name": "Account", "item": [ { "name": "Auth", "item": [ { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/auth/login", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "auth", "login" ] }, "description": "**Route:** `admin.auth.login`\n**Middleware:** `api, set_locale, cors, admin.login_throttle`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `admin@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `password`\n- **Validation rules:** `required|string|min:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:6` — must be at least 6.\n### `device_id`\n- **Description:** Device ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"admin@info.com\",\n \"password\": \"password\",\n \"device_id\": \"device-uuid-123\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "var response = pm.response.json();", "var token = response.data ? (response.data.token || response.data.access_token) : (response.token || response.access_token);", "if (token) {", " pm.collectionVariables.set(\"admin_token\", token);", "}" ] } } ] } ] } ] }, { "name": "System", "item": [ { "name": "Health", "item": [ { "name": "List All Health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/health?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "health" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.health.index`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Config", "item": [ { "name": "Bootstrap Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/config/bootstrap", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "config", "bootstrap" ] }, "description": "**Route:** `shared.config.bootstrap`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] } ] }, { "name": "Client", "item": [ { "name": "Account", "item": [ { "name": "Auth", "item": [ { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/login", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "login" ] }, "description": "**Route:** `client.auth.login`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `individual@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `password`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string`\n- `nullable` — may be null.\n- `string` — must be text.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"individual@info.com\",\n \"password\": \"password\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "var response = pm.response.json();", "var token = response.data ? (response.data.token || response.data.access_token) : (response.token || response.access_token);", "if (token) {", " pm.collectionVariables.set(\"client_token\", token);", "}" ] } } ] }, { "name": "Register New Account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/register", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "register" ] }, "description": "**Route:** `client.auth.register`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:150`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:150` — must not exceed 150.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|unique:users,email`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `unique:users,email` — must be unique (users, email).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20|unique:users,phone`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone` — must be unique (users, phone).\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string`\n- `nullable` — may be null.\n- `string` — must be text.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"password\": \"Password123!\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Account (OTP)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/verify", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "verify" ] }, "description": "**Route:** `client.auth.verify`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `individual@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"individual@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resend Verification Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "resend-code" ] }, "description": "**Route:** `client.auth.resend`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `verification_token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"verification_token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Request Password Reset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/forgot-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "forgot-password" ] }, "description": "**Route:** `client.auth.forgot`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `individual@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"individual@info.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Reset Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/verify-reset-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "verify-reset-code" ] }, "description": "**Route:** `client.auth.verify-reset-code`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `individual@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"individual@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reset Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/auth/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "auth", "reset-password" ] }, "description": "**Route:** `client.auth.reset`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `individual@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `password_confirmation`\n- **Description:** Password confirmation\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"individual@info.com\",\n \"token\": \"\",\n \"password\": \"Password123!\",\n \"password_confirmation\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Content", "item": [ { "name": "Pages", "item": [ { "name": "Page Content", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/pages/:type", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "pages", ":type" ], "variable": [ { "key": "type", "value": "1", "description": "Type ID" } ] }, "description": "**Route:** `client.content.page`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Sliders", "item": [ { "name": "Sliders Content", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/sliders?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "sliders" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true } ] }, "description": "**Route:** `client.content.sliders`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] }, { "name": "Geo", "item": [ { "name": "Countries", "item": [ { "name": "Countries Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/countries?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[continent]=asia", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "countries" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true }, { "key": "filters[continent]", "value": "asia", "description": "Filter by continent", "disabled": true } ] }, "description": "**Route:** `client.geo.countries`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n- `filters[continent]` — Filter by continent (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } }, { "name": "Countries Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/countries?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[continent]=asia", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "countries" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true }, { "key": "filters[continent]", "value": "asia", "description": "Filter by continent", "disabled": true } ] }, "description": "**Route:** `client.geo.countries`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n- `filters[continent]` — Filter by continent (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Governorates", "item": [ { "name": "Governorates Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/governorates?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[country_id]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "governorates" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[country_id]", "value": "1", "description": "Filter by country ID", "disabled": true } ] }, "description": "**Route:** `client.geo.governorates`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n- `filters[country_id]` — Filter by country ID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } }, { "name": "Governorates Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/governorates?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[country_id]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "governorates" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[country_id]", "value": "1", "description": "Filter by country ID", "disabled": true } ] }, "description": "**Route:** `client.geo.governorates`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n- `filters[country_id]` — Filter by country ID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Regions", "item": [ { "name": "Regions Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/regions?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[governorate_id]=1&filters[shipping_zone_id]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "regions" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[governorate_id]", "value": "1", "description": "Filter by governorate ID", "disabled": true }, { "key": "filters[shipping_zone_id]", "value": "1", "description": "Filter by shipping zone ID", "disabled": true } ] }, "description": "**Route:** `client.geo.regions`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n- `filters[governorate_id]` — Filter by governorate ID (optional)\n- `filters[shipping_zone_id]` — Filter by shipping zone ID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } }, { "name": "Regions Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/regions?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[governorate_id]=1&filters[shipping_zone_id]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "regions" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[governorate_id]", "value": "1", "description": "Filter by governorate ID", "disabled": true }, { "key": "filters[shipping_zone_id]", "value": "1", "description": "Filter by shipping zone ID", "disabled": true } ] }, "description": "**Route:** `client.geo.regions`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status (optional)\n- `filters[governorate_id]` — Filter by governorate ID (optional)\n- `filters[shipping_zone_id]` — Filter by shipping zone ID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] }, { "name": "Media", "item": [ { "name": "Upload", "item": [ { "name": "Upload Client", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/upload", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "upload" ] }, "description": "**Route:** `client.upload`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `multipart/form-data`. Select a local file for fields marked as `file`.\n\n**Field documentation:**\n### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|file|max:10240`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240.\n### `type`\n- **Description:** File Type\n- **Type:** `file`\n- **Required:** optional\n- **Example:** `image`\n- **Validation rules:** `nullable|string|in:image,document,video,audio`\n- `nullable` — may be null.\n- `string` — must be text.\n- `in:image,document,video,audio` — must be one of: image, document, video, audio.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "src": "", "description": "### `file`\n- **Description:** File\n- **Type:** `file`\n- **Required:** required\n- **Example:** `null`\n- **Validation rules:** `required|file|max:10240`\n- `required` — must be provided.\n- `file` — custom validation rule.\n- `max:10240` — must not exceed 10240." }, { "key": "type", "type": "text", "src": "image", "description": "### `type`\n- **Description:** Type\n- **Type:** `file`\n- **Required:** optional\n- **Example:** `null`\n- **Validation rules:** `nullable|string|in:image,document,video,audio`\n- `nullable` — may be null.\n- `string` — must be text.\n- `in:image,document,video,audio` — must be one of: image, document, video, audio." } ] } } } ] } ] }, { "name": "Communication", "item": [ { "name": "Contact", "item": [ { "name": "Contact Client", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/contact", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "contact" ] }, "description": "**Route:** `client.contact`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `name`\n- **Description:** Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:100`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `subject`\n- **Description:** Subject\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Inquiry about your service`\n- **Validation rules:** `required|string|max:200`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:200` — must not exceed 200.\n### `message`\n- **Description:** Message\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example message body text.`\n- **Validation rules:** `required|string|max:2000`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"subject\": \"Inquiry about your service\",\n \"message\": \"Example message body text.\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "System", "item": [ { "name": "Health", "item": [ { "name": "List All Health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/health?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "health" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.health.index`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Config", "item": [ { "name": "Bootstrap Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/config/bootstrap", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "config", "bootstrap" ] }, "description": "**Route:** `shared.config.bootstrap`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] } ] }, { "name": "Technician", "item": [ { "name": "Account", "item": [ { "name": "Auth", "item": [ { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/login", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "login" ] }, "description": "**Route:** `technician.auth.login`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `technician@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `password`\n- **Validation rules:** `required|string|min:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:6` — must be at least 6.\n### `device_id`\n- **Description:** Device ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"technician@info.com\",\n \"password\": \"password\",\n \"device_id\": \"device-uuid-123\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "var response = pm.response.json();", "var token = response.data ? (response.data.token || response.data.access_token) : (response.token || response.access_token);", "if (token) {", " pm.collectionVariables.set(\"technician_token\", token);", "}" ] } } ] }, { "name": "Register New Account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/register", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "register" ] }, "description": "**Route:** `technician.auth.register`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `full_name`\n- **Description:** Full Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:100`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|unique:users,email`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `unique:users,email` — must be unique (users, email).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|string|max:20|unique:users,phone`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone` — must be unique (users, phone).\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `id_number`\n- **Description:** ID Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `123 Main Street, Building A`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `country_id`\n- **Description:** Country\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:countries,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:countries,id` — must reference an existing record (countries, id).\n### `governorate_id`\n- **Description:** City\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:governorates,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:governorates,id` — must reference an existing record (governorates, id).\n### `region_id`\n- **Description:** District\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|exists:regions,id`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `category_id`\n- **Description:** Service Category\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `2`\n- **Validation rules:** `required|integer|exists:categories,id`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `exists:categories,id` — must reference an existing record (categories, id).\n### `region_ids`\n- **Description:** Coverage Areas\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[1]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `region_ids.*`\n- **Description:** Region ids item\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `integer|exists:regions,id`\n- `integer` — must be a whole number.\n- `exists:regions,id` — must reference an existing record (regions, id).\n### `years_experience`\n- **Description:** Years of Experience\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|min:0|max:50`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:0` — must be at least .\n- `max:50` — must not exceed 50.\n### `daily_order_capacity`\n- **Description:** Daily Order Capacity\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|integer|min:1|max:50`\n- `nullable` — may be null.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:50` — must not exceed 50.\n### `personal_photo`\n- **Description:** Personal Photo\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `national_id_front`\n- **Description:** National ID (Front)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `national_id_back`\n- **Description:** National ID (Back)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `cv_file`\n- **Description:** CV/Resume\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `device_id`\n- **Description:** Device id\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `device_token`\n- **Description:** Device token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `device_type`\n- **Description:** Device type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"id_number\": \"1234567890\",\n \"address\": \"123 Main Street, Building A\",\n \"country_id\": 1,\n \"governorate_id\": 1,\n \"region_id\": 1,\n \"password\": \"Password123!\",\n \"category_id\": 2,\n \"region_ids\": [\n 1\n ],\n \"years_experience\": 1,\n \"daily_order_capacity\": 1,\n \"personal_photo\": 1,\n \"national_id_front\": 1,\n \"national_id_back\": 1,\n \"cv_file\": 1,\n \"device_id\": \"device-uuid-123\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Account (OTP)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/verify", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "verify" ] }, "description": "**Route:** `technician.auth.verify`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `technician@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"technician@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resend Verification Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "resend-code" ] }, "description": "**Route:** `technician.auth.resend`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `verification_token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"verification_token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Request Password Reset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/forgot-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "forgot-password" ] }, "description": "**Route:** `technician.auth.forgot`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `technician@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"technician@info.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Reset Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/verify-reset-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "verify-reset-code" ] }, "description": "**Route:** `technician.auth.verify-reset-code`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `technician@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"technician@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reset Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/auth/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "auth", "reset-password" ] }, "description": "**Route:** `technician.auth.reset`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `technician@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `password_confirmation`\n- **Description:** Password confirmation\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"technician@info.com\",\n \"token\": \"\",\n \"password\": \"Password123!\",\n \"password_confirmation\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Content", "item": [ { "name": "Categories", "item": [ { "name": "List All Categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/technician/categories?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "technician", "categories" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `technician.categories.index`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] }, { "name": "System", "item": [ { "name": "Health", "item": [ { "name": "List All Health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/health?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "health" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.health.index`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Config", "item": [ { "name": "Bootstrap Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/config/bootstrap", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "config", "bootstrap" ] }, "description": "**Route:** `shared.config.bootstrap`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] } ] }, { "name": "Company", "item": [ { "name": "Account", "item": [ { "name": "Auth", "item": [ { "name": "Login", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/login", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "login" ] }, "description": "**Route:** `company.auth.login`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gulf.maintenance@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `password`\n- **Validation rules:** `required|string|min:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:6` — must be at least 6.\n### `device_id`\n- **Description:** Device ID\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"gulf.maintenance@info.com\",\n \"password\": \"password\",\n \"device_id\": \"device-uuid-123\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "var response = pm.response.json();", "var token = response.data ? (response.data.token || response.data.access_token) : (response.token || response.access_token);", "if (token) {", " pm.collectionVariables.set(\"company_token\", token);", "}" ] } } ] }, { "name": "Register New Account", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/register", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "register" ] }, "description": "**Route:** `company.auth.register`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `legal_name`\n- **Description:** Legal Company Name\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Example Name`\n- **Validation rules:** `required|string|max:200`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:200` — must not exceed 200.\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|email|unique:users,email`\n- `required` — must be provided.\n- `email` — must be a valid email address.\n- `unique:users,email` — must be unique (users, email).\n### `phone`\n- **Description:** Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|string|max:20|unique:users,phone`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n- `unique:users,phone` — must be unique (users, phone).\n### `phone_code`\n- **Description:** Phone Code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `20`\n- **Validation rules:** `nullable|string|max:5`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `vat_number`\n- **Description:** VAT Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `300012345600003`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_registration_no`\n- **Description:** Commercial Registration Number\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1010101010`\n- **Validation rules:** `nullable|string|max:50`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n### `commercial_register`\n- **Description:** Commercial Register File\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|custom:MediaExists`\n- `nullable` — may be null.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `commercial_register_expiry_date`\n- **Description:** Commercial Register Expiry Date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2026-09-24`\n- **Validation rules:** `nullable|date`\n- `nullable` — may be null.\n- `date` — must be a valid date.\n### `account_owner_phone`\n- **Description:** Account Owner Phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `nullable|string|max:20`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:20` — must not exceed 20.\n### `device_id`\n- **Description:** Device id\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `device-uuid-123`\n- **Validation rules:** `nullable|string|max:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\n### `device_token`\n- **Description:** Device token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\n- **Validation rules:** `nullable|string|max:500`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:500` — must not exceed 500.\n### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `ios`\n- **Validation rules:** `nullable|in:ios,android,web,huawei`\n- `nullable` — may be null.\n- `in:ios,android,web,huawei` — must be one of: ios, android, web, huawei.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"legal_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"20\",\n \"password\": \"Password123!\",\n \"vat_number\": \"300012345600003\",\n \"commercial_registration_no\": \"1010101010\",\n \"commercial_register\": \"value\",\n \"commercial_register_expiry_date\": \"2026-09-24\",\n \"account_owner_phone\": \"1234567890\",\n \"device_id\": \"device-uuid-123\",\n \"device_token\": \"fcm-token-here\",\n \"device_type\": \"ios\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Account (OTP)", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/verify", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "verify" ] }, "description": "**Route:** `company.auth.verify`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gulf.maintenance@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"gulf.maintenance@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resend Verification Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "resend-code" ] }, "description": "**Route:** `company.auth.resend`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `verification_token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"verification_token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Request Password Reset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/forgot-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "forgot-password" ] }, "description": "**Route:** `company.auth.forgot`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gulf.maintenance@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"gulf.maintenance@info.com\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify Reset Code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/verify-reset-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "verify-reset-code" ] }, "description": "**Route:** `company.auth.verify-reset-code`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gulf.maintenance@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `123456`\n- **Validation rules:** `required|string|size:6`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:6` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"gulf.maintenance@info.com\",\n \"code\": \"123456\",\n \"token\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reset Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/auth/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "auth", "reset-password" ] }, "description": "**Route:** `company.auth.reset`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `gulf.maintenance@info.com`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** ``\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `confirmed` — requires a matching *_confirmation field.\n### `password_confirmation`\n- **Description:** Password confirmation\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string`\n- `required` — must be provided.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"gulf.maintenance@info.com\",\n \"token\": \"\",\n \"password\": \"Password123!\",\n \"password_confirmation\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Geo", "item": [ { "name": "Countries", "item": [ { "name": "Countries Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/countries", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "countries" ] }, "description": "**Route:** `company.geo.countries`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Governorates", "item": [ { "name": "Governorates Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/governorates", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "governorates" ] }, "description": "**Route:** `company.geo.governorates`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Regions", "item": [ { "name": "Regions Geo", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/company/regions", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "company", "regions" ] }, "description": "**Route:** `company.geo.regions`\n**Middleware:** `api, set_locale, cors, geo.context`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] }, { "name": "System", "item": [ { "name": "Health", "item": [ { "name": "List All Health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/health?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "health" ], "query": [ { "key": "page", "value": "1", "description": "Page number", "disabled": false }, { "key": "per_page", "value": "15", "description": "Items per page (max: 100)", "disabled": true }, { "key": "search", "value": "", "description": "Search term (searches across searchable fields)", "disabled": true }, { "key": "sort[created_at]", "value": "desc", "description": "Sort by field: asc or desc", "disabled": true }, { "key": "paginate", "value": "false", "description": "Set to false to disable pagination", "disabled": true }, { "key": "filters[is_active]", "value": "1", "description": "Filter by active status: 1 or 0", "disabled": true } ] }, "description": "**Route:** `shared.health.index`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Query parameters:**\n- `page` — Page number (supported)\n- `per_page` — Items per page (max: 100) (optional)\n- `search` — Search term (searches across searchable fields) (optional)\n- `sort[created_at]` — Sort by field: asc or desc (optional)\n- `paginate` — Set to false to disable pagination (optional)\n- `filters[is_active]` — Filter by active status: 1 or 0 (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] }, { "name": "Config", "item": [ { "name": "Bootstrap Config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" } ], "url": { "raw": "{{base_url}}/api/v1/config/bootstrap", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "config", "bootstrap" ] }, "description": "**Route:** `shared.config.bootstrap`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nNo request body. Use the documented path and query parameters.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] } ] } ] } ] }