{ "info": { "name": "Morvia API", "_postman_id": "8686915e-e8f1-4a4f-af0a-ed591eb6a38f", "description": "Auto-generated API documentation.\nGenerated: 2026-11-15 09:37:16", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "http://localhost:8000", "type": "string" }, { "key": "token", "value": "", "type": "string" }, { "key": "locale", "value": "en", "type": "string" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "item": [ { "name": "Shared", "item": [ { "name": "Media", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/media", "host": [ "{{base_url}}" ], "path": [ "media" ] }, "description": "**Route:** `shared.media.store`\n**Middleware:** `auth:api, 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:** required\n- **Example:** `value`\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```", "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:** required\n- **Example:** `null`\n- **Validation rules:** `required|string|max:255`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:255` — must not exceed 255." } ] } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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```" } } ] }, { "name": "General", "item": [ { "name": "Trainer", "item": [ { "name": "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/trainer/auth/register", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "auth", "register" ] }, "description": "**Route:** `trainer.auth.register`\n**Middleware:** `api, set_locale, cors, throttle:10,1`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `national_id`\n- **Description:** National ID / Iqama number\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|regex:/^[12]\\d{9}$/|unique:trainers,national_id,NULL,id,deleted_at,\"NULL\"`\n- `required` — must be provided.\n- `regex:/^[12]\\d{9}$/` — custom validation rule.\n- `unique:trainers,national_id,NULL,id,deleted_at,\"NULL\"` — must be unique (trainers, national_id, NULL, id, deleted_at, \"NULL\").\n### `phone_code`\n- **Description:** Country code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|in:966`\n- `required` — must be provided.\n- `in:966` — must be one of: 966.\n### `phone`\n- **Description:** Mobile number\n- **Type:** `string`\n- **Required:** required\n- **Example:** `1234567890`\n- **Validation rules:** `required|regex:/^5\\d{8}$/|unique:users,phone,NULL,id,user_type,\"trainer\",deleted_at,\"NULL\"`\n- `required` — must be provided.\n- `regex:/^5\\d{8}$/` — custom validation rule.\n- `unique:users,phone,NULL,id,user_type,\"trainer\",deleted_at,\"NULL\"` — must be unique (users, phone, NULL, id, user_type, \"trainer\", deleted_at, \"NULL\").\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|max:72|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `max:72` — must not exceed 72.\n- `confirmed` — requires a matching *_confirmation field.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"national_id\": 1,\n \"phone_code\": \"1234567890\",\n \"phone\": \"1234567890\",\n \"password\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify", "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/trainer/auth/verify", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "auth", "verify" ] }, "description": "**Route:** `trainer.auth.verify`\n**Middleware:** `api, set_locale, cors, throttle:10,1`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\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### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|string|size:4`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:4` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"token\": \"value\",\n \"code\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resend", "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/trainer/auth/resend-code", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "auth", "resend-code" ] }, "description": "**Route:** `trainer.auth.resend`\n**Middleware:** `api, set_locale, cors, throttle:10,1`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\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\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"token\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "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/trainer/auth/login", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "auth", "login" ] }, "description": "**Route:** `trainer.auth.login`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Phone, email or username\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\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### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|max:72`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:72` — must not exceed 72.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"value\",\n \"password\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Forgot", "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/trainer/auth/forgot-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "auth", "forgot-password" ] }, "description": "**Route:** `trainer.auth.forgot`\n**Middleware:** `api, set_locale, cors, throttle:10,1`\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:** `value`\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\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "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/trainer/auth/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "auth", "reset-password" ] }, "description": "**Route:** `trainer.auth.reset`\n**Middleware:** `api, set_locale, cors, throttle:10,1`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\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### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|string|size:4`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:4` — custom validation rule.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|max:72|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `max:72` — must not exceed 72.\n- `confirmed` — requires a matching *_confirmation field.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"token\": \"value\",\n \"code\": \"value\",\n \"password\": \"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}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/auth/logout", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "auth", "logout" ] }, "description": "**Route:** `trainer.auth.logout`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `device_token`\n- **Description:** Device token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\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```", "body": { "mode": "raw", "raw": "{\n \"device_token\": \"fcm-token-here\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "profile" ] }, "description": "**Route:** `trainer.profile.show`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "profile" ] }, "description": "**Route:** `trainer.profile.update`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `user@example.com`\n- **Validation rules:** `sometimes|email:rfc|max:255|unique:users,email,NULL,id,user_type,\"trainer\",deleted_at,\"NULL\"`\n- `sometimes` — validated only when the field is present.\n- `email:rfc` — must be a valid email address.\n- `max:255` — must not exceed 255.\n- `unique:users,email,NULL,id,user_type,\"trainer\",deleted_at,\"NULL\"` — must be unique (users, email, NULL, id, user_type, \"trainer\", deleted_at, \"NULL\").\n### `bio`\n- **Description:** Bio\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\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### `specialisations`\n- **Description:** Specialisation\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|nullable|string|max:2000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `experience`\n- **Description:** Experience\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|nullable|string|max:5000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\n### `qualifications`\n- **Description:** Training qualifications\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\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### `intro_content`\n- **Description:** Introduction\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `sometimes|nullable|string|max:3000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:3000` — must not exceed 3000.\n### `categories`\n- **Description:** Specialisation\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"00000000-0000-4000-8000-000000000001\"]`\n- **Validation rules:** `sometimes|array|min:1|max:10`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `min:1` — must be at least 1.\n- `max:10` — must not exceed 10.\n### `categories.*`\n- **Description:** Specialisation\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `uuid|distinct|exists:categories,uuid,is_active,\"1\",deleted_at,\"NULL\"`\n- `uuid` — custom validation rule.\n- `distinct` — custom validation rule.\n- `exists:categories,uuid,is_active,\"1\",deleted_at,\"NULL\"` — must reference an existing record (categories, uuid, is_active, \"1\", deleted_at, \"NULL\").\n### `city_id`\n- **Description:** City\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|uuid|exists:cities,uuid,is_active,\"1\",deleted_at,\"NULL\"`\n- `sometimes` — validated only when the field is present.\n- `uuid` — custom validation rule.\n- `exists:cities,uuid,is_active,\"1\",deleted_at,\"NULL\"` — must reference an existing record (cities, uuid, is_active, \"1\", deleted_at, \"NULL\").\n### `iban`\n- **Description:** IBAN\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|regex:/^SA\\d{22}$/`\n- `sometimes` — validated only when the field is present.\n- `regex:/^SA\\d{22}$/` — custom validation rule.\n### `photo`\n- **Description:** Photo\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|string|custom:MediaExists`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `cv`\n- **Description:** CV\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|string|custom:MediaExists`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `training_licence`\n- **Description:** Training licence\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|string|custom:MediaExists`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `custom:MediaExists` — custom validation rule.\n### `external_links`\n- **Description:** External links\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"https://example.com\"]`\n- **Validation rules:** `sometimes|array|max:5`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `max:5` — must not exceed 5.\n### `external_links.*`\n- **Description:** External links\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `https://example.com`\n- **Validation rules:** `url|max:500`\n- `url` — must be a valid URL.\n- `max:500` — must not exceed 500.\n### `accept_terms`\n- **Description:** Terms and policies\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|accepted`\n- `sometimes` — validated only when the field is present.\n- `accepted` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"email\": \"user@example.com\",\n \"bio\": \"value\",\n \"specialisations\": \"value\",\n \"experience\": \"value\",\n \"qualifications\": \"value\",\n \"intro_content\": \"Example content text\",\n \"categories\": [\n \"00000000-0000-4000-8000-000000000001\"\n ],\n \"city_id\": \"00000000-0000-4000-8000-000000000001\",\n \"iban\": \"value\",\n \"photo\": \"value\",\n \"cv\": \"value\",\n \"training_licence\": \"value\",\n \"external_links\": [\n \"https://example.com\"\n ],\n \"accept_terms\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Submit", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/profile/submit", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "profile", "submit" ] }, "description": "**Route:** `trainer.profile.submit`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```", "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/profile/password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "profile", "password" ] }, "description": "**Route:** `trainer.profile.password`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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|max:72`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:72` — must not exceed 72.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|max:72|confirmed|different:current_password`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `max:72` — must not exceed 72.\n- `confirmed` — requires a matching *_confirmation field.\n- `different:current_password` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"current_password\": \"Password123!\",\n \"password\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/nafath", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "nafath" ] }, "description": "**Route:** `trainer.nafath.status`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```" } }, { "name": "Start", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/nafath", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "nafath" ] }, "description": "**Route:** `trainer.nafath.start`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, active, throttle:6,1`\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```", "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Plans", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/subscription-plans", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "subscription-plans" ] }, "description": "**Route:** `trainer.subscription.plans`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```" } }, { "name": "Current", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/subscription", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "subscription" ] }, "description": "**Route:** `trainer.subscription.current`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```" } }, { "name": "Purchase", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/subscription/purchase", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "subscription", "purchase" ] }, "description": "**Route:** `trainer.subscription.purchase`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `plan_id`\n- **Description:** Package\n- **Type:** `string`\n- **Required:** required\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `required|uuid|exists:trainer_plans,uuid,is_active,\"1\",deleted_at,\"NULL\"`\n- `required` — must be provided.\n- `uuid` — custom validation rule.\n- `exists:trainer_plans,uuid,is_active,\"1\",deleted_at,\"NULL\"` — must reference an existing record (trainer_plans, uuid, is_active, \"1\", deleted_at, \"NULL\").\n### `idempotency_key`\n- **Description:** Request key\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|string|min:8|max:60|regex:/^[A-Za-z0-9:_-]+$/`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `max:60` — must not exceed 60.\n- `regex:/^[A-Za-z0-9:_-]+$/` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"plan_id\": \"00000000-0000-4000-8000-000000000001\",\n \"idempotency_key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Commission", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/subscription/commission", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "subscription", "commission" ] }, "description": "**Route:** `trainer.subscription.commission`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```", "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/halls?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "halls" ], "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:** `trainer.halls.index`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```" } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/halls/:hall", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "halls", ":hall" ], "variable": [ { "key": "hall", "value": "1", "description": "Hall ID" } ] }, "description": "**Route:** `trainer.halls.show`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```" } }, { "name": "Preview", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/hall-bookings/preview", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "hall-bookings", "preview" ] }, "description": "**Route:** `trainer.halls.bookings.preview`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `hall_id`\n- **Description:** Hall\n- **Type:** `string`\n- **Required:** required\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `required|uuid|exists:halls,uuid,deleted_at,\"NULL\"`\n- `required` — must be provided.\n- `uuid` — custom validation rule.\n- `exists:halls,uuid,deleted_at,\"NULL\"` — must reference an existing record (halls, uuid, deleted_at, \"NULL\").\n### `attendees`\n- **Description:** Expected attendees\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|min:1|max:100000`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:100000` — must not exceed 100000.\n### `features`\n- **Description:** Features\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"00000000-0000-4000-8000-000000000001\"]`\n- **Validation rules:** `sometimes|array|max:50`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `max:50` — must not exceed 50.\n### `features.*`\n- **Description:** Feature\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `uuid|distinct`\n- `uuid` — custom validation rule.\n- `distinct` — custom validation rule.\n### `slots`\n- **Description:** Slots\n- **Type:** `array`\n- **Required:** required\n- **Example:** `[{\"starts_at\":\"2024-01-01\",\"ends_at\":\"2024-01-01\"}]`\n- **Validation rules:** `required|array|min:1|max:31`\n- `required` — must be provided.\n- `array` — must be an array.\n- `min:1` — must be at least 1.\n- `max:31` — must not exceed 31.\n### `slots.*.starts_at`\n- **Description:** Start time\n- **Type:** `string`\n- **Required:** required\n- **Example:** `2024-01-01`\n- **Validation rules:** `required|date_format:Y-m-d H:i`\n- `required` — must be provided.\n- `date_format:Y-m-d H:i` — custom validation rule.\n### `slots.*.ends_at`\n- **Description:** End time\n- **Type:** `string`\n- **Required:** required\n- **Example:** `2024-01-01`\n- **Validation rules:** `required|date_format:Y-m-d H:i`\n- `required` — must be provided.\n- `date_format:Y-m-d H:i` — custom validation rule.\n### `notes`\n- **Description:** Notes\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|nullable|string|max:2000`\n- `sometimes` — validated only when the field is present.\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```", "body": { "mode": "raw", "raw": "{\n \"hall_id\": \"00000000-0000-4000-8000-000000000001\",\n \"attendees\": 1,\n \"features\": [\n \"00000000-0000-4000-8000-000000000001\"\n ],\n \"slots\": [\n {\n \"starts_at\": \"2024-01-01\",\n \"ends_at\": \"2024-01-01\"\n }\n ],\n \"notes\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/hall-bookings?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "hall-bookings" ], "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:** `trainer.halls.bookings.index`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/hall-bookings", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "hall-bookings" ] }, "description": "**Route:** `trainer.halls.bookings.store`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `hall_id`\n- **Description:** Hall\n- **Type:** `string`\n- **Required:** required\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `required|uuid|exists:halls,uuid,deleted_at,\"NULL\"`\n- `required` — must be provided.\n- `uuid` — custom validation rule.\n- `exists:halls,uuid,deleted_at,\"NULL\"` — must reference an existing record (halls, uuid, deleted_at, \"NULL\").\n### `attendees`\n- **Description:** Expected attendees\n- **Type:** `integer`\n- **Required:** required\n- **Example:** `1`\n- **Validation rules:** `required|integer|min:1|max:100000`\n- `required` — must be provided.\n- `integer` — must be a whole number.\n- `min:1` — must be at least 1.\n- `max:100000` — must not exceed 100000.\n### `features`\n- **Description:** Features\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"00000000-0000-4000-8000-000000000001\"]`\n- **Validation rules:** `sometimes|array|max:50`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `max:50` — must not exceed 50.\n### `features.*`\n- **Description:** Feature\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `uuid|distinct`\n- `uuid` — custom validation rule.\n- `distinct` — custom validation rule.\n### `slots`\n- **Description:** Slots\n- **Type:** `array`\n- **Required:** required\n- **Example:** `[{\"starts_at\":\"2024-01-01\",\"ends_at\":\"2024-01-01\"}]`\n- **Validation rules:** `required|array|min:1|max:31`\n- `required` — must be provided.\n- `array` — must be an array.\n- `min:1` — must be at least 1.\n- `max:31` — must not exceed 31.\n### `slots.*.starts_at`\n- **Description:** Start time\n- **Type:** `string`\n- **Required:** required\n- **Example:** `2024-01-01`\n- **Validation rules:** `required|date_format:Y-m-d H:i`\n- `required` — must be provided.\n- `date_format:Y-m-d H:i` — custom validation rule.\n### `slots.*.ends_at`\n- **Description:** End time\n- **Type:** `string`\n- **Required:** required\n- **Example:** `2024-01-01`\n- **Validation rules:** `required|date_format:Y-m-d H:i`\n- `required` — must be provided.\n- `date_format:Y-m-d H:i` — custom validation rule.\n### `notes`\n- **Description:** Notes\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|nullable|string|max:2000`\n- `sometimes` — validated only when the field is present.\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```", "body": { "mode": "raw", "raw": "{\n \"hall_id\": \"00000000-0000-4000-8000-000000000001\",\n \"attendees\": 1,\n \"features\": [\n \"00000000-0000-4000-8000-000000000001\"\n ],\n \"slots\": [\n {\n \"starts_at\": \"2024-01-01\",\n \"ends_at\": \"2024-01-01\"\n }\n ],\n \"notes\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/hall-bookings/:booking", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "hall-bookings", ":booking" ], "variable": [ { "key": "booking", "value": "1", "description": "Booking ID" } ] }, "description": "**Route:** `trainer.halls.bookings.show`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```" } }, { "name": "Withdraw", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/hall-bookings/:booking/withdraw", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "hall-bookings", ":booking", "withdraw" ], "variable": [ { "key": "booking", "value": "1", "description": "Booking ID" } ] }, "description": "**Route:** `trainer.halls.bookings.withdraw`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```", "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/courses?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "courses" ], "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:** `trainer.courses.index`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/courses", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "courses" ] }, "description": "**Route:** `trainer.courses.store`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `type`\n- **Description:** Course type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|in:\"in_person\",\"external\"`\n- `sometimes` — validated only when the field is present.\n- `in:\"in_person\",\"external\"` — must be one of: \"in_person\", \"external\".\n### `category_id`\n- **Description:** Category\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|uuid|exists:categories,uuid,is_active,\"1\",deleted_at,\"NULL\"`\n- `sometimes` — validated only when the field is present.\n- `uuid` — custom validation rule.\n- `exists:categories,uuid,is_active,\"1\",deleted_at,\"NULL\"` — must reference an existing record (categories, uuid, is_active, \"1\", deleted_at, \"NULL\").\n### `city_id`\n- **Description:** City\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|uuid|exists:cities,uuid,is_active,\"1\",deleted_at,\"NULL\"`\n- `sometimes` — validated only when the field is present.\n- `uuid` — custom validation rule.\n- `exists:cities,uuid,is_active,\"1\",deleted_at,\"NULL\"` — must reference an existing record (cities, uuid, is_active, \"1\", deleted_at, \"NULL\").\n### `name`\n- **Description:** Course title\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### `description`\n- **Description:** Description\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `sometimes|string|max:10000`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:10000` — must not exceed 10000.\n### `images`\n- **Description:** Course image\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"value\"]`\n- **Validation rules:** `sometimes|array|max:5`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `max:5` — must not exceed 5.\n### `images.*`\n- **Description:** Course image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `string|distinct|custom:MediaExists`\n- `string` — must be text.\n- `distinct` — custom validation rule.\n- `custom:MediaExists` — custom validation rule.\n### `starts_on`\n- **Description:** Course date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2024-01-01`\n- **Validation rules:** `sometimes|date_format:Y-m-d|after_or_equal:today`\n- `sometimes` — validated only when the field is present.\n- `date_format:Y-m-d` — custom validation rule.\n- `after_or_equal:today` — custom validation rule.\n### `start_time`\n- **Description:** Start time\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2024-01-01`\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### `duration_minutes`\n- **Description:** Duration\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:15|max:1440`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `min:15` — must be at least 15.\n- `max:1440` — must not exceed 1440.\n### `is_free`\n- **Description:** Free course\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### `price`\n- **Description:** Price\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|min:0|max:9999999999.99|decimal:0,2`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `min:0` — must be at least .\n- `max:9999999999.99` — must not exceed 9999999999.99.\n- `decimal:0,2` — custom validation rule.\n### `seats`\n- **Description:** Seats\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:1|max:100000`\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:100000` — must not exceed 100000.\n### `sessions_count`\n- **Description:** Number of sessions\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:1|max:365`\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:365` — must not exceed 365.\n### `external_link`\n- **Description:** External link\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `https://example.com`\n- **Validation rules:** `nullable|url|max:1000`\n- `nullable` — may be null.\n- `url` — must be a valid URL.\n- `max:1000` — must not exceed 1000.\n### `access_instructions`\n- **Description:** Access instructions\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|nullable|string|max:5000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\n### `venue_name`\n- **Description:** Venue name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\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### `venue_address`\n- **Description:** Venue address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|nullable|string|max:2000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `venue_map_url`\n- **Description:** Venue location link\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `https://example.com`\n- **Validation rules:** `sometimes|nullable|url|max:1000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `url` — must be a valid URL.\n- `max:1000` — must not exceed 1000.\n### `venue_notes`\n- **Description:** Venue details\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|nullable|string|max:2000`\n- `sometimes` — validated only when the field is present.\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```", "body": { "mode": "raw", "raw": "{\n \"type\": \"value\",\n \"category_id\": \"00000000-0000-4000-8000-000000000001\",\n \"city_id\": \"00000000-0000-4000-8000-000000000001\",\n \"name\": \"Example Name\",\n \"description\": \"Example content text\",\n \"images\": [\n \"value\"\n ],\n \"starts_on\": \"2024-01-01\",\n \"start_time\": \"2024-01-01\",\n \"duration_minutes\": 1,\n \"is_free\": true,\n \"price\": 10,\n \"seats\": 1,\n \"sessions_count\": 1,\n \"external_link\": \"https://example.com\",\n \"access_instructions\": \"value\",\n \"venue_name\": \"Example Name\",\n \"venue_address\": \"value\",\n \"venue_map_url\": \"https://example.com\",\n \"venue_notes\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/courses/:course", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "courses", ":course" ], "variable": [ { "key": "course", "value": "1", "description": "Course ID" } ] }, "description": "**Route:** `trainer.courses.show`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/courses/:course", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "courses", ":course" ], "variable": [ { "key": "course", "value": "1", "description": "Course ID" } ] }, "description": "**Route:** `trainer.courses.update`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `type`\n- **Description:** Course type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|in:\"in_person\",\"external\"`\n- `sometimes` — validated only when the field is present.\n- `in:\"in_person\",\"external\"` — must be one of: \"in_person\", \"external\".\n### `category_id`\n- **Description:** Category\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|uuid|exists:categories,uuid,is_active,\"1\",deleted_at,\"NULL\"`\n- `sometimes` — validated only when the field is present.\n- `uuid` — custom validation rule.\n- `exists:categories,uuid,is_active,\"1\",deleted_at,\"NULL\"` — must reference an existing record (categories, uuid, is_active, \"1\", deleted_at, \"NULL\").\n### `city_id`\n- **Description:** City\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|uuid|exists:cities,uuid,is_active,\"1\",deleted_at,\"NULL\"`\n- `sometimes` — validated only when the field is present.\n- `uuid` — custom validation rule.\n- `exists:cities,uuid,is_active,\"1\",deleted_at,\"NULL\"` — must reference an existing record (cities, uuid, is_active, \"1\", deleted_at, \"NULL\").\n### `name`\n- **Description:** Course title\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### `description`\n- **Description:** Description\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `sometimes|string|max:10000`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:10000` — must not exceed 10000.\n### `images`\n- **Description:** Course image\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"value\"]`\n- **Validation rules:** `sometimes|array|max:5`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `max:5` — must not exceed 5.\n### `images.*`\n- **Description:** Course image\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `string|distinct|custom:MediaExists`\n- `string` — must be text.\n- `distinct` — custom validation rule.\n- `custom:MediaExists` — custom validation rule.\n### `starts_on`\n- **Description:** Course date\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2024-01-01`\n- **Validation rules:** `sometimes|date_format:Y-m-d|after_or_equal:today`\n- `sometimes` — validated only when the field is present.\n- `date_format:Y-m-d` — custom validation rule.\n- `after_or_equal:today` — custom validation rule.\n### `start_time`\n- **Description:** Start time\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `2024-01-01`\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### `duration_minutes`\n- **Description:** Duration\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:15|max:1440`\n- `sometimes` — validated only when the field is present.\n- `integer` — must be a whole number.\n- `min:15` — must be at least 15.\n- `max:1440` — must not exceed 1440.\n### `is_free`\n- **Description:** Free course\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### `price`\n- **Description:** Price\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `nullable|numeric|min:0|max:9999999999.99|decimal:0,2`\n- `nullable` — may be null.\n- `numeric` — must be numeric.\n- `min:0` — must be at least .\n- `max:9999999999.99` — must not exceed 9999999999.99.\n- `decimal:0,2` — custom validation rule.\n### `seats`\n- **Description:** Seats\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:1|max:100000`\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:100000` — must not exceed 100000.\n### `sessions_count`\n- **Description:** Number of sessions\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:1|max:365`\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:365` — must not exceed 365.\n### `external_link`\n- **Description:** External link\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `https://example.com`\n- **Validation rules:** `nullable|url|max:1000`\n- `nullable` — may be null.\n- `url` — must be a valid URL.\n- `max:1000` — must not exceed 1000.\n### `access_instructions`\n- **Description:** Access instructions\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|nullable|string|max:5000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\n### `venue_name`\n- **Description:** Venue name\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example Name`\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### `venue_address`\n- **Description:** Venue address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|nullable|string|max:2000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:2000` — must not exceed 2000.\n### `venue_map_url`\n- **Description:** Venue location link\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `https://example.com`\n- **Validation rules:** `sometimes|nullable|url|max:1000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `url` — must be a valid URL.\n- `max:1000` — must not exceed 1000.\n### `venue_notes`\n- **Description:** Venue details\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|nullable|string|max:2000`\n- `sometimes` — validated only when the field is present.\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```", "body": { "mode": "raw", "raw": "{\n \"type\": \"value\",\n \"category_id\": \"00000000-0000-4000-8000-000000000001\",\n \"city_id\": \"00000000-0000-4000-8000-000000000001\",\n \"name\": \"Example Name\",\n \"description\": \"Example content text\",\n \"images\": [\n \"value\"\n ],\n \"starts_on\": \"2024-01-01\",\n \"start_time\": \"2024-01-01\",\n \"duration_minutes\": 1,\n \"is_free\": true,\n \"price\": 10,\n \"seats\": 1,\n \"sessions_count\": 1,\n \"external_link\": \"https://example.com\",\n \"access_instructions\": \"value\",\n \"venue_name\": \"Example Name\",\n \"venue_address\": \"value\",\n \"venue_map_url\": \"https://example.com\",\n \"venue_notes\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Submit", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/trainer/courses/:course/submit", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "trainer", "courses", ":course", "submit" ], "variable": [ { "key": "course", "value": "1", "description": "Course ID" } ] }, "description": "**Route:** `trainer.courses.submit`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:trainer, 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```", "body": { "mode": "raw", "raw": "{\n \"key\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Provider", "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/provider/auth/login", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "auth", "login" ] }, "description": "**Route:** `provider.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:** `value`\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### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\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\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"value\",\n \"password\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Forgot", "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/provider/auth/forgot-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "auth", "forgot-password" ] }, "description": "**Route:** `provider.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:** `value`\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\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "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/provider/auth/reset-password", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "auth", "reset-password" ] }, "description": "**Route:** `provider.auth.reset`\n**Middleware:** `api, set_locale, cors`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\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### `code`\n- **Description:** Verification Code\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|string|size:4`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:4` — custom validation rule.\n### `password`\n- **Description:** New Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\n- **Validation rules:** `required|string|min:8|max:72|confirmed`\n- `required` — must be provided.\n- `string` — must be text.\n- `min:8` — must be at least 8.\n- `max:72` — must not exceed 72.\n- `confirmed` — requires a matching *_confirmation field.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"token\": \"value\",\n \"code\": \"value\",\n \"password\": \"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}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/auth/logout", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "auth", "logout" ] }, "description": "**Route:** `provider.auth.logout`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, active`\n\n**Payload:**\nExample payload is included in the request body. No FormRequest validation rules were detected.\n### `device_token`\n- **Description:** Device token\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `fcm-token-here`\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```", "body": { "mode": "raw", "raw": "{\n \"device_token\": \"fcm-token-here\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "profile" ] }, "description": "**Route:** `provider.profile.show`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/profile", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "profile" ] }, "description": "**Route:** `provider.profile.update`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `entity_type`\n- **Description:** Entity type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|in:\"hotel\",\"exhibition_venue\",\"other\"`\n- `sometimes` — validated only when the field is present.\n- `in:\"hotel\",\"exhibition_venue\",\"other\"` — must be one of: \"hotel\", \"exhibition_venue\", \"other\".\n### `city_id`\n- **Description:** City\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|uuid|exists:cities,uuid,is_active,\"1\"`\n- `sometimes` — validated only when the field is present.\n- `uuid` — custom validation rule.\n- `exists:cities,uuid,is_active,\"1\"` — must reference an existing record (cities, uuid, is_active, \"1\").\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|nullable|string|max:1000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:1000` — must not exceed 1000.\n### `contact_phone`\n- **Description:** Contact phone\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `sometimes|nullable|string|max:30`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:30` — must not exceed 30.\n### `logo`\n- **Description:** Logo\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\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### `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:** `sometimes|nullable|string|max:2000`\n- `sometimes` — validated only when the field is present.\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:** `sometimes|nullable|string|max:2000`\n- `sometimes` — validated only when the field is present.\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```", "body": { "mode": "raw", "raw": "{\n \"entity_type\": \"value\",\n \"city_id\": \"00000000-0000-4000-8000-000000000001\",\n \"address\": \"value\",\n \"contact_phone\": \"1234567890\",\n \"logo\": \"value\",\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": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/hall-features?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "hall-features" ], "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:** `provider.hall-features.index`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, 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```" } }, { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/halls?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "halls" ], "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:** `provider.halls.index`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/halls", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "halls" ] }, "description": "**Route:** `provider.halls.store`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `city_id`\n- **Description:** City\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|uuid|exists:cities,uuid,is_active,\"1\"`\n- `sometimes` — validated only when the field is present.\n- `uuid` — custom validation rule.\n- `exists:cities,uuid,is_active,\"1\"` — must reference an existing record (cities, uuid, is_active, \"1\").\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|string|max:1000`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:1000` — must not exceed 1000.\n### `map_url`\n- **Description:** Map link\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `https://example.com`\n- **Validation rules:** `sometimes|nullable|url|max:1000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `url` — must be a valid URL.\n- `max:1000` — must not exceed 1000.\n### `capacity`\n- **Description:** Maximum capacity\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:1|max:100000`\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:100000` — must not exceed 100000.\n### `hourly_price`\n- **Description:** Base price per hour\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|min:0.01|max:9999999999.99|decimal:0,2`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `min:0.01` — must be at least 0.01.\n- `max:9999999999.99` — must not exceed 9999999999.99.\n- `decimal:0,2` — custom validation rule.\n### `photos`\n- **Description:** Photos\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"value\"]`\n- **Validation rules:** `sometimes|array|max:10`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `max:10` — must not exceed 10.\n### `photos.*`\n- **Description:** Photos item\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `string|distinct|custom:MediaExists`\n- `string` — must be text.\n- `distinct` — custom validation rule.\n- `custom:MediaExists` — custom validation rule.\n### `features`\n- **Description:** Features\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[{\"feature_id\":\"00000000-0000-4000-8000-000000000001\",\"price_per_slot\":10}]`\n- **Validation rules:** `sometimes|array|max:50`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `max:50` — must not exceed 50.\n### `features.*.feature_id`\n- **Description:** Feature\n- **Type:** `string`\n- **Required:** required\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `required|uuid|distinct`\n- `required` — must be provided.\n- `uuid` — custom validation rule.\n- `distinct` — custom validation rule.\n### `features.*.price_per_slot`\n- **Description:** Feature price\n- **Type:** `number`\n- **Required:** required\n- **Example:** `10`\n- **Validation rules:** `required|numeric|min:0.01|max:9999999999.99|decimal:0,2`\n- `required` — must be provided.\n- `numeric` — must be numeric.\n- `min:0.01` — must be at least 0.01.\n- `max:9999999999.99` — must not exceed 9999999999.99.\n- `decimal:0,2` — 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.description`\n- **Description:** Description (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `sometimes|nullable|string|max:5000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\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:** `sometimes|nullable|string|max:5000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"city_id\": \"00000000-0000-4000-8000-000000000001\",\n \"address\": \"value\",\n \"map_url\": \"https://example.com\",\n \"capacity\": 1,\n \"hourly_price\": 10,\n \"photos\": [\n \"value\"\n ],\n \"features\": [\n {\n \"feature_id\": \"00000000-0000-4000-8000-000000000001\",\n \"price_per_slot\": 10\n }\n ],\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 Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/halls/:hall", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "halls", ":hall" ], "variable": [ { "key": "hall", "value": "1", "description": "Hall ID" } ] }, "description": "**Route:** `provider.halls.show`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/halls/:hall", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "halls", ":hall" ], "variable": [ { "key": "hall", "value": "1", "description": "Hall ID" } ] }, "description": "**Route:** `provider.halls.update`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `city_id`\n- **Description:** City\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|uuid|exists:cities,uuid,is_active,\"1\"`\n- `sometimes` — validated only when the field is present.\n- `uuid` — custom validation rule.\n- `exists:cities,uuid,is_active,\"1\"` — must reference an existing record (cities, uuid, is_active, \"1\").\n### `address`\n- **Description:** Address\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `sometimes|string|max:1000`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:1000` — must not exceed 1000.\n### `map_url`\n- **Description:** Map link\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `https://example.com`\n- **Validation rules:** `sometimes|nullable|url|max:1000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `url` — must be a valid URL.\n- `max:1000` — must not exceed 1000.\n### `capacity`\n- **Description:** Maximum capacity\n- **Type:** `integer`\n- **Required:** optional\n- **Example:** `1`\n- **Validation rules:** `sometimes|integer|min:1|max:100000`\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:100000` — must not exceed 100000.\n### `hourly_price`\n- **Description:** Base price per hour\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|min:0.01|max:9999999999.99|decimal:0,2`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `min:0.01` — must be at least 0.01.\n- `max:9999999999.99` — must not exceed 9999999999.99.\n- `decimal:0,2` — custom validation rule.\n### `photos`\n- **Description:** Photos\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"value\"]`\n- **Validation rules:** `sometimes|array|max:10`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `max:10` — must not exceed 10.\n### `photos.*`\n- **Description:** Photos item\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `string|distinct|custom:MediaExists`\n- `string` — must be text.\n- `distinct` — custom validation rule.\n- `custom:MediaExists` — custom validation rule.\n### `features`\n- **Description:** Features\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[{\"feature_id\":\"00000000-0000-4000-8000-000000000001\",\"price_per_slot\":10}]`\n- **Validation rules:** `sometimes|array|max:50`\n- `sometimes` — validated only when the field is present.\n- `array` — must be an array.\n- `max:50` — must not exceed 50.\n### `features.*.feature_id`\n- **Description:** Feature\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|uuid|distinct`\n- `sometimes` — validated only when the field is present.\n- `uuid` — custom validation rule.\n- `distinct` — custom validation rule.\n### `features.*.price_per_slot`\n- **Description:** Feature price\n- **Type:** `number`\n- **Required:** optional\n- **Example:** `10`\n- **Validation rules:** `sometimes|numeric|min:0.01|max:9999999999.99|decimal:0,2`\n- `sometimes` — validated only when the field is present.\n- `numeric` — must be numeric.\n- `min:0.01` — must be at least 0.01.\n- `max:9999999999.99` — must not exceed 9999999999.99.\n- `decimal:0,2` — 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.description`\n- **Description:** Description (en)\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `Example content text`\n- **Validation rules:** `sometimes|nullable|string|max:5000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\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:** `sometimes|nullable|string|max:5000`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:5000` — must not exceed 5000.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"city_id\": \"00000000-0000-4000-8000-000000000001\",\n \"address\": \"value\",\n \"map_url\": \"https://example.com\",\n \"capacity\": 1,\n \"hourly_price\": 10,\n \"photos\": [\n \"value\"\n ],\n \"features\": [\n {\n \"feature_id\": \"00000000-0000-4000-8000-000000000001\",\n \"price_per_slot\": 10\n }\n ],\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": "Status", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/halls/:hall/status", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "halls", ":hall", "status" ], "variable": [ { "key": "hall", "value": "1", "description": "Hall ID" } ] }, "description": "**Route:** `provider.halls.status`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `status`\n- **Description:** Status\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\n- **Validation rules:** `required|in:\"active\",\"inactive\"`\n- `required` — must be provided.\n- `in:\"active\",\"inactive\"` — must be one of: \"active\", \"inactive\".\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"status\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/halls/:hall/availability?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "halls", ":hall", "availability" ], "variable": [ { "key": "hall", "value": "1", "description": "Hall 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:** `provider.halls.availability.index`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/halls/:hall/availability", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "halls", ":hall", "availability" ], "variable": [ { "key": "hall", "value": "1", "description": "Hall ID" } ] }, "description": "**Route:** `provider.halls.availability.store`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `starts_at`\n- **Description:** Start time\n- **Type:** `string`\n- **Required:** required\n- **Example:** `2024-01-01`\n- **Validation rules:** `required|date_format:Y-m-d H:i|after:now`\n- `required` — must be provided.\n- `date_format:Y-m-d H:i` — custom validation rule.\n- `after:now` — custom validation rule.\n### `ends_at`\n- **Description:** End time\n- **Type:** `string`\n- **Required:** required\n- **Example:** `2024-01-01`\n- **Validation rules:** `required|date_format:Y-m-d H:i|after:starts_at`\n- `required` — must be provided.\n- `date_format:Y-m-d H:i` — custom validation rule.\n- `after:starts_at` — custom validation rule.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"starts_at\": \"2024-01-01\",\n \"ends_at\": \"2024-01-01\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/provider/halls/:hall/availability/:period", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "provider", "halls", ":hall", "availability", ":period" ], "variable": [ { "key": "hall", "value": "1", "description": "Hall ID" }, { "key": "period", "value": "1", "description": "Period ID" } ] }, "description": "**Route:** `provider.halls.availability.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\SurfaceAccount:provider, 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```" } } ] } ] }, { "name": "System", "item": [ { "name": "Health", "item": [ { "name": "List All", "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", "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": "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/faqs?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "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 } ] }, "description": "**Route:** `shared.content.faqs`\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": "Pages", "item": [ { "name": "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/pages/:type", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "pages", ":type" ], "variable": [ { "key": "type", "value": "1", "description": "Type ID" } ] }, "description": "**Route:** `shared.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", "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/sliders?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "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:** `shared.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", "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/countries?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "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 } ] }, "description": "**Route:** `shared.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\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] }, { "name": "Communication", "item": [ { "name": "Notifications", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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```" } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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```" } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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```" } }, { "name": "Mark All Read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, active`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } }, { "name": "Clear All", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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```" } } ] } ] } ] }, { "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`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `login`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** required\n- **Example:** `user@example.com`\n- **Validation rules:** `required|string|email`\n- `required` — must be provided.\n- `string` — must be text.\n- `email` — must be a valid email address.\n### `password`\n- **Description:** Password\n- **Type:** `string`\n- **Required:** required\n- **Example:** `Password123!`\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\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"user@example.com\",\n \"password\": \"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}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, active`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `device_token`\n- **Description:** Device Token\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```", "body": { "mode": "raw", "raw": "{\n \"device_token\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Refresh", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/auth/refresh", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "auth", "refresh" ] }, "description": "**Route:** `admin.auth.refresh`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\AdminAccount, active`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Profile", "item": [ { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:100`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:100` — must not exceed 100.\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\",id`\n- `sometimes` — validated only when the field is present.\n- `email` — must be a valid email address.\n- `unique:users,email,\"1\",id` — must be unique (users, email, \"1\", id).\n### `phone`\n- **Description:** 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### `phone_code`\n- **Description:** Phone code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\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### `gender`\n- **Description:** Gender\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\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:** `2024-01-01`\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:** `value`\n- **Validation rules:** `nullable|string|max:10`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:10` — must not exceed 10.\n### `avatar`\n- **Description:** Avatar\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```", "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"phone_code\": \"1234567890\",\n \"gender\": \"value\",\n \"birth_date\": \"2024-01-01\",\n \"locale\": \"value\",\n \"avatar\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Change Password", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```", "body": { "mode": "raw", "raw": "{\n \"current_password\": \"Password123!\",\n \"password\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Communication", "item": [ { "name": "Notifications", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `value`\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:** `value`\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```", "body": { "mode": "raw", "raw": "{\n \"title\": \"Example Title\",\n \"body\": \"value\",\n \"target\": \"value\",\n \"user_ids\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Contact messages", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/contact-messages?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[status]=new", "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[status]", "value": "new", "description": "Filter by status: new, reviewed or closed", "disabled": true } ] }, "description": "**Route:** `admin.contact-messages.index`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\AdminAccount, 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: new, reviewed or closed (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Reply", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `value`\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```", "body": { "mode": "raw", "raw": "{\n \"reply\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } } ] } ] }, { "name": "System", "item": [ { "name": "Settings", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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|string`\n- `nullable` — may be null.\n- `string` — must be text.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "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", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `value`\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```", "body": { "mode": "raw", "raw": "{\n \"key\": \"value\",\n \"is_enabled\": true,\n \"targeting_rules\": [],\n \"description\": \"Example content text\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `value`\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```", "body": { "mode": "raw", "raw": "{\n \"key\": \"value\",\n \"is_enabled\": true,\n \"targeting_rules\": [],\n \"description\": \"Example content text\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Toggle Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Audit logs", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } } ] }, { "name": "Dashboard", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } } ] } ] }, { "name": "Content", "item": [ { "name": "Faqs", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `value`\n- **Validation rules:** `sometimes|string`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\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```", "body": { "mode": "raw", "raw": "{\n \"is_active\": true,\n \"type\": \"value\",\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 Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `value`\n- **Validation rules:** `sometimes|string`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\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```", "body": { "mode": "raw", "raw": "{\n \"is_active\": true,\n \"type\": \"value\",\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", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } } ] }, { "name": "Pages", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `value`\n- **Validation rules:** `required|in:\"terms\",\"privacy\",\"about\",\"about_us\",\"privacy_policy\",\"warranty_policy\",\"return_policy\",\"shipping_policy\"`\n- `required` — must be provided.\n- `in:\"terms\",\"privacy\",\"about\",\"about_us\",\"privacy_policy\",\"warranty_policy\",\"return_policy\",\"shipping_policy\"` — must be one of: \"terms\", \"privacy\", \"about\", \"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```", "body": { "mode": "raw", "raw": "{\n \"type\": \"value\",\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 Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `value`\n- **Validation rules:** `sometimes|in:\"terms\",\"privacy\",\"about\",\"about_us\",\"privacy_policy\",\"warranty_policy\",\"return_policy\",\"shipping_policy\"`\n- `sometimes` — validated only when the field is present.\n- `in:\"terms\",\"privacy\",\"about\",\"about_us\",\"privacy_policy\",\"warranty_policy\",\"return_policy\",\"shipping_policy\"` — must be one of: \"terms\", \"privacy\", \"about\", \"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```", "body": { "mode": "raw", "raw": "{\n \"type\": \"value\",\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", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } } ] }, { "name": "Sliders", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\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: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```", "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 Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:255`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:255` — must not exceed 255.\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: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```", "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", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } } ] }, { "name": "Categories", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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### `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### `icon`\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.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```", "body": { "mode": "raw", "raw": "{\n \"is_active\": true,\n \"sort_order\": 1,\n \"icon\": \"value\",\n \"en\": {\n \"name\": \"Example Name\"\n },\n \"ar\": {\n \"name\": \"Example Name\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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### `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### `icon`\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.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```", "body": { "mode": "raw", "raw": "{\n \"is_active\": true,\n \"sort_order\": 1,\n \"icon\": \"value\",\n \"en\": {\n \"name\": \"Example Name\"\n },\n \"ar\": {\n \"name\": \"Example Name\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } } ] } ] }, { "name": "Geo", "item": [ { "name": "Cities", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/cities?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[country_id]=", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "cities" ], "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[country_id]", "value": "", "description": "Filter by country UUID", "disabled": true } ] }, "description": "**Route:** `admin.cities.index`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\AdminAccount, 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[country_id]` — Filter by country UUID (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/cities", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "cities" ] }, "description": "**Route:** `admin.cities.store`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\AdminAccount, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `country_id`\n- **Description:** Country\n- **Type:** `string`\n- **Required:** required\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `required|uuid|exists:countries,uuid`\n- `required` — must be provided.\n- `uuid` — custom validation rule.\n- `exists:countries,uuid` — must reference an existing record (countries, uuid).\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:** `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### `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```", "body": { "mode": "raw", "raw": "{\n \"country_id\": \"00000000-0000-4000-8000-000000000001\",\n \"is_active\": true,\n \"sort_order\": 1,\n \"en\": {\n \"name\": \"Example Name\"\n },\n \"ar\": {\n \"name\": \"Example Name\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/cities/:city", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "cities", ":city" ], "variable": [ { "key": "city", "value": "1", "description": "City ID" } ] }, "description": "**Route:** `admin.cities.show`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/cities/:city", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "cities", ":city" ], "variable": [ { "key": "city", "value": "1", "description": "City ID" } ] }, "description": "**Route:** `admin.cities.update`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\AdminAccount, active, rbac.auto`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `country_id`\n- **Description:** Country\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|uuid|exists:countries,uuid`\n- `sometimes` — validated only when the field is present.\n- `uuid` — custom validation rule.\n- `exists:countries,uuid` — must reference an existing record (countries, uuid).\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:** `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### `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```", "body": { "mode": "raw", "raw": "{\n \"country_id\": \"00000000-0000-4000-8000-000000000001\",\n \"is_active\": true,\n \"sort_order\": 1,\n \"en\": {\n \"name\": \"Example Name\"\n },\n \"ar\": {\n \"name\": \"Example Name\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/cities/:city", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "cities", ":city" ], "variable": [ { "key": "city", "value": "1", "description": "City ID" } ] }, "description": "**Route:** `admin.cities.destroy`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\AdminAccount, 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```" } } ] }, { "name": "Countries", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/countries?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1", "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 } ] }, "description": "**Route:** `admin.countries.index`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `1234567890`\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:5`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\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.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.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```", "body": { "mode": "raw", "raw": "{\n \"phone_code\": \"1234567890\",\n \"phone_starting_number\": \"1234567890\",\n \"phone_length\": 1,\n \"short_name\": \"Example Name\",\n \"is_active\": true,\n \"flag\": \"value\",\n \"en\": {\n \"name\": \"Example Name\",\n \"nationality\": \"Egyptian\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"nationality\": \"Egyptian\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `1234567890`\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:5`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\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.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.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```", "body": { "mode": "raw", "raw": "{\n \"phone_code\": \"1234567890\",\n \"phone_starting_number\": \"1234567890\",\n \"phone_length\": 1,\n \"short_name\": \"Example Name\",\n \"is_active\": true,\n \"flag\": \"value\",\n \"en\": {\n \"name\": \"Example Name\",\n \"nationality\": \"Egyptian\"\n },\n \"ar\": {\n \"name\": \"Example Name\",\n \"nationality\": \"Egyptian\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } } ] } ] }, { "name": "Access", "item": [ { "name": "Users", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&filters[is_active]=1&filters[user_type]=client&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[is_active]", "value": "1", "description": "Filter by active status", "disabled": true }, { "key": "filters[user_type]", "value": "client", "description": "Filter by user type", "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, App\\Http\\Middleware\\AdminAccount, 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[user_type]` — Filter by user type (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```" } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/admin/users/:id", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "admin", "users", ":id" ], "variable": [ { "key": "id", "value": "1", "description": "Id ID" } ] }, "description": "**Route:** `admin.users.view`\n**Middleware:** `api, set_locale, cors, auth:api, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Toggle Status", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Roles", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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|not_in:\"super_admin\"|unique:roles,slug,NULL,id`\n- `required` — must be provided.\n- `string` — must be text.\n- `max:50` — must not exceed 50.\n- `not_in:\"super_admin\"` — custom validation rule.\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### `permissions`\n- **Description:** Permissions\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"00000000-0000-4000-8000-000000000001\"]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `permissions.*`\n- **Description:** Permission\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `uuid|exists:permissions,uuid`\n- `uuid` — custom validation rule.\n- `exists:permissions,uuid` — must reference an existing record (permissions, uuid).\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```", "body": { "mode": "raw", "raw": "{\n \"slug\": \"example-slug\",\n \"is_active\": true,\n \"permissions\": [\n \"00000000-0000-4000-8000-000000000001\"\n ],\n \"en\": {\n \"name\": \"Example Name\"\n },\n \"ar\": {\n \"name\": \"Example Name\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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|not_in:\"super_admin\"|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- `not_in:\"super_admin\"` — custom validation rule.\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### `permissions`\n- **Description:** Permissions\n- **Type:** `array`\n- **Required:** optional\n- **Example:** `[\"00000000-0000-4000-8000-000000000001\"]`\n- **Validation rules:** `nullable|array`\n- `nullable` — may be null.\n- `array` — must be an array.\n### `permissions.*`\n- **Description:** Permission\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `uuid|exists:permissions,uuid`\n- `uuid` — custom validation rule.\n- `exists:permissions,uuid` — must reference an existing record (permissions, uuid).\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```", "body": { "mode": "raw", "raw": "{\n \"slug\": \"example-slug\",\n \"is_active\": true,\n \"permissions\": [\n \"00000000-0000-4000-8000-000000000001\"\n ],\n \"en\": {\n \"name\": \"Example Name\"\n },\n \"ar\": {\n \"name\": \"Example Name\"\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } } ] }, { "name": "Permissions", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } } ] }, { "name": "Supervisors", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Create New", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|nullable|uuid|exists:roles,uuid`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `uuid` — custom validation rule.\n- `exists:roles,uuid` — must reference an existing record (roles, uuid).\n### `user_type`\n- **Description:** User type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `prohibited`\n- `prohibited` — custom validation rule.\n### `avatar`\n- **Description:** Avatar\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```", "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\": \"00000000-0000-4000-8000-000000000001\",\n \"user_type\": \"value\",\n \"avatar\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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:** `string`\n- **Required:** optional\n- **Example:** `00000000-0000-4000-8000-000000000001`\n- **Validation rules:** `sometimes|nullable|uuid|exists:roles,uuid`\n- `sometimes` — validated only when the field is present.\n- `nullable` — may be null.\n- `uuid` — custom validation rule.\n- `exists:roles,uuid` — must reference an existing record (roles, uuid).\n### `user_type`\n- **Description:** User type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `prohibited`\n- `prohibited` — custom validation rule.\n### `avatar`\n- **Description:** Avatar\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```", "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\": \"00000000-0000-4000-8000-000000000001\",\n \"user_type\": \"value\",\n \"avatar\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, App\\Http\\Middleware\\AdminAccount, 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```" } } ] } ] } ] }, { "name": "Client", "item": [ { "name": "Account", "item": [ { "name": "Auth", "item": [ { "name": "Logout", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `device_token`\n- **Description:** Device Token\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```", "body": { "mode": "raw", "raw": "{\n \"device_token\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Refresh", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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`\n\n**Payload:**\nNo fields. Send an empty JSON object `{}`.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "[]", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Profile", "item": [ { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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### `email`\n- **Description:** Email\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `user@example.com`\n- **Validation rules:** `sometimes|email|unique:users,email,\"1\",id`\n- `sometimes` — validated only when the field is present.\n- `email` — must be a valid email address.\n- `unique:users,email,\"1\",id` — must be unique (users, email, \"1\", id).\n### `phone_code`\n- **Description:** Phone code\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `1234567890`\n- **Validation rules:** `sometimes|string|max:5`\n- `sometimes` — validated only when the field is present.\n- `string` — must be text.\n- `max:5` — must not exceed 5.\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### `gender`\n- **Description:** Gender\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\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:** `2024-01-01`\n- **Validation rules:** `sometimes|date|before:today`\n- `sometimes` — validated only when the field is present.\n- `date` — must be a valid date.\n- `before:today` — custom validation rule.\n### `locale`\n- **Description:** Locale\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|string|max:10`\n- `nullable` — may be null.\n- `string` — must be text.\n- `max:10` — must not exceed 10.\n### `avatar`\n- **Description:** Avatar\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```", "body": { "mode": "raw", "raw": "{\n \"full_name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone_code\": \"1234567890\",\n \"phone\": \"1234567890\",\n \"gender\": \"value\",\n \"birth_date\": \"2024-01-01\",\n \"locale\": \"value\",\n \"avatar\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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```" } } ] } ] }, { "name": "System", "item": [ { "name": "Settings", "item": [ { "name": "Show Details", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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```" } }, { "name": "Update", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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:** `value`\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```", "body": { "mode": "raw", "raw": "{\n \"allow_notifications\": true,\n \"locale\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Communication", "item": [ { "name": "Notifications", "item": [ { "name": "List All", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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```" } }, { "name": "Read", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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-4000-8000-000000000001\"]`\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-4000-8000-000000000001`\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```", "body": { "mode": "raw", "raw": "{\n \"ids\": [\n \"00000000-0000-4000-8000-000000000001\"\n ],\n \"all\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Preferences", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, 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```", "body": { "mode": "raw", "raw": "{\n \"allow_notifications\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Device", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "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, active, geo.context`\n\n**Payload:**\nSend as `application/json`.\n\n**Field documentation:**\n### `device_token`\n- **Description:** Device Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\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:** `value`\n- **Validation rules:** `required|in:ios,android,huawei,web`\n- `required` — must be provided.\n- `in:ios,android,huawei,web` — must be one of: ios, android, huawei, web.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"device_token\": \"value\",\n \"device_type\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Search", "item": [ { "name": "Search", "item": [ { "name": "Suggestions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/search/suggestions?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&q=iph&limit=10", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "search", "suggestions" ], "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": "q", "value": "iph", "description": "Search prefix for autocomplete", "disabled": false }, { "key": "limit", "value": "10", "description": "Max suggestions to return", "disabled": true } ] }, "description": "**Route:** `client.search.suggestions`\n**Middleware:** `api, set_locale, cors, auth:api, 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- `q` — Search prefix for autocomplete (supported)\n- `limit` — Max suggestions to return (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } }, { "name": "Recent", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/search/recent?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&limit=10", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "search", "recent" ], "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": "limit", "value": "10", "description": "Max recent searches to return", "disabled": true } ] }, "description": "**Route:** `client.search.recent`\n**Middleware:** `api, set_locale, cors, auth:api, 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- `limit` — Max recent searches to return (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } }, { "name": "Trending", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/search/trending?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&limit=10&days=7", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "search", "trending" ], "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": "limit", "value": "10", "description": "Max results to return", "disabled": true }, { "key": "days", "value": "7", "description": "Time window in days", "disabled": true } ] }, "description": "**Route:** `client.search.trending`\n**Middleware:** `api, set_locale, cors, auth:api, 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- `limit` — Max results to return (optional)\n- `days` — Time window in days (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } }, { "name": "Popular", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept-Language", "value": "{{locale}}" }, { "key": "Authorization", "value": "Bearer {{token}}" } ], "url": { "raw": "{{base_url}}/api/v1/client/search/popular?page=1&per_page=15&search=&sort[created_at]=desc&paginate=false&limit=10&days=7", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "search", "popular" ], "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": "limit", "value": "10", "description": "Max results to return", "disabled": true }, { "key": "days", "value": "7", "description": "Time window in days", "disabled": true } ] }, "description": "**Route:** `client.search.popular`\n**Middleware:** `api, set_locale, cors, auth:api, 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- `limit` — Max results to return (optional)\n- `days` — Time window in days (optional)\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```" } } ] } ] } ] }, { "name": "Guest", "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:** `value`\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:** `Password123!`\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_token`\n- **Description:** Device Token\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### `device_type`\n- **Description:** Device Type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|in:ios,android,huawei,web`\n- `nullable` — may be null.\n- `in:ios,android,huawei,web` — must be one of: ios, android, huawei, web.\n\n**Response Format:**\n```json\n{ \"status\": \"success\", \"message\": \"...\", \"data\": {...} }\n```", "body": { "mode": "raw", "raw": "{\n \"login\": \"value\",\n \"password\": \"Password123!\",\n \"device_token\": \"value\",\n \"device_type\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "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/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: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:** 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:** `1234567890`\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:** `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### `device_type`\n- **Description:** Device type\n- **Type:** `string`\n- **Required:** optional\n- **Example:** `value`\n- **Validation rules:** `nullable|in:ios,android,huawei,web`\n- `nullable` — may be null.\n- `in:ios,android,huawei,web` — must be one of: ios, android, huawei, web.\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\": \"1234567890\",\n \"password\": \"Password123!\",\n \"device_token\": \"value\",\n \"device_type\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Verify", "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:** `value`\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:** `value`\n- **Validation rules:** `required|string|size:4`\n- `required` — must be provided.\n- `string` — must be text.\n- `size:4` — custom validation rule.\n### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\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\": \"value\",\n \"code\": \"value\",\n \"token\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Resend", "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### `login`\n- **Description:** Email or Phone\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\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:** optional\n- **Example:** `value`\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```", "body": { "mode": "raw", "raw": "{\n \"login\": \"value\",\n \"token\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Forgot", "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:** `value`\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\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "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/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### `token`\n- **Description:** Token\n- **Type:** `string`\n- **Required:** required\n- **Example:** `value`\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 \"token\": \"value\",\n \"password\": \"Password123!\",\n \"password_confirmation\": \"Password123!\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "Media", "item": [ { "name": "Upload", "item": [ { "name": "Upload", "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|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### `type`\n- **Description:** File Type\n- **Type:** `file`\n- **Required:** optional\n- **Example:** `value`\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|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": "type", "type": "text", "src": "value", "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", "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:** `value`\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:** `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```", "body": { "mode": "raw", "raw": "{\n \"name\": \"Example Name\",\n \"email\": \"user@example.com\",\n \"phone\": \"1234567890\",\n \"subject\": \"value\",\n \"message\": \"value\"\n}", "options": { "raw": { "language": "json" } } } } } ] } ] }, { "name": "General", "item": [ { "name": "Trainers", "item": [ { "name": "Show 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/trainers/:trainer", "host": [ "{{base_url}}" ], "path": [ "api", "v1", "client", "trainers", ":trainer" ], "variable": [ { "key": "trainer", "value": "1", "description": "Trainer ID" } ] }, "description": "**Route:** `client.trainers.show`\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```" } } ] } ] } ] } ] }