{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "http:\/\/127.0.0.1:8000" } ], "info": { "name": "Taskify API Documentation", "_postman_id": "fec25a0a-7a9b-4db1-912b-d46e7253708c", "description": "This is the API documentation for the taskify.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Endpoints", "description": "", "item": [ { "name": "Update FCM Token.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user\/fcm-token", "query": [], "raw": "{{baseUrl}}\/api\/user\/fcm-token" }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"fcm_token\":\"dXkJz7KYZ9o:APA91bGfLa_qwAeD...\"}" }, "description": "This endpoint allows an authenticated user or client to update their FCM token for push notifications.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"FCM token updated successfully.\"\n}", "name": "" } ] }, { "name": "GET api\/leave-requests\/get-calendar-data", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/leave-requests\/get-calendar-data", "query": [], "raw": "{{baseUrl}}\/api\/leave-requests\/get-calendar-data" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"error\":false,\"message\":\"Unauthorized\"}", "name": "" } ] }, { "name": "GET api\/estimates-invoices\/pdf\/{id}", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/estimates-invoices\/pdf\/:id", "query": [], "raw": "{{baseUrl}}\/api\/estimates-invoices\/pdf\/:id", "variable": [ { "id": "id", "key": "id", "value": "rerum", "description": "The ID of the pdf." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"error\":false,\"message\":\"Unauthorized\"}", "name": "" } ] } ] }, { "name": "User Authentication", "description": "", "item": [ { "name": "Register a new user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/signup", "query": [], "raw": "{{baseUrl}}\/api\/users\/signup" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"member\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"john.doe@example.com\",\"password\":\"password123\",\"password_confirmation\":\"password123\",\"company\":\"Acme Inc.\",\"fcm_token\":\"cXJ1AqT6B...\"}" }, "description": "This endpoint allows a new user to sign up by providing necessary details.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Account created successfully.\",\n\"data\": {\n\"id\": 225,\n\"first_name\": \"Test\",\n\"last_name\": \"User\",\n\"role\": \"admin\",\n\"email\": \"test.user@example.com\",\n\"phone\": null,\n\"dob\": null,\n\"doj\": null,\n\"address\": null,\n\"city\": null,\n\"state\": null,\n\"country\": null,\n\"zip\": null,\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\",\n\"status\": 0,\n\"created_at\": \"13-08-2024 14:59:38\",\n\"updated_at\": \"13-08-2024 14:59:38\"\n\"assigned\": {\n\"projects\": 0,\n\"tasks\": 0\n}\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"email\": [\"The email field is required.\", \"The email has already been taken.\"],\n \"password\": [\"The password must be at least 6 characters.\"],\n \"role\": [\"The role field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Account couldn't be created, please contact the admin for assistance.\"\n}", "name": "" } ] }, { "name": "Log in an existing user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/login", "query": [], "raw": "{{baseUrl}}\/api\/users\/login" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john.doe@example.com\",\"password\":\"password123\",\"fcm_token\":\"cXJ1AqT6B...\"}" }, "description": "This endpoint allows a user to log in by providing their email and password. Upon successful authentication, a token is returned for accessing protected resources.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Logged in successfully.\",\n \"token\": \"15|ANl9HwfqiiUxdOmNWba5qKhzfk3h1fyi8ZUoYbH8de8d3534\",\n \"data\": {\n \"user_id\": 7,\n \"workspace_id\": 6,\n \"my_locale\": \"en\",\n \"locale\": \"en\"\n }\n}", "name": "" }, { "header": [], "code": 401, "body": "{\n \"error\": true,\n \"message\": \"Unauthorized\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"email\": [\"The email field is required.\"],\n \"password\": [\"The password field is required.\"]\n }\n}", "name": "" } ] }, { "name": "Send Password Reset Link.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/password\/reset-request", "query": [], "raw": "{{baseUrl}}\/api\/password\/reset-request" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"john.doe@example.com\",\"account_type\":\"user\"}" }, "description": "This endpoint allows a user or client to request a password reset link by providing their email and account type.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Password reset link emailed successfully.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n\"error\": true,\n\"message\": \"Account not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Password reset link couldn't be sent, please check email settings.\"\n}", "name": "" } ] }, { "name": "Reset Password.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/password\/reset", "query": [], "raw": "{{baseUrl}}\/api\/password\/reset" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"token\":\"abc123\",\"email\":\"john.doe@example.com\",\"password\":\"newPassword123\",\"password_confirmation\":\"newPassword123\",\"account_type\":\"user\"}" }, "description": "This endpoint allows a user or client to reset their password using a valid token.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Password has been reset successfully.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n\"error\": true,\n\"message\": \"Account not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Password reset failed. Please try again later.\"\n}", "name": "" } ] } ] }, { "name": "Profile Management", "description": "", "item": [ { "name": "Retrieve the authenticated user's profile.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/user", "query": [], "raw": "{{baseUrl}}\/api\/user" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint returns the profile information of the currently authenticated user. The user must be authenticated to access their profile details." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Profile details retrieved successfully\",\n\"data\": {\n\"id\": 7,\n\"first_name\": \"Madhavan\",\n\"last_name\": \"Vaidya\",\n\"role\": \"admin\",\n\"email\": \"admin@gmail.com\",\n\"phone\": \"9099882203\",\n\"dob\": \"17-06-2024\",\n\"doj\": \"03-10-2022\",\n\"address\": \"Devonshire\",\n\"city\": \"Windsor\",\n\"state\": \"ON\",\n\"country\": \"Canada\",\n\"zip\": \"123654\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\",\n\"status\": 1,\n\"created_at\": \"03-01-2023 10:37:20\",\n\"updated_at\": \"13-08-2024 14:16:45\",\n\"assigned\": {\n\"projects\": 11,\n\"tasks\": 9\n},\n\"is_admin_or_leave_editor\": true,\n\"is_admin_or_has_all_data_access\": true\n}\n}", "name": "" } ] }, { "name": "Update the profile picture of a logged-in user or a specified user\/client.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/photo", "query": [], "raw": "{{baseUrl}}\/api\/users\/photo" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "multipart\/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": 1, "type": "text", "description": "The ID of the user or client whose profile picture is being updated. Required if `type` is provided." }, { "key": "type", "value": "user", "type": "text", "description": "The type of the entity whose profile picture is being updated. Must be either 'user' or 'client'." }, { "key": "upload", "src": [], "type": "file" } ] }, "description": "This endpoint allows the authenticated user to update their profile picture.\nIf both `id` and `type` are provided, the profile picture for the specified user or client will be updated.\nIf not, the profile picture of the logged-in user will be updated." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Profile picture updated successfully.\",\n \"data\": {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"role\": \"admin\",\n \"email\": \"admin@gmail.com\",\n \"phone\": \"9099882203\",\n \"dob\": \"17-06-2024\",\n \"doj\": \"03-10-2022\",\n \"address\": \"Devonshire\",\n \"city\": \"Windsor\",\n \"state\": \"ON\",\n \"country\": \"Canada\",\n \"zip\": \"123654\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/atEj9NKCeAJhM5VqBN69mFKHntHbZkPUl2Sa22RA.webp\",\n \"status\": 1,\n \"created_at\": \"03-01-2023 10:37:20\",\n \"updated_at\": \"13-08-2024 18:58:34\",\n \"assigned\": {\n \"projects\": 11,\n \"tasks\": 21\n }\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"No profile picture selected!\"\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"User not found\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Profile picture couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Update the profile details of a logged-in user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:id\/profile", "query": [], "raw": "{{baseUrl}}\/api\/users\/:id\/profile", "variable": [ { "id": "id", "key": "id", "value": "6", "description": "The ID of the user whose profile is being updated." } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"first_name\":\"Madhavan\",\"last_name\":\"Vaidya\",\"email\":\"admin@gmail.com\",\"role\":1,\"phone\":\"9099882203\",\"country_code\":\"+91\",\"country_iso_code\":\"in\",\"dob\":\"17-06-2024\",\"doj\":\"03-10-2022\",\"address\":\"Devonshire\",\"city\":\"Windsor\",\"state\":\"ON\",\"country\":\"Canada\",\"zip\":\"123654\",\"password\":\"12345678\",\"password_confirmation\":\"12345678\"}" }, "description": "This endpoint allows the authenticated user to update their profile details such as name, email, address, and other relevant information." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Profile details updated successfully.\",\n \"data\": {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"role\": \"admin\",\n \"email\": \"admin@gmail.com\",\n \"phone\": \"9099882203\",\n \"dob\": \"17-06-2024\",\n \"doj\": \"03-10-2022\",\n \"address\": \"Devonshire\",\n \"city\": \"Windsor\",\n \"state\": \"ON\",\n \"country\": \"Canada\",\n \"zip\": \"123654\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/atEj9NKCeAJhM5VqBN69mFKHntHbZkPUl2Sa22RA.webp\",\n \"status\": 1,\n \"created_at\": \"03-01-2023 10:37:20\",\n \"updated_at\": \"13-08-2024 18:58:34\",\n \"assigned\": {\n \"projects\": 11,\n \"tasks\": 21\n }\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Validation error: The email has already been taken.\"\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"User not found\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Profile details couldn\\'t be updated.\"\n}", "name": "" } ] }, { "name": "Delete account of a logged-in user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/account\/destroy", "query": [], "raw": "{{baseUrl}}\/api\/account\/destroy" }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint allows the authenticated user to delete their account." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Account deleted successfully.\"\n \"data\": []\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"User not found\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Account couldn't be deleted.\"\n}", "name": "" } ] } ] }, { "name": "Dashboard Management", "description": "", "item": [ { "name": "List or search users with birthdays today or upcoming.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/upcoming-birthdays", "query": [ { "key": "search", "value": "John", "description": "Optional. The search term to filter users by first name or last name or combination of first name and last name or User ID or date of birth.", "disabled": false }, { "key": "order", "value": "DESC", "description": "Optional. The sort order for the `dob` column. Acceptable values are `ASC` or `DESC`. Default is `ASC`.", "disabled": false }, { "key": "upcoming_days", "value": "15", "description": "Optional. The number of days from today to consider for upcoming birthdays. Default is 30.", "disabled": false }, { "key": "user_ids[0]", "value": 123, "description": "Optional. The specific user IDs to filter the results.", "disabled": false }, { "key": "user_ids[1]", "value": 456, "description": "Optional. The specific user IDs to filter the results.", "disabled": false }, { "key": "limit", "value": "10", "description": "Optional. The number of results to return per page. Default is 15.", "disabled": false }, { "key": "offset", "value": "5", "description": "Optional. The number of results to skip before starting to collect the result set. Default is 0.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/upcoming-birthdays?search=John&order=DESC&upcoming_days=15&user_ids[0]=123&user_ids[1]=456&limit=10&offset=5" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of users with birthdays occurring today or within a specified range of days. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Upcoming birthdays retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"member\": \"John Doe\",\n \"photo\": \"http:\/\/example.com\/storage\/photos\/john_doe.jpg\",\n \"birthday_count\": 30,\n \"days_left\": 10,\n \"dob\": \"Tue, 2024-08-08\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Upcoming birthdays not found.\",\n \"data\": []\n}", "name": "" } ] }, { "name": "List or search users with work anniversaries today or upcoming.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/upcoming-work-anniversaries", "query": [ { "key": "search", "value": "John", "description": "Optional. The search term to filter users by first name or last name or combination of first name and last name or User ID or date of joining.", "disabled": false }, { "key": "order", "value": "DESC", "description": "Optional. The sort order for the `doj` column. Acceptable values are `ASC` or `DESC`. Default is `ASC`.", "disabled": false }, { "key": "upcoming_days", "value": "15", "description": "Optional. The number of days from today to consider for upcoming work anniversaries. Default is 30.", "disabled": false }, { "key": "user_ids[0]", "value": 123, "description": "Optional. The specific user IDs to filter the results.", "disabled": false }, { "key": "user_ids[1]", "value": 456, "description": "Optional. The specific user IDs to filter the results.", "disabled": false }, { "key": "limit", "value": "10", "description": "Optional. The number of results to return per page. Default is 15.", "disabled": false }, { "key": "offset", "value": "5", "description": "Optional. The number of results to skip before starting to collect the result set. Default is 0.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/upcoming-work-anniversaries?search=John&order=DESC&upcoming_days=15&user_ids[0]=123&user_ids[1]=456&limit=10&offset=5" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of users with work anniversaries occurring today or within a specified range of days. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Upcoming work anniversaries retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"member\": \"John Doe\",\n \"photo\": \"http:\/\/example.com\/storage\/photos\/john_doe.jpg\",\n \"anniversary_count\": 5,\n \"days_left\": 10,\n \"doj\": \"Tue, 2024-08-08\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Upcoming work anniversaries not found.\",\n \"data\": []\n}", "name": "" } ] }, { "name": "List members currently on leave or scheduled to be on leave.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/members-on-leave", "query": [ { "key": "search", "value": "John", "description": "Optional. The search term to filter users by first name or last name or combination of first name and last name or User ID or date of joining.", "disabled": false }, { "key": "sort", "value": "to_date", "description": "Optional. The field to sort by. Acceptable values are `from_date` and `to_date`. Default is `from_date`.", "disabled": false }, { "key": "order", "value": "DESC", "description": "Optional. The sort order. Acceptable values are `ASC` or `DESC`. Default is `ASC`.", "disabled": false }, { "key": "upcoming_days", "value": "15", "description": "Optional. The number of days from today to consider for upcoming leave. Default is 30.", "disabled": false }, { "key": "user_ids[0]", "value": 123, "description": "Optional. The specific user IDs to filter the results.", "disabled": false }, { "key": "user_ids[1]", "value": 456, "description": "Optional. The specific user IDs to filter the results.", "disabled": false }, { "key": "limit", "value": "10", "description": "Optional. The number of results to return per page. Default is 15.", "disabled": false }, { "key": "offset", "value": "5", "description": "Optional. The number of results to skip before starting to collect the result set. Default is 0.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/members-on-leave?search=John&sort=to_date&order=DESC&upcoming_days=15&user_ids[0]=123&user_ids[1]=456&limit=10&offset=5" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of members who are currently on leave or scheduled to be on leave within a specified range of days.\nThe user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Members on leave retrieved successfully.\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"member\": \"John Doe\",\n \"photo\": \"http:\/\/example.com\/storage\/photos\/john_doe.jpg\",\n \"from_date\": \"Mon, 2024-07-15\",\n \"to_date\": \"Fri, 2024-07-19\",\n \"type\": \"Full\",\n \"duration\": \"5 days\",\n \"days_left\": 0\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Members on leave not found.\",\n \"data\": []\n}", "name": "" } ] }, { "name": "Get Statistics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/dashboard\/statistics", "query": [], "raw": "{{baseUrl}}\/api\/dashboard\/statistics" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves workspace-specific statistics related to projects, tasks, users, clients, todos, and meetings. The user must be authenticated and have the necessary permissions to manage (if applicable) each respective module." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Statistics retrieved successfully\",\n \"data\": {\n \"total_projects\": 8,\n \"total_tasks\": 8,\n \"total_users\": 8,\n \"total_clients\": 8,\n \"total_meetings\": 8,\n \"total_todos\": 0,\n \"completed_todos\": 0,\n \"pending_todos\": 0,\n \"status_wise_projects\": [\n {\n \"id\": 1,\n \"title\": \"In Progress\",\n \"color\": \"primary\",\n \"total_projects\": 4\n },\n {\n \"id\": 2,\n \"title\": \"Completed\",\n \"color\": \"success\",\n \"total_projects\": 4\n }\n ],\n \"status_wise_tasks\": [\n {\n \"id\": 1,\n \"title\": \"In Progress\",\n \"color\": \"primary\",\n \"total_tasks\": 4\n },\n {\n \"id\": 2,\n \"title\": \"Completed\",\n \"color\": \"success\",\n \"total_tasks\": 4\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while retrieving statistics: Internal server error message\"\n}", "name": "" } ] } ] }, { "name": "Project Management", "description": "", "item": [ { "name": "List or search projects.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:id", "query": [ { "key": "search", "value": "Project", "description": "optional The search term to filter projects by title or id.", "disabled": false }, { "key": "sort", "value": "title", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, title, status, priority, start_date, end_date, budget, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "status_ids[0]", "value": 2, "description": "optional An array of status IDs to filter projects by.", "disabled": false }, { "key": "status_ids[1]", "value": 3, "description": "optional An array of status IDs to filter projects by.", "disabled": false }, { "key": "user_ids[0]", "value": 1, "description": "optional An array of user IDs to filter projects by.", "disabled": false }, { "key": "user_ids[1]", "value": 2, "description": "optional An array of user IDs to filter projects by.", "disabled": false }, { "key": "user_ids[2]", "value": 3, "description": "optional An array of user IDs to filter projects by.", "disabled": false }, { "key": "client_ids[0]", "value": 5, "description": "optional An array of client IDs to filter projects by.", "disabled": false }, { "key": "client_ids[1]", "value": 6, "description": "optional An array of client IDs to filter projects by.", "disabled": false }, { "key": "priority_ids[0]", "value": 1, "description": "optional An array of priority IDs to filter projects by.", "disabled": false }, { "key": "priority_ids[1]", "value": 2, "description": "optional An array of priority IDs to filter projects by.", "disabled": false }, { "key": "tag_ids[0]", "value": 1, "description": "optional An array of tag IDs to filter projects by.", "disabled": false }, { "key": "tag_ids[1]", "value": 2, "description": "optional An array of tag IDs to filter projects by.", "disabled": false }, { "key": "project_start_date_from", "value": "2024-01-01", "description": "optional The start date range's start in YYYY-MM-DD format.", "disabled": false }, { "key": "project_start_date_to", "value": "2024-12-31", "description": "optional The start date range's end in YYYY-MM-DD format.", "disabled": false }, { "key": "project_end_date_from", "value": "2024-01-01", "description": "optional The end date range's start in YYYY-MM-DD format.", "disabled": false }, { "key": "project_end_date_to", "value": "2024-12-31", "description": "optional The end date range's end in YYYY-MM-DD format.", "disabled": false }, { "key": "is_favorites", "value": "1", "description": "optional Filter projects marked as favorites.", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of projects per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/projects\/:id?search=Project&sort=title&order=ASC&status_ids[0]=2&status_ids[1]=3&user_ids[0]=1&user_ids[1]=2&user_ids[2]=3&client_ids[0]=5&client_ids[1]=6&priority_ids[0]=1&priority_ids[1]=2&tag_ids[0]=1&tag_ids[1]=2&project_start_date_from=2024-01-01&project_start_date_to=2024-12-31&project_end_date_from=2024-01-01&project_end_date_to=2024-12-31&is_favorites=1&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the project to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_ids\":[12],\"client_ids\":[19],\"priority_ids\":[13],\"tag_ids\":[19],\"status_ids\":[11]}" }, "description": "This endpoint retrieves a list of projects based on various filters. The user must be authenticated to perform this action. The request allows filtering by status, user, client, priority, tag, date ranges, and other parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Projects retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 351,\n \"title\": \"rwer\",\n \"status\": \"Rel test\",\n \"priority\": \"Default\",\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n },\n {\n \"id\": 183,\n \"first_name\": \"Girish\",\n \"last_name\": \"Thacker\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"clients\": [],\n \"tags\": [],\n \"start_date\": \"14-06-2024\",\n \"end_date\": \"14-06-2024\",\n \"budget\": \"\",\n \"created_at\": \"14-06-2024 17:50:09\",\n \"updated_at\": \"17-06-2024 19:08:16\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Project not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Projects not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Create a new project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/store", "query": [], "raw": "{{baseUrl}}\/api\/projects\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"New Website Launch\",\"status_id\":1,\"priority_id\":2,\"start_date\":\"2024-08-01\",\"end_date\":\"2024-08-31\",\"budget\":\"5000.00\",\"task_accessibility\":\"project_users\",\"description\":\"A project to launch a new company website.\",\"note\":\"Ensure all team members are informed.\",\"user_id\":\"[1, 2, 3]\",\"client_id\":\"[5, 6]\",\"tag_ids\":\"[10, 11]\",\"clientCanDiscuss\":\"on\"}" }, "description": "This endpoint creates a new project with the provided details. The user must be authenticated to perform this action. The request validates various fields, including title, status, priority, dates, and task accessibility." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Project created successfully.\",\n\"id\": 438,\n\"data\": {\n \"id\": 438,\n \"title\": \"Res Test\",\n \"status\": \"Default\",\n \"priority\": \"dsfdsf\",\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n },\n {\n \"id\": 185,\n \"first_name\": \"Admin\",\n \"last_name\": \"Test\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"clients\": [\n {\n \"id\": 103,\n \"first_name\": \"Test\",\n \"last_name\": \"Test\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"tags\": [\n {\n \"id\": 45,\n \"title\": \"Tag from update project\"\n }\n ],\n \"start_date\": null,\n \"end_date\": null,\n \"budget\": \"1000\",\n \"task_accessibility\": \"assigned_users\",\n \"description\": null,\n \"note\": null,\n \"favorite\": 0,\n \"created_at\": \"07-08-2024 14:38:51\",\n \"updated_at\": \"07-08-2024 14:38:51\"\n}\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"You are not authorized to set this status.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ],\n \"status_id\": [\n \"The status_id field is required.\"\n ],\n \"start_date\": [\n \"The start date must be before or equal to the end date.\"\n ],\n \"budget\": [\n \"The budget format is invalid.\"\n ],\n \"task_accessibility\": [\n \"The task accessibility must be either project_users or assigned_users.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the project.\"\n}", "name": "" } ] }, { "name": "Update an existing project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/update", "query": [], "raw": "{{baseUrl}}\/api\/projects\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":1,\"title\":\"Updated Project Title\",\"status_id\":2,\"priority_id\":3,\"budget\":\"5000.00\",\"task_accessibility\":\"assigned_users\",\"start_date\":\"2024-08-01\",\"end_date\":\"2024-08-31\",\"description\":\"Updated project description.\",\"note\":\"Updated note for the project.\",\"user_id\":\"[2, 3]\",\"client_id\":\"[5, 6]\",\"tag_ids\":\"[10, 11]\",\"clientCanDiscuss\":\"on\"}" }, "description": "This endpoint updates an existing project with the provided details. The user must be authenticated to perform this action. The request validates various fields, including title, status, priority, dates, and task accessibility." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Project updated successfully.\",\n\"id\": 438,\n\"data\": {\n \"id\": 438,\n \"title\": \"Res Test\",\n \"status\": \"Default\",\n \"priority\": \"dsfdsf\",\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n },\n {\n \"id\": 185,\n \"first_name\": \"Admin\",\n \"last_name\": \"Test\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"clients\": [\n {\n \"id\": 103,\n \"first_name\": \"Test\",\n \"last_name\": \"Test\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"tags\": [\n {\n \"id\": 45,\n \"title\": \"Tag from update project\"\n }\n ],\n \"start_date\": null,\n \"end_date\": null,\n \"budget\": \"1000\",\n \"task_accessibility\": \"assigned_users\",\n \"description\": null,\n \"note\": null,\n \"favorite\": 0,\n \"created_at\": \"07-08-2024 14:38:51\",\n \"updated_at\": \"07-08-2024 14:38:51\"\n}\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"You are not authorized to set this status.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The project ID is required.\",\n \"The project ID does not exist in our records.\"\n ],\n \"status_id\": [\n \"The status field is required.\"\n ],\n \"budget\": [\n \"The budget format is invalid.\"\n ],\n \"task_accessibility\": [\n \"The task accessibility must be either project_users or assigned_users.\"\n ],\n \"start_date\": [\n \"The start date must be before or equal to the end date.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the project.\"\n}", "name": "" } ] }, { "name": "Update the favorite status of a project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:id\/favorite", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:id\/favorite", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the project to update." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"is_favorite\":6}" }, "description": "This endpoint updates whether a project is marked as a favorite or not. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Project favorite status updated successfully\",\n\"data\": {\n\"id\": 438,\n\"title\": \"Res Test\",\n\"status\": \"Default\",\n\"priority\": \"dsfdsf\",\n\"users\": [\n{\n\"id\": 7,\n\"first_name\": \"Madhavan\",\n\"last_name\": \"Vaidya\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n}\n],\n\"clients\": [\n{\n\"id\": 103,\n\"first_name\": \"Test\",\n\"last_name\": \"Test\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n}\n],\n\"tags\": [\n{\n\"id\": 45,\n\"title\": \"Tag from update project\"\n}\n],\n\"start_date\": null,\n\"end_date\": null,\n\"budget\": \"1000.00\",\n\"task_accessibility\": \"assigned_users\",\n\"description\": null,\n\"note\": null,\n\"favorite\": 1,\n\"created_at\": \"07-08-2024 14:38:51\",\n\"updated_at\": \"12-08-2024 13:36:10\"\n}\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Project not found\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"is_favorite\": [\n \"The is favorite field must be either 0 or 1.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the favorite status.\"\n}", "name": "" } ] }, { "name": "Update the pinned status of a project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:id\/pinned", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:id\/pinned", "variable": [ { "id": "id", "key": "id", "value": "17", "description": "The ID of the project to update." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"is_pinned\":2}" }, "description": "This endpoint updates whether a project is marked as pinned or not. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Project pinned status updated successfully\",\n\"data\": {\n \"id\": 438,\n \"title\": \"Res Test\"\n \/\/ Other project details will be included in the actual response\n}\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Project not found\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"is_pinned\": [\n \"The is pinned field must be either 0 or 1.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the pinned status.\"\n}", "name": "" } ] }, { "name": "Update the status of a project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:id\/status", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:id\/status", "variable": [ { "id": "id", "key": "id", "value": "4", "description": "The ID of the project whose status is to be updated." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"statusId\":2,\"note\":\"quisquam\"}" }, "description": "This endpoint updates the status of a specified project. The user must be authenticated and have permission to set the new status. A notification will be sent to all users and clients associated with the project." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Status updated successfully.\",\n\"id\": \"438\",\n\"type\": \"project\",\n\"activity_message\": \"Madhavan Vaidya updated project status from Default to vbnvbnvbn\",\n\"data\": {\n\"id\": 438,\n\"title\": \"Res Test\",\n\"status\": \"vbnvbnvbn\",\n\"priority\": \"dsfdsf\",\n\"users\": [\n{\n\"id\": 7,\n\"first_name\": \"Madhavan\",\n\"last_name\": \"Vaidya\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n}\n],\n\"clients\": [\n{\n\"id\": 103,\n\"first_name\": \"Test\",\n\"last_name\": \"Test\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n}\n],\n\"tags\": [\n{\n\"id\": 45,\n\"title\": \"Tag from update project\"\n}\n],\n\"start_date\": null,\n\"end_date\": null,\n\"budget\": \"1000.00\",\n\"task_accessibility\": \"assigned_users\",\n\"description\": null,\n\"note\": null,\n\"favorite\": 1,\n\"created_at\": \"07-08-2024 14:38:51\",\n\"updated_at\": \"12-08-2024 13:49:33\"\n}\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"You are not authorized to set this status.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The selected id is invalid.\"\n ],\n \"statusId\": [\n \"The selected status id is invalid.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Status couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Update the priority of a project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:id\/priority", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:id\/priority", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the project whose priority is to be updated." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"priorityId\":18}" }, "description": "This endpoint updates the priority of a specified project. The user must be authenticated and have permission to set the new priority." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Priority updated successfully.\",\n\"id\": \"438\",\n\"type\": \"project\",\n\"activity_message\": \"Madhavan Vaidya updated project priority from Low to Medium\",\n\"data\": {\n\"id\": 438,\n\"title\": \"Res Test\",\n\"status\": \"Test From Pro\",\n\"priority\": \"Medium\",\n\"users\": [\n{\n\"id\": 7,\n\"first_name\": \"Madhavan\",\n\"last_name\": \"Vaidya\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n}\n],\n\"clients\": [\n{\n\"id\": 103,\n\"first_name\": \"Test\",\n\"last_name\": \"Test\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n}\n],\n\"tags\": [\n{\n\"id\": 45,\n\"title\": \"Tag from update project\"\n}\n],\n\"start_date\": null,\n\"end_date\": null,\n\"budget\": \"1000.00\",\n\"task_accessibility\": \"assigned_users\",\n\"description\": null,\n\"note\": null,\n\"favorite\": 1,\n\"created_at\": \"07-08-2024 14:38:51\",\n\"updated_at\": \"12-08-2024 13:58:55\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The selected id is invalid.\"\n ],\n \"priorityId\": [\n \"The selected priority id is invalid.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Priority couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Remove the specified project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the project to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a project based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Project deleted successfully.\",\n \"id\": 1,\n \"title\": \"Project Title\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Project not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the project.\"\n}", "name": "" } ] }, { "name": "Get project status timeline.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:id\/status-timelines", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:id\/status-timelines", "variable": [ { "id": "id", "key": "id", "value": "20", "description": "The ID of the project whose status timeline is to be retrieved." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves the status change history of a project, sorted in descending order." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Status timeline retrieved successfully.\",\n \"status_timeline\": [\n {\n \"id\": 1,\n \"status\": \"In Progress\",\n \"previous_status\": \"Pending\",\n \"new_color\": \"#ffcc00\",\n \"old_color\": \"#cccccc\",\n \"changed_at\": \"2025-03-03\"\n },\n {\n \"id\": 2,\n \"status\": \"Completed\",\n \"previous_status\": \"In Progress\",\n \"new_color\": \"#00cc66\",\n \"old_color\": \"#ffcc00\",\n \"changed_at\": \"2025-03-05 16:00:00\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Project not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Could not retrieve status timeline.\"\n}", "name": "" } ] }, { "name": "Get Mind Map Data of a specific project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:id\/mind-map", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:id\/mind-map", "variable": [ { "id": "id", "key": "id", "value": "7", "description": "The ID of the data to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves mind map data of a specific project by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"data\": {\n \"id\": \"project_2\",\n \"topic\": \"hola\",\n\"link\": \"https:\/\/dev-taskify.taskhub.company\/projects\/information\/2\",\n\"isroot\": true,\n\"level\": 1,\n\"children\": [\n{\n\"id\": \"tasks\",\n\"topic\": \"Tasks\",\n\"level\": 2,\n\"children\": [\n{\n\"id\": \"task_4\",\n\"topic\": \"Test\",\n\"link\": \"https:\/\/dev-taskify.taskhub.company\/tasks\/information\/4\",\n\"children\": [\n{\n\"id\": \"task_users_4\",\n\"topic\": \"Users\",\n\"children\": [\n{\n\"id\": \"task_user_4_1\",\n\"topic\": \"Admin User\",\n\"link\": \"https:\/\/dev-taskify.taskhub.company\/users\/profile\/1\"\n}\n]\n},\n{\n\"id\": \"task_clients_4\",\n\"topic\": \"Clients\",\n\"children\": []\n}\n]\n},\n{\n\"id\": \"task_5\",\n\"topic\": \"test\",\n\"link\": \"https:\/\/dev-taskify.taskhub.company\/tasks\/information\/5\",\n\"children\": [\n{\n\"id\": \"task_users_5\",\n\"topic\": \"Users\",\n\"children\": [\n{\n\"id\": \"task_user_5_1\",\n\"topic\": \"Admin User\",\n\"link\": \"https:\/\/dev-taskify.taskhub.company\/users\/profile\/1\"\n}\n]\n},\n{\n\"id\": \"task_clients_5\",\n\"topic\": \"Clients\",\n\"children\": []\n}\n]\n},\n{\n\"id\": \"task_6\",\n\"topic\": \"test 1\",\n\"link\": \"https:\/\/dev-taskify.taskhub.company\/tasks\/information\/6\",\n\"children\": [\n{\n\"id\": \"task_users_6\",\n\"topic\": \"Users\",\n\"children\": [\n{\n\"id\": \"task_user_6_1\",\n\"topic\": \"Admin User\",\n\"link\": \"https:\/\/dev-taskify.taskhub.company\/users\/profile\/1\"\n}\n]\n},\n{\n\"id\": \"task_clients_6\",\n\"topic\": \"Clients\",\n\"children\": []\n}\n]\n}\n]\n},\n{\n\"id\": \"users\",\n\"topic\": \"Users\",\n\"children\": [\n{\n\"id\": \"user_1\",\n\"topic\": \"Admin User\",\n\"link\": \"https:\/\/dev-taskify.taskhub.company\/users\/profile\/1\"\n}\n]\n},\n{\n\"id\": \"clients\",\n\"topic\": \"Clients\",\n\"children\": []\n},\n{\n\"id\": \"milestones\",\n\"topic\": \"Milestones\",\n\"children\": []\n},\n{\n\"id\": \"media\",\n\"topic\": \"Media\",\n\"children\": []\n}\n]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Project not found.\"\n}", "name": "" } ] } ] }, { "name": "Milestone Management", "description": "", "item": [ { "name": "Store a new milestone.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/milestones\/store", "query": [], "raw": "{{baseUrl}}\/api\/milestones\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"project_id\":2,\"title\":\"assumenda\",\"status\":\"magni\",\"start_date\":\"voluptate\",\"end_date\":\"at\",\"cost\":\"sed\",\"description\":\"Asperiores quam et aut ex.\"}" }, "description": "This endpoint creates a new milestone for a specified project. The user must be authenticated and have permission to create milestones." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Milestone created successfully.\",\n \"id\": 12,\n \"type\": \"milestone\",\n \"parent_type\": \"project\",\n \"parent_id\": 438\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"project_id\": [\"The selected project_id is invalid.\"],\n \"title\": [\"The title field is required.\"],\n \"cost\": [\"The cost format is invalid.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Milestone couldn't be created.\"\n}", "name": "" } ] }, { "name": "Get a list of milestones for a project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/milestones\/:id", "query": [ { "key": "search", "value": "voluptatem", "description": "optional Search for milestones by title, ID, cost, or description.", "disabled": false }, { "key": "sort", "value": "autem", "description": "optional Field to sort by (default: \"id\").", "disabled": false }, { "key": "order", "value": "provident", "description": "optional Sorting order (ASC\/DESC, default: \"DESC\").", "disabled": false }, { "key": "statuses[0]", "value": "quasi", "description": "optional Filter by milestone statuses.", "disabled": false }, { "key": "date_between_from", "value": "et", "description": "date optional Filter milestones starting from this date.", "disabled": false }, { "key": "date_between_to", "value": "quis", "description": "date optional Filter milestones ending at this date.", "disabled": false }, { "key": "start_date_from", "value": "similique", "description": "date optional Filter milestones with a start date after this date.", "disabled": false }, { "key": "start_date_to", "value": "quo", "description": "date optional Filter milestones with a start date before this date.", "disabled": false }, { "key": "end_date_from", "value": "non", "description": "date optional Filter milestones with an end date after this date.", "disabled": false }, { "key": "end_date_to", "value": "dolor", "description": "date optional Filter milestones with an end date before this date.", "disabled": false }, { "key": "limit", "value": "11", "description": "optional Number of records per page.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/milestones\/:id?search=voluptatem&sort=autem&order=provident&statuses[0]=quasi&date_between_from=et&date_between_to=quis&start_date_from=similique&start_date_to=quo&end_date_from=non&end_date_to=dolor&limit=11", "variable": [ { "id": "id", "key": "id", "value": "13", "description": "The ID of the project whose milestones are to be retrieved." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves all milestones associated with a given project.\nIt supports searching, filtering, and sorting functionalities." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 12,\n \"title\": \"Design Phase\",\n \"status\": Complete,\n \"progress\": \"75\",\n \"cost\": \"\u20b91,500.00\",\n \"start_date\": \"2025-03-10\",\n \"end_date\": \"2025-03-20\",\n \"created_by\": \"John Doe\",\n \"description\": \"Initial design phase for the project.\",\n \"created_at\": \"2025-03-01\",\n \"updated_at\": \"2025-03-05\",\n\n }\n ],\n \"total\": 1\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Project not found.\"\n}", "name": "" } ] }, { "name": "Get details of a specific milestone.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/milestones\/get\/:id", "query": [], "raw": "{{baseUrl}}\/api\/milestones\/get\/:id", "variable": [ { "id": "id", "key": "id", "value": "19", "description": "The ID of the milestone to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves details of a specific milestone by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"milestone\": {\n \"id\": 12,\n \"title\": \"Design Phase\",\n \"status\": \"In Progress\",\n \"cost\": \"\u20b91,500.00\",\n \"start_date\": \"2025-03-10\",\n \"end_date\": \"2025-03-20\",\n \"description\": \"Initial design phase for the project.\",\n \"created_at\": \"2025-03-01\",\n \"updated_at\": \"2025-03-05\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Milestone not found.\"\n}", "name": "" } ] }, { "name": "Update an existing milestone.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/milestones\/update", "query": [], "raw": "{{baseUrl}}\/api\/milestones\/update", "variable": [ { "id": "id", "key": "id", "value": "19", "description": "The ID of the milestone to be updated." } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"quam\",\"status\":\"quam\",\"start_date\":\"iure\",\"end_date\":\"nobis\",\"cost\":\"delectus\",\"progress\":9,\"description\":\"Ea quasi iusto ex quam.\"}" }, "description": "This endpoint updates a specified milestone. The user must be authenticated and have permission to modify the milestone." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Milestone updated successfully.\",\n \"id\": 12,\n \"type\": \"milestone\",\n \"parent_type\": \"project\",\n \"parent_id\": 438\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Milestone not found.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\"The title field is required.\"],\n \"cost\": [\"The cost format is invalid.\"],\n \"progress\": [\"The progress field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Milestone couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Delete a milestone.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/milestones\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/milestones\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The ID of the milestone to delete." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a specified milestone. The user must be authenticated and have permission to delete milestones." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Milestone deleted successfully.\",\n \"id\": 12,\n \"title\": \"Design Phase\",\n \"type\": \"milestone\",\n \"parent_type\": \"project\",\n \"parent_id\": 438\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Milestone not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Milestone couldn't be deleted.\"\n}", "name": "" } ] } ] }, { "name": "Project Comments", "description": "", "item": [ { "name": "Add a comment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/:id\/comments", "query": [], "raw": "{{baseUrl}}\/api\/projects\/:id\/comments", "variable": [ { "id": "id", "key": "id", "value": "6", "description": "The ID of the project to add a comment to." } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "multipart\/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "model_type", "value": "officiis", "type": "text", "description": "The type of model being commented on (e.g., \"Task\", \"Project\")." }, { "key": "model_id", "value": 4, "type": "text", "description": "The ID of the model being commented on." }, { "key": "content", "value": "debitis", "type": "text", "description": "The comment text." }, { "key": "parent_id", "value": 10, "type": "text", "description": "optional The ID of the parent comment (for replies)." }, { "key": "attachments[]", "src": [], "type": "file" } ] }, "description": "This endpoint allows authenticated users to add comments to a specific model (e.g., tasks, projects).\nUsers can also attach files and mention other users." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Comment Added Successfully\",\n \"comment\": {\n \"id\": 45,\n \"commentable_type\": \"App\\Models\\Project\",\n \"commentable_id\": 438,\n \"content\": \"This is a sample comment with a mention @JohnDoe\",\n \"commenter_id\": 7,\n \"commenter_type\": \"App\\\\Models\\\\User\",\n \"parent_id\": null,\n \"created_at\": \"2 minutes ago\",\n \"attachments\": [\n {\n \"id\": 1,\n \"file_name\": \"document.pdf\",\n \"file_path\": \"comment_attachments\/document.pdf\",\n \"file_type\": \"application\/pdf\"\n }\n ]\n },\n \"user\": {\n \"id\": 7,\n \"name\": \"John Doe\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"content\": [\"Please enter a comment.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Comment could not be added.\"\n}", "name": "" } ] }, { "name": "Get details of a specific comment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/comments\/get\/:id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/comments\/get\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the comment to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves details of a specific comment by its ID, including any attachments." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"comment\": {\n \"id\": 45,\n \"commentable_type\": \"App\\\\Models\\\\Project\",\n \"commentable_id\": 438,\n \"content\": \"This is a sample comment with a mention @JohnDoe\",\n \"commenter_id\": 7,\n \"commenter_type\": \"App\\\\Models\\\\User\",\n \"parent_id\": null,\n \"created_at\": \"2025-03-03 14:00:00\",\n \"updated_at\": \"2025-03-03 16:00:00\",\n \"attachments\": [\n {\n \"id\": 1,\n \"file_name\": \"document.pdf\",\n \"file_path\": \"comment_attachments\/document.pdf\",\n \"file_type\": \"application\/pdf\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Comment not found.\"\n}", "name": "" } ] }, { "name": "Update a comment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/comments\/update", "query": [], "raw": "{{baseUrl}}\/api\/projects\/comments\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"comment_id\":13,\"content\":\"dolorum\"}" }, "description": "This endpoint updates a specified comment. The user must be authenticated and have permission to modify the comment." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Comment updated successfully.\",\n \"id\": 45,\n \"type\": \"project\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Comment not found.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"content\": [\"Please enter a comment.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Comment couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Delete a comment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/comments\/destroy", "query": [ { "key": "comment_id", "value": "14", "description": "The ID of the comment to delete.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/projects\/comments\/destroy?comment_id=14" }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a specified comment and removes its attachments from storage.\nThe user must be authenticated and have permission to delete comments." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Comment deleted successfully.\",\n \"id\": 45,\n \"type\": \"project\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Comment not found.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"comment_id\": [\"The comment_id field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Comment couldn't be deleted.\"\n}", "name": "" } ] } ] }, { "name": "Project Media", "description": "", "item": [ { "name": "Upload media files to a project.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/upload-media", "query": [], "raw": "{{baseUrl}}\/api\/projects\/upload-media" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "multipart\/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": 19, "type": "text", "description": "The ID of the project to which media files are being uploaded." }, { "key": "media_files[]", "src": [], "type": "file" } ] }, "description": "This endpoint allows authenticated users to upload media files related to a project." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"File(s) uploaded successfully.\",\n \"id\": [101, 102],\n \"type\": \"media\",\n \"parent_type\": \"project\",\n \"parent_id\": 438\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Project not found.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\"The selected id is invalid.\"],\n \"media_files\": [\"The media file size exceeds the limit.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred during file upload.\"\n}", "name": "" } ] }, { "name": "Get project media files.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/get-media\/:id", "query": [ { "key": "search", "value": "ad", "description": "optional A search query to filter media files by name, ID, or upload date.", "disabled": false }, { "key": "sort", "value": "illo", "description": "optional The column to sort by (default: \"id\").", "disabled": false }, { "key": "order", "value": "deserunt", "description": "optional The sorting order: \"ASC\" or \"DESC\" (default: \"DESC\").", "disabled": false } ], "raw": "{{baseUrl}}\/api\/projects\/get-media\/:id?search=ad&sort=illo&order=deserunt", "variable": [ { "id": "id", "key": "id", "value": "4", "description": "The ID of the project whose media files are to be retrieved." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves all media files associated with a specific project, including sorting and search capabilities." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Media files retrieved successfully.\",\n \"rows\": [\n {\n \"id\": 101,\n \"file\": \"image.jpg<\/a>\",\n \"file_name\": \"image.jpg\",\n \"file_size\": \"2 MB\",\n \"created_at\": \"2025-03-03\",\n \"updated_at\": \"2025-03-03\",\n\n }\n ],\n \"total\": 1\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Project not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Could not retrieve media files.\"\n}", "name": "" } ] }, { "name": "Delete a media file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/projects\/delete-media\/:id", "query": [], "raw": "{{baseUrl}}\/api\/projects\/delete-media\/:id", "variable": [ { "id": "id", "key": "id", "value": "aut", "description": "The ID of the delete medium." }, { "id": "mediaId", "key": "mediaId", "value": "20", "description": "The ID of the media file to delete." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a specified media file associated with a project. The user must be authenticated and have permission to delete media files." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"File deleted successfully.\",\n \"id\": 101,\n \"title\": \"image.jpg\",\n \"parent_id\": 438,\n \"type\": \"media\",\n \"parent_type\": \"project\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"File not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"File couldn't be deleted.\"\n}", "name": "" } ] } ] }, { "name": "Task Management", "description": "", "item": [ { "name": "Create a new task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/store", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"New Task\",\"status_id\":1,\"priority_id\":2,\"start_date\":\"2024-07-20\",\"due_date\":\"2024-08-20\",\"description\":\"This is a detailed description of the task.\",\"project\":10,\"note\":\"Urgent\",\"user_id\":[1,2,3],\"clientCanDiscuss\":\"on\"}" }, "description": "This endpoint creates a new task with the provided details. The user must be authenticated to perform this action. The request validates various fields, including title, status, priority, start and due dates, project association, and optional notes." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Task created successfully.\",\n\"id\": 280,\n\"parent_id\": \"420\",\n\"parent_type\": \"project\",\n\"data\": {\n \"id\": 280,\n \"workspace_id\": 6,\n \"title\": \"Res Test\",\n \"status\": \"Default\",\n \"status_id\": \"0\",\n \"priority\": \"Default\",\n \"priority_id\": \"0\",\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n }\n ],\n \"user_id\": [1,2],\n \"clients\": [\n {\n \"id\": 173,\n \"first_name\": \"666\",\n \"last_name\": \"666\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"start_date\": \"07-08-2024\",\n \"due_date\": \"07-08-2024\",\n \"project\": {\n \"id\": 420,\n \"title\": \"Updated Project Title\"\n },\n \"description\": \"Test Desc\",\n \"note\": \"Test Note\",\n \"created_at\": \"07-08-2024 13:02:52\",\n \"updated_at\": \"07-08-2024 13:02:52\"\n}\n\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\"The title field is required.\"],\n \"status_id\": [\"The selected status_id is invalid.\"],\n ...\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the task.\"\n}", "name": "" } ] }, { "name": "List or search tasks.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/:id", "query": [ { "key": "search", "value": "Task", "description": "optional The search term to filter tasks by title or id.", "disabled": false }, { "key": "sort", "value": "title", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, title, project, status, priority, start_date, due_date, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "status_ids[0]", "value": 2, "description": "optional An array of status IDs to filter tasks by.", "disabled": false }, { "key": "status_ids[1]", "value": 3, "description": "optional An array of status IDs to filter tasks by.", "disabled": false }, { "key": "user_ids[0]", "value": 1, "description": "optional An array of user IDs to filter tasks by.", "disabled": false }, { "key": "user_ids[1]", "value": 2, "description": "optional An array of user IDs to filter tasks by.", "disabled": false }, { "key": "user_ids[2]", "value": 3, "description": "optional An array of user IDs to filter tasks by.", "disabled": false }, { "key": "client_ids[0]", "value": 5, "description": "optional An array of client IDs to filter tasks by.", "disabled": false }, { "key": "client_ids[1]", "value": 6, "description": "optional An array of client IDs to filter tasks by.", "disabled": false }, { "key": "priority_ids[0]", "value": 1, "description": "optional An array of priority IDs to filter tasks by.", "disabled": false }, { "key": "priority_ids[1]", "value": 2, "description": "optional An array of priority IDs to filter tasks by.", "disabled": false }, { "key": "project_ids[0]", "value": 1, "description": "optional An array of project IDs to filter tasks by.", "disabled": false }, { "key": "project_ids[1]", "value": 2, "description": "optional An array of project IDs to filter tasks by.", "disabled": false }, { "key": "task_start_date_from", "value": "2024-01-01", "description": "optional The start date range's start in YYYY-MM-DD format.", "disabled": false }, { "key": "task_start_date_to", "value": "2024-12-31", "description": "optional The start date range's end in YYYY-MM-DD format.", "disabled": false }, { "key": "task_end_date_from", "value": "2024-01-01", "description": "optional The end date range's start in YYYY-MM-DD format.", "disabled": false }, { "key": "task_end_date_to", "value": "2024-12-31", "description": "optional The end date range's end in YYYY-MM-DD format.", "disabled": false }, { "key": "is_favorites", "value": "1", "description": "optional Filter projects marked as favorites.", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of tasks per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/tasks\/:id?search=Task&sort=title&order=ASC&status_ids[0]=2&status_ids[1]=3&user_ids[0]=1&user_ids[1]=2&user_ids[2]=3&client_ids[0]=5&client_ids[1]=6&priority_ids[0]=1&priority_ids[1]=2&project_ids[0]=1&project_ids[1]=2&task_start_date_from=2024-01-01&task_start_date_to=2024-12-31&task_end_date_from=2024-01-01&task_end_date_to=2024-12-31&is_favorites=1&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the task to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_ids\":[11],\"client_ids\":[8],\"priority_ids\":[1],\"project_ids\":[13],\"status_ids\":[1]}" }, "description": "This endpoint retrieves a list of tasks based on various filters. The user must be authenticated to perform this action. The request allows filtering by multiple statuses, users, clients, projects, date ranges, and other parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Tasks retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 268,\n \"workspace_id\": 6,\n \"title\": \"sdff\",\n \"status\": \"Default\",\n \"priority\": \"Default\",\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n }\n ],\n \"clients\": [\n {\n \"id\": 102,\n \"first_name\": \"Test\",\n \"last_name\": \"Client\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"start_date\": \"23-07-2024\",\n \"due_date\": \"24-07-2024\",\n \"project\": {\n \"id\": 379,\n \"title\": \"From API\"\n },\n \"description\": \"

Test Desc<\/p>\",\n \"note\": \"Test note\",\n \"created_at\": \"23-07-2024 17:50:09\",\n \"updated_at\": \"23-07-2024 19:08:16\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Task not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Tasks not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Update an existing task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/update", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":267,\"title\":\"Updated Task\",\"status_id\":2,\"priority_id\":1,\"start_date\":\"2024-07-20\",\"due_date\":\"2024-08-20\",\"description\":\"Updated task description.\",\"note\":\"Needs immediate attention.\",\"user_id\":[2,3],\"clientCanDiscuss\":\"on\"}" }, "description": "This endpoint updates the details of an existing task. The user must be authenticated to perform this action. The request validates various fields including title, status, priority, start and due dates, and optional notes. It also handles user assignments and notifies relevant parties of any status changes." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Task updated successfully.\",\n\"id\": 280,\n\"parent_id\": \"420\",\n\"parent_type\": \"project\",\n\"data\": {\n \"id\": 280,\n \"workspace_id\": 6,\n \"title\": \"Res Test\",\n \"status\": \"Default\",\n \"priority\": \"Default\",\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n }\n ],\n \"clients\": [\n {\n \"id\": 173,\n \"first_name\": \"666\",\n \"last_name\": \"666\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"start_date\": \"07-08-2024\",\n \"due_date\": \"07-08-2024\",\n \"project\": {\n \"id\": 420,\n \"title\": \"Updated Project Title\"\n },\n \"description\": \"Test Desc\",\n \"note\": \"Test Note\",\n \"created_at\": \"07-08-2024 13:02:52\",\n \"updated_at\": \"07-08-2024 13:02:52\"\n}\n\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\"The selected id is invalid.\"],\n \"title\": [\"The title field is required.\"],\n \"status_id\": [\"The selected status_id is invalid.\"],\n ...\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the task.\"\n}", "name": "" } ] }, { "name": "Update the favorite status of a task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/:id\/favorite", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/:id\/favorite", "variable": [ { "id": "id", "key": "id", "value": "4", "description": "The ID of the task to update." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"is_favorite\":11}" }, "description": "This endpoint updates whether a task is marked as a favorite or not. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Task favorite status updated successfully\",\n\"data\": {\n \"id\": 438,\n \"title\": \"Task Example\"\n \/\/ Other task details will be included in the actual response\n}\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Task not found\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"is_favorite\": [\n \"The is favorite field must be either 0 or 1.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the favorite status.\"\n}", "name": "" } ] }, { "name": "Update the pinned status of a task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/:id\/pinned", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/:id\/pinned", "variable": [ { "id": "id", "key": "id", "value": "15", "description": "The ID of the task to update." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"is_pinned\":16}" }, "description": "This endpoint updates whether a task is marked as pinned or not. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Task pinned status updated successfully\",\n\"data\": {\n \"id\": 438,\n \"title\": \"Task Example\"\n \/\/ Other task details will be included in the actual response\n}\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Task not found\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"is_pinned\": [\n \"The is pinned field must be either 0 or 1.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the pinned status.\"\n}", "name": "" } ] }, { "name": "Update the status of a task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/:id\/status", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/:id\/status", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the task whose status is to be updated." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"statusId\":2,\"note\":\"Updated due to client request.\"}" }, "description": "This endpoint updates the status of a specified task. The user must be authenticated and have permission to set the new status. A notification will be sent to all users and clients associated with the task." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Status updated successfully.\",\n\"id\": \"278\",\n\"type\": \"task\",\n\"activity_message\": \"Madhavan Vaidya updated task status from Ongoing to Completed\",\n\"data\": {\n\"id\": 278,\n\"workspace_id\": 6,\n\"title\": \"New Task\",\n\"status\": \"Completed\",\n\"priority\": \"dsfdsf\",\n\"users\": [\n{\n\"id\": 7,\n\"first_name\": \"Madhavan\",\n\"last_name\": \"Vaidya\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n}\n],\n\"clients\": [\n{\n\"id\": 173,\n\"first_name\": \"666\",\n\"last_name\": \"666\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n}\n],\n\"start_date\": \"20-08-2024\",\n\"due_date\": null,\n\"project\": {\n\"id\": 419,\n\"title\": \"Updated Project Title\"\n},\n\"description\": \"This is a detailed description of the task.\",\n\"note\": null,\n\"created_at\": \"06-08-2024 11:42:13\",\n\"updated_at\": \"12-08-2024 15:18:09\"\n}\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"You are not authorized to set this status.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The selected id is invalid.\"\n ],\n \"statusId\": [\n \"The selected status id is invalid.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Status couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Update the priority of a task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/:id\/priority", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/:id\/priority", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the task whose priority is to be updated." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"priorityId\":3}" }, "description": "This endpoint updates the priority of a specified task. The user must be authenticated and have permission to set the new priority." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Priority updated successfully.\",\n\"id\": \"278\",\n\"type\": \"task\",\n\"activity_message\": \"Madhavan Vaidya updated task priority from Medium to High\",\n\"data\": {\n\"id\": 278,\n\"workspace_id\": 6,\n\"title\": \"New Task\",\n\"status\": \"Completed\",\n\"priority\": \"High\",\n\"users\": [\n{\n\"id\": 7,\n\"first_name\": \"Madhavan\",\n\"last_name\": \"Vaidya\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n}\n],\n\"clients\": [\n{\n\"id\": 173,\n\"first_name\": \"666\",\n\"last_name\": \"666\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n}\n],\n\"start_date\": \"20-08-2024\",\n\"due_date\": null,\n\"project\": {\n\"id\": 419,\n\"title\": \"Updated Project Title\"\n},\n\"description\": \"This is a detailed description of the task.\",\n\"note\": null,\n\"created_at\": \"06-08-2024 11:42:13\",\n\"updated_at\": \"12-08-2024 15:40:41\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The selected id is invalid.\"\n ],\n \"priorityId\": [\n \"The selected priorityId is invalid.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Priority couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Remove the specified task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the task to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a task based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Task deleted successfully.\",\n \"id\": \"262\",\n \"title\": \"From API\",\n \"parent_id\": 377,\n \"parent_type\": \"project\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Task not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the task.\"\n}", "name": "" } ] }, { "name": "Get task status timeline.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/:id\/status-timelines", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/:id\/status-timelines", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "The ID of the task whose status timeline is to be retrieved." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves the status change history of a task, sorted in descending order." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Status timeline retrieved successfully.\",\n \"status_timeline\": [\n {\n \"id\": 1,\n \"status\": \"In Progress\",\n \"previous_status\": \"Pending\",\n \"new_color\": \"#ffcc00\",\n \"old_color\": \"#cccccc\",\n \"changed_at\": \"2025-03-03\"\n },\n {\n \"id\": 2,\n \"status\": \"Completed\",\n \"previous_status\": \"In Progress\",\n \"new_color\": \"#00cc66\",\n \"old_color\": \"#ffcc00\",\n \"changed_at\": \"2025-03-05 16:00:00\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Task not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Could not retrieve status timeline.\"\n}", "name": "" } ] } ] }, { "name": "Task Comments", "description": "", "item": [ { "name": "Add a comment with attachments.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/information\/:id\/comments", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/information\/:id\/comments", "variable": [ { "id": "id", "key": "id", "value": "libero", "description": "The ID of the information." } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "multipart\/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "model_type", "value": "sed", "type": "text", "description": "The type of model being commented on (e.g., \"Task\", \"Project\")." }, { "key": "model_id", "value": 11, "type": "text", "description": "The ID of the model being commented on." }, { "key": "content", "value": "nihil", "type": "text", "description": "The comment text." }, { "key": "parent_id", "value": 11, "type": "text", "description": "optional The ID of the parent comment (for replies)." }, { "key": "attachments[]", "src": [], "type": "file" } ] }, "description": "This endpoint allows authenticated users to add comments to a specific model (e.g., tasks, projects).\nUsers can also attach files and mention other users." }, "response": [ { "header": [], "code": 200, "body": "{\n \"success\": true,\n \"message\": \"Comment Added Successfully\",\n \"comment\": {\n \"id\": 45,\n \"commentable_type\": \"App\\\\Models\\\\Task\",\n \"commentable_id\": 438,\n \"content\": \"This is a sample comment with a mention @JohnDoe\",\n \"user_id\": 7,\n \"parent_id\": null,\n \"created_at\": \"2 minutes ago\",\n \"attachments\": [\n {\n \"id\": 1,\n \"file_name\": \"document.pdf\",\n \"file_path\": \"comment_attachments\/document.pdf\",\n \"file_type\": \"application\/pdf\"\n }\n ]\n },\n \"user\": {\n \"id\": 7,\n \"name\": \"John Doe\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"success\": false,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"content\": [\"Please enter a comment.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"success\": false,\n \"message\": \"Comment could not be added.\"\n}", "name": "" } ] }, { "name": "Get details of a specific comment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/comments\/get\/:id", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/comments\/get\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the comment to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves the details of a specific comment, including any attachments." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Comment retrieved successfully.\",\n \"comment\": {\n \"id\": 45,\n \"commentable_type\": \"App\\\\Models\\\\Task\",\n \"commentable_id\": 438,\n \"content\": \"This is a sample comment with a mention @JohnDoe\",\n \"user_id\": 7,\n \"parent_id\": null,\n \"created_at\": \"2025-03-03 14:00:00\",\n \"updated_at\": \"2025-03-03 16:00:00\",\n \"attachments\": [\n {\n \"id\": 1,\n \"file_name\": \"document.pdf\",\n \"file_path\": \"comment_attachments\/document.pdf\",\n \"file_type\": \"application\/pdf\"\n }\n ]\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Comment not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Could not retrieve comment.\"\n}", "name": "" } ] }, { "name": "Update a comment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/comments\/update", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/comments\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"comment_id\":10,\"content\":\"provident\"}" }, "description": "This endpoint updates a specified comment. The user must be authenticated and have permission to modify the comment." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Comment updated successfully.\",\n \"id\": 45,\n \"type\": \"task\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Comment not found.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"content\": [\"Please enter a comment.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Comment couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Delete a comment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/comments\/destroy", "query": [ { "key": "comment_id", "value": "11", "description": "The ID of the comment to delete.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/tasks\/comments\/destroy?comment_id=11" }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a specified comment and removes its attachments from storage.\nThe user must be authenticated and have permission to delete comments." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Comment deleted successfully.\",\n \"id\": 45,\n \"type\": \"task\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Comment not found.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"comment_id\": [\"The comment_id field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Comment couldn't be deleted.\"\n}", "name": "" } ] } ] }, { "name": "Task Media", "description": "", "item": [ { "name": "Upload media files for a task.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/upload-media", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/upload-media" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "multipart\/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": 13, "type": "text", "description": "The ID of the task where the media will be uploaded." }, { "key": "media_files[]", "src": [], "type": "file" } ] }, "description": "This endpoint allows authenticated users to upload media files and associate them with a specific task." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"File(s) uploaded successfully.\",\n \"id\": [201, 202],\n \"type\": \"media\",\n \"parent_type\": \"task\",\n \"parent_id\": 15\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred.\",\n \"errors\": {\n \"id\": [\"The selected id is invalid.\"],\n \"media_files\": [\"The media file must be a valid file.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred during file upload: [error details]\"\n}", "name": "" } ] }, { "name": "Get Task media files.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/get-media\/:id", "query": [ { "key": "search", "value": "voluptas", "description": "optional A search query to filter media files by name, ID, or upload date.", "disabled": false }, { "key": "sort", "value": "corporis", "description": "optional The column to sort by (default: \"id\").", "disabled": false }, { "key": "order", "value": "sunt", "description": "optional The sorting order: \"ASC\" or \"DESC\" (default: \"DESC\").", "disabled": false } ], "raw": "{{baseUrl}}\/api\/tasks\/get-media\/:id?search=voluptas&sort=corporis&order=sunt", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "The ID of the project whose media files are to be retrieved." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves all media files associated with a specific project, including sorting and search capabilities." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Media files retrieved successfully.\",\n \"rows\": [\n {\n \"id\": 101,\n \"file\": \"image.jpg<\/a>\",\n \"file_name\": \"image.jpg\",\n \"file_size\": \"2 MB\",\n \"created_at\": \"2025-03-03\",\n \"updated_at\": \"2025-03-03\",\n\n }\n ],\n \"total\": 1\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Task not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Could not retrieve media files.\"\n}", "name": "" } ] }, { "name": "Delete a media file.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tasks\/delete-media\/:id", "query": [], "raw": "{{baseUrl}}\/api\/tasks\/delete-media\/:id", "variable": [ { "id": "id", "key": "id", "value": "neque", "description": "The ID of the delete medium." }, { "id": "mediaId", "key": "mediaId", "value": "4", "description": "The ID of the media file to delete." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint allows authenticated users to delete a specific media file associated with a task." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"File deleted successfully.\",\n \"id\": 301,\n \"title\": \"document.pdf\",\n \"parent_id\": 15,\n \"type\": \"media\",\n \"parent_type\": \"task\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"File not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the file.\"\n}", "name": "" } ] } ] }, { "name": "Income vs Expense", "description": "", "item": [ { "name": "Get the Income vs Expense Statistics.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/reports\/income-vs-expense-report-data", "query": [], "raw": "{{baseUrl}}\/api\/reports\/income-vs-expense-report-data" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint provides the Income vs Expense Statistics.\nThe user must be authenticated to access this data." }, "response": [ { "header": [], "code": 200, "body": "{\n \"total_income\": \"$ 705.00\",\n \"total_expenses\": \"$ 20,000.00\",\n \"profit_or_loss\": \"$ -19,295.00\",\n \"invoices\": [\n {\n \"id\": 3,\n \"view_route\": \"http:\/\/localhost:8000\/estimates-invoices\/view\/3\",\n \"amount\": \"$ 105.00\",\n \"to_date\": \"05-02-2025\",\n \"from_date\": \"05-02-2025\"\n },\n {\n \"id\": 4,\n \"view_route\": \"http:\/\/localhost:8000\/estimates-invoices\/view\/4\",\n \"amount\": \"$ 600.00\",\n \"to_date\": \"05-02-2025\",\n \"from_date\": \"05-02-2025\"\n }\n ],\n \"expenses\": [\n {\n \"id\": 1,\n \"title\": \"Salary\",\n \"amount\": \"$ 500.00\",\n \"expense_date\": \"31-01-2025\"\n },\n {\n \"id\": 2,\n \"title\": \"January Rent Pay\",\n \"amount\": \"$ 5,000.00\",\n \"expense_date\": \"04-02-2025\"\n },\n {\n \"id\": 3,\n \"title\": \"Salary to Karen\",\n \"amount\": \"$ 5,000.00\",\n \"expense_date\": \"31-01-2025\"\n },\n {\n \"id\": 4,\n \"title\": \"Internet Bill Payment\",\n \"amount\": \"$ 300.00\",\n \"expense_date\": \"31-01-2025\"\n },\n {\n \"id\": 5,\n \"title\": \"Office Refreshment Items\",\n \"amount\": \"$ 1,000.00\",\n \"expense_date\": \"31-01-2025\"\n },\n {\n \"id\": 9,\n \"title\": \"Transportation Fuel\",\n \"amount\": \"$ 2,000.00\",\n \"expense_date\": \"08-02-2025\"\n },\n {\n \"id\": 10,\n \"title\": \"Corporate Tax\",\n \"amount\": \"$ 1,200.00\",\n \"expense_date\": \"08-02-2025\"\n },\n {\n \"id\": 11,\n \"title\": \"Event Sponsorships\",\n \"amount\": \"$ 5,000.00\",\n \"expense_date\": \"08-02-2025\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Something went wrong.\"\n}", "name": "" } ] } ] }, { "name": "Status Management", "description": "", "item": [ { "name": "List or search statuses.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/statuses\/:id", "query": [ { "key": "search", "value": "Active", "description": "optional The search term to filter statuses by title or id.", "disabled": false }, { "key": "sort", "value": "title", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, title, color, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of statuses per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/statuses\/:id?search=Active&sort=title&order=ASC&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the status to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of statuses based on various filters. The user must be authenticated to perform this action. The request allows searching and sorting by different parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Statuses retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Active\",\n \"color\": \"primary\",\n \"created_at\": \"20-07-2024 17:50:09\",\n \"updated_at\": \"21-07-2024 19:08:16\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Status not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Statuses not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Create a new status.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/status\/store", "query": [], "raw": "{{baseUrl}}\/api\/status\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"neque\",\"color\":\"esse\",\"role_ids\":[\"nam\"]}" }, "description": "This endpoint allows authenticated users to create a new status with a unique slug and assign roles to it." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Status created successfully.\",\n \"id\": 101,\n \"status\": {\n \"id\": 101,\n \"title\": \"In Progress\",\n \"color\": \"primary\",\n \"slug\": \"in-progress\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred.\",\n \"errors\": {\n \"title\": [\"The title field is required.\"],\n \"color\": [\"The color field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Status couldn't be created.\"\n}", "name": "" } ] }, { "name": "Update an existing status.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/status\/update", "query": [], "raw": "{{baseUrl}}\/api\/status\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":17,\"title\":\"aut\",\"color\":\"reiciendis\",\"role_ids\":[\"dicta\"]}" }, "description": "This endpoint allows authenticated users to update a status, including modifying the title, color, and associated roles." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Status updated successfully.\",\n \"id\": 101\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Status not found.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred.\",\n \"errors\": {\n \"id\": [\"The id field is required.\"],\n \"title\": [\"The title field is required.\"],\n \"color\": [\"The color field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Status couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Get details of a specific status.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/status\/get\/:id", "query": [], "raw": "{{baseUrl}}\/api\/status\/get\/:id", "variable": [ { "id": "id", "key": "id", "value": "12", "description": "The ID of the status to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves the details of a specific status, including the roles associated with it." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Status retrieved successfully.\",\n \"status\": {\n \"id\": 101,\n \"title\": \"In Progress\",\n \"color\": \"primary\",\n \"slug\": \"in-progress\"\n },\n \"roles\": [1, 2, 3]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Status not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Could not retrieve status.\"\n}", "name": "" } ] }, { "name": "Delete a status.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/status\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/status\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "10", "description": "The ID of the status to delete." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint allows authenticated users to delete a specific status. Before deletion,\nall associated projects and tasks will be updated to have a default status ID of `0`." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Status deleted successfully.\",\n \"id\": 101,\n \"title\": \"In Progress\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Status not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Status couldn't be deleted.\"\n}", "name": "" } ] } ] }, { "name": "Priority Management", "description": "", "item": [ { "name": "List or search priorities.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/priorities\/:id", "query": [ { "key": "search", "value": "High", "description": "optional The search term to filter priorities by title or id.", "disabled": false }, { "key": "sort", "value": "title", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, title, color, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of priorities per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/priorities\/:id?search=High&sort=title&order=ASC&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the priority to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of priorities based on various filters. The user must be authenticated to perform this action. The request allows searching and sorting by different parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Priorities retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"High\",\n \"color\": \"primary\",\n \"created_at\": \"20-07-2024 17:50:09\",\n \"updated_at\": \"21-07-2024 19:08:16\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Priority not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Priorities not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Create a new priority.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/priority\/store", "query": [], "raw": "{{baseUrl}}\/api\/priority\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"aspernatur\",\"color\":\"debitis\"}" }, "description": "This endpoint allows authenticated users to create a new priority with a unique slug." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Priority created successfully.\",\n \"id\": 101,\n \"priority\": {\n \"id\": 101,\n \"title\": \"High\",\n \"color\": \"primary\",\n \"slug\": \"high\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred.\",\n \"errors\": {\n \"title\": [\"The title field is required.\"],\n \"color\": [\"The color field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Priority couldn't be created.\"\n}", "name": "" } ] }, { "name": "Update an existing priority.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/priority\/update", "query": [], "raw": "{{baseUrl}}\/api\/priority\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":16,\"title\":\"aspernatur\",\"color\":\"explicabo\"}" }, "description": "This endpoint allows authenticated users to update a priority, including modifying the title and color." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Priority updated successfully.\",\n \"id\": 101\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Priority not found.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred.\",\n \"errors\": {\n \"id\": [\"The id field is required.\"],\n \"title\": [\"The title field is required.\"],\n \"color\": [\"The color field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Priority couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Get details of a specific priority.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/priority\/get\/:id", "query": [], "raw": "{{baseUrl}}\/api\/priority\/get\/:id", "variable": [ { "id": "id", "key": "id", "value": "7", "description": "The ID of the priority to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves the details of a specific priority." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Priority retrieved successfully.\",\n \"priority\": {\n \"id\": 101,\n \"title\": \"High\",\n \"color\": \"#ff0000\",\n \"slug\": \"high\",\n \"created_at\": \"2025-03-04 14:00:00\",\n \"updated_at\": \"2025-03-04 16:00:00\"\n }\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Priority not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Could not retrieve priority.\"\n}", "name": "" } ] }, { "name": "Delete a priority.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/priority\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/priority\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "11", "description": "The ID of the priority to delete." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint allows authenticated users to delete a specific priority.\nBefore deletion, all associated projects and tasks will have their `priority_id` set to `null`." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Priority deleted successfully.\",\n \"id\": 101,\n \"title\": \"High\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Priority not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Priority couldn't be deleted.\"\n}", "name": "" } ] } ] }, { "name": "Tag Management", "description": "", "item": [ { "name": "List or search tags.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tags\/:id", "query": [ { "key": "search", "value": "Urgent", "description": "optional The search term to filter tags by title or id.", "disabled": false }, { "key": "sort", "value": "title", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, title, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of tags per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/tags\/:id?search=Urgent&sort=title&order=ASC&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the tag to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of tags based on various filters. The user must be authenticated to perform this action. The request allows searching and sorting by different parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Tags retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Urgent\",\n \"color\": \"primary\",\n \"created_at\": \"20-07-2024 17:50:09\",\n \"updated_at\": \"21-07-2024 19:08:16\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Tag not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Tags not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Create a new tag.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tags\/store", "query": [], "raw": "{{baseUrl}}\/api\/tags\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Finish report\",\"color\":\"secondary\"}" }, "description": "This endpoint creates a new todo item with the specified title, color. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Tag created successfully.\",\n\"id\": 36,\n\"data\": {\n \"id\": 36,\n \"title\": \"test\",\n \"color\": \"secondary\",\n \"created_at\": \"07-08-2024 16:30:09\",\n \"updated_at\": \"07-08-2024 16:30:09\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ],\n \"color\": [\n \"The color must be one of the following: primary, secondary, warning, info, dark, success, danger.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the todo.\"\n}", "name": "" } ] }, { "name": "Update an existing tag.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tags\/update", "query": [], "raw": "{{baseUrl}}\/api\/tags\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":1,\"title\":\"Finish report\",\"color\":\"secondary\"}" }, "description": "This endpoint updates an existing tag item with the specified title, color. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Tag updated successfully.\",\n\"id\": \"36\",\n\"data\": {\n \"id\": 36,\n \"title\": \"test\",\n \"color\": \"secondary\",\n \"created_at\": \"07-08-2024 16:30:09\",\n \"updated_at\": \"07-08-2024 16:30:09\"\n}\n}\n\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ],\n \"title\": [\n \"The title field is required.\"\n ],\n \"color\": [\n \"The color must be one of the following: secondary, primary, info, warning, dark, danger.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the tag.\"\n}", "name": "" } ] }, { "name": "Remove the specified tag.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/tags\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/tags\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the todo to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a tag item based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Tag deleted successfully.\",\n \"id\": 1,\n \"title\": \"Tag Title\"\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Tag not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the tag.\"\n}", "name": "" } ] } ] }, { "name": "User Management", "description": "", "item": [ { "name": "List or search users.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/:id", "query": [ { "key": "search", "value": "John", "description": "optional The search term to filter users by id, first name, last name, phone, or email.", "disabled": false }, { "key": "sort", "value": "id", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, phone, dob, doj, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "status", "value": "1", "description": "optional The status ID to filter users by, either 0 or 1.", "disabled": false }, { "key": "role_ids[0]", "value": 1, "description": "optional The role IDs to filter users by.", "disabled": false }, { "key": "role_ids[1]", "value": 2, "description": "optional The role IDs to filter users by.", "disabled": false }, { "key": "type", "value": "project", "description": "optional The type of filter to apply, either \"project\" or \"task\".", "disabled": false }, { "key": "type_id", "value": "3", "description": "optional The ID associated with the type filter.", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of users per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/users\/:id?search=John&sort=id&order=ASC&status=1&role_ids[0]=1&role_ids[1]=2&type=project&type_id=3&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the user to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of users based on various filters. The user must be authenticated to perform this action. The request allows filtering by status, search term, role, type, type_id, and other parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Users retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 219,\n \"first_name\": \"Test\",\n \"last_name\": \"Test\",\n \"role\": \"Member\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"+91 1111111111\",\n \"dob\": \"09-08-2024\",\n \"doj\": \"09-08-2024\",\n \"address\": \"Test\",\n \"city\": \"Test\",\n \"state\": \"Test\",\n \"country\": \"Test\",\n \"zip\": \"111-111\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/K0OAOzWyoeD0ZXBzgsaeHZUZERbOTKRljRIYOEYU.png\",\n \"status\": 1,\n \"created_at\": \"09-08-2024 17:04:29\",\n \"updated_at\": \"09-08-2024 17:04:29\",\n \"assigned\": {\n \"projects\": 0,\n \"tasks\": 0\n }\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"User not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Users not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Project not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Task not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Create a new user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/store", "query": [], "raw": "{{baseUrl}}\/api\/users\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "multipart\/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "value": "John", "type": "text", "description": "The first name of the user." }, { "key": "last_name", "value": "Doe", "type": "text", "description": "The last name of the user." }, { "key": "email", "value": "john.doe@example.com", "type": "text", "description": "The email address of the user." }, { "key": "password", "value": "password123", "type": "text", "description": "The password for the user." }, { "key": "password_confirmation", "value": "password123", "type": "text", "description": "The password confirmation." }, { "key": "address", "value": "123 Main St", "type": "text", "description": "nullable The address of the user." }, { "key": "phone", "value": "1234567890", "type": "text", "description": "nullable The phone number of the user." }, { "key": "country_code", "value": "+91", "type": "text", "description": "nullable The country code for the phone number." }, { "key": "country_iso_code", "value": "in", "type": "text", "description": "nullable The ISO code for the phone number." }, { "key": "city", "value": "New York", "type": "text", "description": "nullable The city of the user." }, { "key": "state", "value": "NY", "type": "text", "description": "nullable The state of the user." }, { "key": "country", "value": "USA", "type": "text", "description": "nullable The country of the user." }, { "key": "zip", "value": "10001", "type": "text", "description": "nullable The ZIP code of the user." }, { "key": "dob", "value": "1990-01-01", "type": "text", "description": "nullable The date of birth of the user in the format specified in the general settings." }, { "key": "doj", "value": "2024-01-01", "type": "text", "description": "nullable The date of joining in the format specified in the general settings." }, { "key": "role", "value": 1, "type": "text", "description": "The ID of the role for the user." }, { "key": "status", "value": true, "type": "text", "description": "0 or 1. If Deactivated (0), the user won't be able to log in to their account.\nCan only specify if `is_admin_or_has_all_data_access` is true for the logged-in user, else 0 will be considered by default." }, { "key": "require_ev", "value": true, "type": "text", "description": "0 or 1. If Yes (1) is selected, the user will receive a verification link via email.\nCan only specify if `is_admin_or_has_all_data_access` is true for the logged-in user, else 1 will be considered by default." }, { "key": "profile", "src": [], "type": "file" } ] }, "description": "This endpoint creates a new user with the provided details. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"User created successfully.\",\n\"id\": 219,\n\"data\": {\n \"id\": 219,\n \"first_name\": \"Test\",\n \"last_name\": \"Test\",\n \"role\": \"Member\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"+91 1111111111\",\n \"dob\": \"09-08-2024\",\n \"doj\": \"09-08-2024\",\n \"address\": \"Test\",\n \"city\": \"Test\",\n \"state\": \"Test\",\n \"country\": \"Test\",\n \"zip\": \"111-111\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/K0OAOzWyoeD0ZXBzgsaeHZUZERbOTKRljRIYOEYU.png\",\n \"status\": 1,\n \"created_at\": \"09-08-2024 17:04:29\",\n \"updated_at\": \"09-08-2024 17:04:29\",\n \"assigned\": {\n \"projects\": 0,\n \"tasks\": 0\n }\n}\n\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n\"error\": true,\n\"message\": \"Validation errors occurred\",\n\"errors\": {\n \"first_name\": [\n \"The first name field is required.\"\n ],\n \"last_name\": [\n \"The last name field is required.\"\n ],\n \"email\": [\n \"The email has already been taken.\"\n ]\n}\n\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"User couldn\u2019t be created, please make sure email settings are operational.\"\n}", "name": "" } ] }, { "name": "Update an existing user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/update", "query": [], "raw": "{{baseUrl}}\/api\/users\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "multipart\/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": 1, "type": "text", "description": "The ID of the user to be updated." }, { "key": "first_name", "value": "John", "type": "text", "description": "The first name of the user." }, { "key": "last_name", "value": "Doe", "type": "text", "description": "The last name of the user." }, { "key": "email", "value": "john.doe@example.com", "type": "text", "description": "The email address of the user." }, { "key": "password", "value": "newpassword123", "type": "text", "description": "nullable The new password for the user. Can only be updated if `is_admin_or_has_all_data_access` is true for the logged-in user." }, { "key": "password_confirmation", "value": "newpassword123", "type": "text", "description": "required_with:password The password confirmation." }, { "key": "address", "value": "123 Main St", "type": "text", "description": "nullable The address of the user." }, { "key": "phone", "value": "1234567890", "type": "text", "description": "nullable The phone number of the user." }, { "key": "country_code", "value": "+91", "type": "text", "description": "nullable The country code for the phone number." }, { "key": "country_iso_code", "value": "in", "type": "text", "description": "nullable The ISO code for the phone number." }, { "key": "city", "value": "New York", "type": "text", "description": "nullable The city of the user." }, { "key": "state", "value": "NY", "type": "text", "description": "nullable The state of the user." }, { "key": "country", "value": "USA", "type": "text", "description": "nullable The country of the user." }, { "key": "zip", "value": "10001", "type": "text", "description": "nullable The ZIP code of the user." }, { "key": "dob", "value": "1990-01-01", "type": "text", "description": "nullable The date of birth of the user in the format specified in the general settings." }, { "key": "doj", "value": "2024-01-01", "type": "text", "description": "nullable The date of joining in the format specified in the general settings." }, { "key": "role", "value": 1, "type": "text", "description": "The ID of the role for the user." }, { "key": "status", "value": true, "type": "text", "description": "0 or 1. If Deactivated (0), the user won't be able to log in to their account.\nCan only specify status if `is_admin_or_has_all_data_access` is true for the logged-in user, else the current status will be considered by default." }, { "key": "profile", "src": [], "type": "file" } ] }, "description": "This endpoint updates the details of an existing user. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"User updated successfully.\",\n\"id\": 219,\n\"data\": {\n \"id\": 219,\n \"first_name\": \"APII\",\n \"last_name\": \"User\",\n \"role\": \"Member\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"+91 1111111111\",\n \"dob\": \"09-08-2024\",\n \"doj\": \"09-08-2024\",\n \"address\": \"Test adr\",\n \"city\": \"Test cty\",\n \"state\": \"Test ct\",\n \"country\": \"test ctr\",\n \"zip\": \"111-111\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/28NcF6qzmIRiOhN9zrtEu5x1iN55OBspR9o1ONMO.webp\",\n \"status\": \"1\",\n \"created_at\": \"09-08-2024 17:04:29\",\n \"updated_at\": \"09-08-2024 18:32:10\",\n \"assigned\": {\n \"projects\": 14,\n \"tasks\": 12\n }\n}\n\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n\"error\": true,\n\"message\": \"Validation errors occurred\",\n\"errors\": {\n \"first_name\": [\n \"The first name field is required.\"\n ],\n \"last_name\": [\n \"The last name field is required.\"\n ],\n \"email\": [\n \"The email has already been taken.\"\n ]\n}\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"User couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Remove the specified user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/users\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/users\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the user to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a user based on the provided ID. The request must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"User deleted successfully.\",\n \"id\": \"1\",\n \"title\": \"John Doe\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"User not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An internal server error occurred.\"\n}", "name": "" } ] } ] }, { "name": "Client Management", "description": "", "item": [ { "name": "List or search clients.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/clients\/:id", "query": [ { "key": "search", "value": "John", "description": "optional The search term to filter clients by id, first name, last name, comapny, phone, or email.", "disabled": false }, { "key": "sort", "value": "id", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, company, phone, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "status", "value": "1", "description": "optional The status ID to filter clients by, either 0 or 1.", "disabled": false }, { "key": "type", "value": "project", "description": "optional The type of filter to apply, either \"project\" or \"task\".", "disabled": false }, { "key": "type_id", "value": "3", "description": "optional The ID associated with the type filter.", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of clients per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/clients\/:id?search=John&sort=id&order=ASC&status=1&type=project&type_id=3&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the client to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of clients based on various filters. The user must be authenticated to perform this action. The request allows filtering by status, search term, type, type_id, and other parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Clients retrieved successfully\",\n \"total\": 1,\n \"clients\": [\n {\n \"id\": 185,\n \"first_name\": \"Client\",\n \"last_name\": \"Test\",\n \"company\": \"Test Company\",\n \"email\": \"client@test.com\",\n \"phone\": \"1 5555555555\",\n \"status\": 1,\n \"internal_purpose\": 1,\n \"created_at\": \"10-06-2024\",\n \"updated_at\": \"29-07-2024\",\n \"assigned\": {\n \"projects\": 0,\n \"tasks\": 0\n }\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Client not found\",\n \"total\": 0,\n \"clients\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Clients not found\",\n \"total\": 0,\n \"clients\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Project not found\",\n \"total\": 0,\n \"clients\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Task not found\",\n \"total\": 0,\n \"clients\": []\n}", "name": "" } ] }, { "name": "Store a new client.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/clients\/store", "query": [], "raw": "{{baseUrl}}\/api\/clients\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "multipart\/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "value": "John", "type": "text", "description": "The first name of the client." }, { "key": "last_name", "value": "Doe", "type": "text", "description": "The last name of the client." }, { "key": "company", "value": "Example Corp", "type": "text", "description": "nullable The company of the client." }, { "key": "email", "value": "john.doe@example.com", "type": "text", "description": "The email address of the client." }, { "key": "phone", "value": "1234567890", "type": "text", "description": "nullable The phone number of the client." }, { "key": "country_code", "value": "+91", "type": "text", "description": "nullable The country code for the phone number." }, { "key": "country_iso_code", "value": "in", "type": "text", "description": "nullable The ISO code for the phone number." }, { "key": "password", "value": "password123", "type": "text", "description": "The password for the client. Must be confirmed and at least 6 characters long." }, { "key": "password_confirmation", "value": "password123", "type": "text", "description": "The password confirmation. Required if password is provided." }, { "key": "address", "value": "123 Main St", "type": "text", "description": "nullable The address of the client." }, { "key": "city", "value": "New York", "type": "text", "description": "nullable The city of the client." }, { "key": "state", "value": "NY", "type": "text", "description": "nullable The state of the client." }, { "key": "country", "value": "USA", "type": "text", "description": "nullable The country of the client." }, { "key": "zip", "value": "10001", "type": "text", "description": "nullable The ZIP code of the client." }, { "key": "dob", "value": "1990-01-01", "type": "text", "description": "nullable The date of birth of the user in the format specified in the general settings." }, { "key": "doj", "value": "2024-01-01", "type": "text", "description": "nullable The date of joining in the format specified in the general settings." }, { "key": "internal_purpose", "value": "on", "type": "text", "description": "nullable Set to 'on' if the client is for internal purposes." }, { "key": "status", "value": true, "type": "text", "description": "0 or 1. If Deactivated (0), the client won't be able to log in to their account.\nCan only specify if `is_admin_or_has_all_data_access` is true for the logged-in user, else 0 will be considered by default." }, { "key": "require_ev", "value": true, "type": "text", "description": "0 or 1. If Yes (1) is selected, the client will receive a verification link via email.\nCan only specify if `is_admin_or_has_all_data_access` is true for the logged-in user, else 1 will be considered by default." }, { "key": "profile", "src": [], "type": "file" } ] }, "description": "This endpoint creates a new client. The client must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Client created successfully.\",\n\"data\": {\n\"id\": 183,\n\"first_name\": \"API\",\n\"last_name\": \"Client\",\n\"company\": \"test\",\n\"email\": \"777@gmail.com\",\n\"phone\": \"+91 1111111111\",\n\"address\": \"Test adr\",\n\"city\": \"Test cty\",\n\"state\": \"Test ct\",\n\"country\": \"test ctr\",\n\"zip\": \"111-111\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/a5xT73btrbk7sybc0768Bv8xlBn16ROK1Znf1Ddc.webp\",\n\"status\": \"1\",\n\"internal_purpose\": 0,\n\"created_at\": \"09-08-2024 19:22:17\",\n\"updated_at\": \"09-08-2024 20:10:06\",\n\"assigned\": {\n\"projects\": 0,\n\"tasks\": 0\n}\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n\"error\": true,\n\"message\": \"Validation errors occurred\",\n\"errors\": {\n \"first_name\": [\n \"The first name field is required.\"\n ],\n \"last_name\": [\n \"The last name field is required.\"\n ],\n \"email\": [\n \"The email has already been taken.\"\n ]\n}\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Client couldn\u2019t be created, please make sure email settings are operational.\"\n}", "name": "" } ] }, { "name": "Update an existing client.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/clients\/update", "query": [], "raw": "{{baseUrl}}\/api\/clients\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "multipart\/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "id", "value": 1, "type": "text", "description": "The ID of the client to be updated." }, { "key": "first_name", "value": "John", "type": "text", "description": "The first name of the client." }, { "key": "last_name", "value": "Doe", "type": "text", "description": "The last name of the client." }, { "key": "company", "value": "XYZ", "type": "text", "description": "nullable The company of the client." }, { "key": "email", "value": "john.doe@example.com", "type": "text", "description": "The email address of the client." }, { "key": "password", "value": "newpassword123", "type": "text", "description": "nullable The new password for the client. Can only be updated if `is_admin_or_has_all_data_access` is true for the logged-in user." }, { "key": "password_confirmation", "value": "newpassword123", "type": "text", "description": "required_with:password The password confirmation." }, { "key": "address", "value": "123 Main St", "type": "text", "description": "nullable The address of the client." }, { "key": "phone", "value": "1234567890", "type": "text", "description": "nullable The phone number of the client." }, { "key": "country_code", "value": "+91", "type": "text", "description": "nullable The country code for the phone number." }, { "key": "country_iso_code", "value": "in", "type": "text", "description": "nullable The ISO code for the phone number." }, { "key": "city", "value": "New York", "type": "text", "description": "nullable The city of the client." }, { "key": "state", "value": "NY", "type": "text", "description": "nullable The state of the client." }, { "key": "country", "value": "USA", "type": "text", "description": "nullable The country of the client." }, { "key": "zip", "value": "10001", "type": "text", "description": "nullable The ZIP code of the client." }, { "key": "dob", "value": "1990-01-01", "type": "text", "description": "nullable The date of birth of the user in the format specified in the general settings." }, { "key": "doj", "value": "2024-01-01", "type": "text", "description": "nullable The date of joining in the format specified in the general settings." }, { "key": "internal_purpose", "value": "on", "type": "text", "description": "nullable Set to 'on' if the client is for internal purposes." }, { "key": "status", "value": true, "type": "text", "description": "0 or 1. If Deactivated (0), the client won't be able to log in to their account.\nCan only specify if `is_admin_or_has_all_data_access` is true for the logged-in user, else the current status will be considered by default." }, { "key": "require_ev", "value": true, "type": "text", "description": "0 or 1. If Yes (1) is selected, the client will receive a verification link via email.\nCan only specify if `is_admin_or_has_all_data_access` is true for the logged-in user, else the current require_ev will be considered by default." }, { "key": "profile", "src": [], "type": "file" } ] }, "description": "This endpoint updates the details of an existing client. The client must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Client updated successfully.\",\n\"data\": {\n\"id\": 183,\n\"first_name\": \"API\",\n\"last_name\": \"Client\",\n\"company\": \"test\",\n\"email\": \"777@gmail.com\",\n\"phone\": \"+91 1111111111\",\n\"address\": \"Test adr\",\n\"city\": \"Test cty\",\n\"state\": \"Test ct\",\n\"country\": \"test ctr\",\n\"zip\": \"111-111\",\n\"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/a5xT73btrbk7sybc0768Bv8xlBn16ROK1Znf1Ddc.webp\",\n\"status\": \"1\",\n\"internal_purpose\": 0,\n\"created_at\": \"09-08-2024 19:22:17\",\n\"updated_at\": \"09-08-2024 20:10:06\",\n\"assigned\": {\n\"projects\": 0,\n\"tasks\": 0\n}\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n\"error\": true,\n\"message\": \"Validation errors occurred\",\n\"errors\": {\n \"first_name\": [\n \"The first name field is required.\"\n ],\n \"last_name\": [\n \"The last name field is required.\"\n ],\n \"email\": [\n \"The email has already been taken.\"\n ]\n}\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Client couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Remove the specified client.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/clients\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/clients\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the client to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a client based on the provided ID. The request must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"error\": false,\n \"message\": \"Client deleted successfully.\",\n \"id\": \"1\",\n \"title\": \"Jane Doe\",\n \"data\": []\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"data\": {\n \"error\": true,\n \"message\": \"Client not found.\",\n \"data\": []\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"data\": {\n \"error\": true,\n \"message\": \"An internal server error occurred.\"\n }\n}", "name": "" } ] } ] }, { "name": "Workspace Management", "description": "", "item": [ { "name": "Create a new workspace.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/workspaces\/store", "query": [], "raw": "{{baseUrl}}\/api\/workspaces\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Design Team\",\"user_ids\":\"[1, 2, 3]\",\"client_ids\":\"[5, 6]\",\"primaryWorkspace\":\"on\"}" }, "description": "This endpoint creates a new workspace with the provided details. The user must be authenticated to perform this action. The request validates various fields, including title and participants." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Workspace created successfully.\",\n\"id\": 438,\n\"data\": {\n \"id\": 438,\n \"title\": \"Design Team\",\n \"is_primary\": true,\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n }\n ],\n \"clients\": [\n {\n \"id\": 103,\n \"first_name\": \"Test\",\n \"last_name\": \"Test\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"created_at\": \"07-08-2024 14:38:51\",\n \"updated_at\": \"07-08-2024 14:38:51\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the workspace.\"\n}", "name": "" } ] }, { "name": "List or search workspaces.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/workspaces\/:id", "query": [ { "key": "search", "value": "Workspace", "description": "optional The search term to filter workspaces by title or id.", "disabled": false }, { "key": "sort", "value": "title", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, title, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "user_id", "value": "1", "description": "optional The user ID to filter workspaces by.", "disabled": false }, { "key": "client_id", "value": "5", "description": "optional The client ID to filter workspaces by.", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of workspaces per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/workspaces\/:id?search=Workspace&sort=title&order=ASC&user_id=1&client_id=5&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the workspace to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of workspaces based on various filters. The user must be authenticated to perform this action. The request allows filtering by user, client, and other parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Workspaces retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 351,\n \"title\": \"Workspace Title\",\n \"is_primary\": 0,\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n }\n ],\n \"clients\": [\n {\n \"id\": 12,\n \"first_name\": \"Client\",\n \"last_name\": \"Name\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/client-photo.png\"\n }\n ],\n \"created_at\": \"20-07-2024 17:50:09\",\n \"updated_at\": \"21-07-2024 19:08:16\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Workspace not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Workspaces not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Update an existing workspace.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/workspaces\/update", "query": [], "raw": "{{baseUrl}}\/api\/workspaces\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":438,\"title\":\"Design Team\",\"user_ids\":\"[1, 2, 3]\",\"client_ids\":\"[5, 6]\",\"primaryWorkspace\":\"on\"}" }, "description": "This endpoint updates the details of an existing workspace. The user must be authenticated to perform this action. The request validates various fields, including title and participants." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Workspace updated successfully.\",\n\"id\": 438,\n\"data\": {\n \"id\": 438,\n \"title\": \"Design Team\",\n \"is_primary\": true,\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n }\n ],\n \"clients\": [\n {\n \"id\": 103,\n \"first_name\": \"Test\",\n \"last_name\": \"Test\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"created_at\": \"07-08-2024 14:38:51\",\n \"updated_at\": \"07-08-2024 14:38:51\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the workspace.\"\n}", "name": "" } ] }, { "name": "Remove the specified workspace.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/workspaces\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/workspaces\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the workspace to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a workspace based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Workspace deleted successfully.\",\n \"id\": \"60\",\n \"title\": \"Workspace Title\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Workspace not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the workspace.\"\n}", "name": "" } ] }, { "name": "Set or remove a default workspace for the authenticated user.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/workspaces\/:id\/default", "query": [], "raw": "{{baseUrl}}\/api\/workspaces\/:id\/default", "variable": [ { "id": "id", "key": "id", "value": "13", "description": "The ID of the workspace to update." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"is_default\":true}" }, "description": "This endpoint updates whether a workspace is set as the default workspace for the user. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Default status updated successfully\"\n\"data\":[Workspace data here]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n\"error\": true,\n\"message\": \"Workspace not found\",\n\"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n\"error\": true,\n\"message\": \"Failed to update default workspace\"\n}", "name": "" } ] }, { "name": "Remove the authenticated user from the current workspace.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/workspaces\/remove-participant", "query": [], "raw": "{{baseUrl}}\/api\/workspaces\/remove-participant" }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint removes the authenticated user from the workspace they are currently in. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Removed from workspace successfully.\",\n \"data\": {\n \"workspace_id\": 1\n }\n}\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while removing the participant from the workspace.\"\n}", "name": "" } ] } ] }, { "name": "Meeting Management", "description": "", "item": [ { "name": "Create a new meeting.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/meetings\/store", "query": [], "raw": "{{baseUrl}}\/api\/meetings\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Project Kickoff\",\"start_date\":\"25-07-2024\",\"end_date\":\"25-07-2024\",\"start_time\":\"10:00\",\"end_time\":\"11:00\",\"user_ids\":[1,2,3],\"client_ids\":[4,5]}" }, "description": "This endpoint creates a new meeting with the provided details. The user must be authenticated to perform this action. The request validates various fields, including title, start and end dates, start and end times, and participant IDs." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Meeting created successfully.\",\n\"id\": 119,\n\"data\": {\n \"id\": 119,\n \"title\": \"From API\",\n \"start_date\": \"25-07-2024\",\n \"start_time\": \"15:00:00\",\n \"end_date\": \"25-08-2024\",\n \"end_time\": \"11:41:05\",\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n }\n ],\n \"clients\": [\n {\n \"id\": 173,\n \"first_name\": \"666\",\n \"last_name\": \"666\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"status\": \"Ongoing\",\n \"created_at\": \"07-08-2024 17:11:05\",\n \"updated_at\": \"07-08-2024 17:11:05\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\"The title field is required.\"],\n \"start_date\": [\"The start date field is required.\"],\n ...\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the meeting.\"\n}", "name": "" } ] }, { "name": "List or search meetings.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/meetings\/:id", "query": [ { "key": "search", "value": "Meeting", "description": "optional The search term to filter meetings by title or id.", "disabled": false }, { "key": "sort", "value": "title", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, title, start_date_time, end_date_time, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "status", "value": "ongoing", "description": "optional The status of the meeting to filter by. Can be \"ongoing\", \"ended\", or \"yet_to_start\".", "disabled": false }, { "key": "user_id", "value": "1", "description": "optional The user ID to filter meetings by.", "disabled": false }, { "key": "client_id", "value": "5", "description": "optional The client ID to filter meetings by.", "disabled": false }, { "key": "start_date_from", "value": "2024-01-01", "description": "optional The start date range's start in YYYY-MM-DD format.", "disabled": false }, { "key": "start_date_to", "value": "2024-12-31", "description": "optional The start date range's end in YYYY-MM-DD format.", "disabled": false }, { "key": "end_date_from", "value": "2024-01-01", "description": "optional The end date range's start in YYYY-MM-DD format.", "disabled": false }, { "key": "end_date_to", "value": "2024-12-31", "description": "optional The end date range's end in YYYY-MM-DD format.", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of meetings per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/meetings\/:id?search=Meeting&sort=title&order=ASC&status=ongoing&user_id=1&client_id=5&start_date_from=2024-01-01&start_date_to=2024-12-31&end_date_from=2024-01-01&end_date_to=2024-12-31&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the meeting to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of meetings based on various filters. The user must be authenticated to perform this action. The request allows filtering by status, user, client, date ranges, and other parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Meetings retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 351,\n \"title\": \"Project Kickoff\",\n \"start_date\": \"2024-07-01\",\n \"start_time\": \"10:00:00\",\n \"end_date\": \"2024-07-01\",\n \"end_time\": \"11:00:00\",\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n }\n ],\n \"clients\": [],\n \"status\": \"Ongoing\",\n \"created_at\": \"14-06-2024 17:50:09\",\n \"updated_at\": \"17-06-2024 19:08:16\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Meeting not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Meetings not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Update an existing meeting.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/meetings\/update", "query": [], "raw": "{{baseUrl}}\/api\/meetings\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":1,\"title\":\"Updated Meeting Title\",\"start_date\":\"2024-08-01\",\"end_date\":\"2024-08-31\",\"start_time\":\"09:00\",\"end_time\":\"10:00\",\"user_ids\":\"[2, 3]\",\"client_ids\":\"[5, 6]\"}" }, "description": "This endpoint updates an existing meeting with the provided details. The user must be authenticated to perform this action. The request validates various fields, including title, dates, and times." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Meeting updated successfully.\",\n\"id\": 119,\n\"data\": {\n \"id\": 119,\n \"title\": \"From API\",\n \"start_date\": \"25-07-2024\",\n \"start_time\": \"15:00:00\",\n \"end_date\": \"25-08-2024\",\n \"end_time\": \"11:45:15\",\n \"users\": [\n {\n \"id\": 7,\n \"first_name\": \"Madhavan\",\n \"last_name\": \"Vaidya\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\"\n }\n ],\n \"clients\": [\n {\n \"id\": 173,\n \"first_name\": \"666\",\n \"last_name\": \"666\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"status\": \"Ongoing\",\n \"created_at\": \"07-08-2024 17:11:05\",\n \"updated_at\": \"07-08-2024 17:15:15\"\n}\n\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The meeting ID is required.\",\n \"The meeting ID does not exist in our records.\"\n ],\n \"start_date\": [\n \"The start date must be before or equal to the end date.\"\n ],\n \"start_time\": [\n \"The start time field is required.\"\n ],\n \"end_time\": [\n \"The end time field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the meeting.\"\n}", "name": "" } ] }, { "name": "Remove the specified meeting.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/meetings\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/meetings\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the meeting to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a meeting based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Meeting deleted successfully.\",\n \"id\": 1,\n \"title\": \"Meeting Title\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Meeting not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the meeting.\"\n}", "name": "" } ] } ] }, { "name": "Todo Management", "description": "", "item": [ { "name": "Create a new todo.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/todos\/store", "query": [], "raw": "{{baseUrl}}\/api\/todos\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Finish report\",\"priority\":\"medium\",\"description\":\"Complete the report by end of day\"}" }, "description": "This endpoint creates a new todo item with the specified title, priority, and description. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Todo created successfully.\",\n\"id\": 36,\n\"data\": {\n \"id\": 36,\n \"title\": \"test\",\n \"description\": \"test\",\n \"priority\": \"low\",\n \"is_completed\": 0,\n \"created_at\": \"07-08-2024 16:30:09\",\n \"updated_at\": \"07-08-2024 16:30:09\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ],\n \"priority\": [\n \"The priority must be one of the following: low, medium, high.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the todo.\"\n}", "name": "" } ] }, { "name": "List or search todos.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/todos\/:id", "query": [ { "key": "search", "value": "Test", "description": "optional The search term to filter todos by id, title, or description.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "optional The field to sort by. Defaults to \"is_completed\". All fields are sortable.", "disabled": false }, { "key": "order", "value": "asc", "description": "optional The sort order, either \"asc\" or \"desc\". Defaults to \"desc\".", "disabled": false }, { "key": "status", "value": "completed", "description": "optional The status to filter todos by.", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of todos per page for pagination. Defaults to 10.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results. Defaults to 0.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/todos\/:id?search=Test&sort=created_at&order=asc&status=completed&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the todo to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of todos based on various filters. The user must be authenticated to perform this action. The request allows filtering by search term, status, and pagination parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Todos retrieved successfully.\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 35,\n \"title\": \"test\",\n \"description\": \"test\",\n \"priority\": \"low\",\n \"is_completed\": 0,\n \"created_at\": \"07-08-2024 15:28:22\",\n \"updated_at\": \"07-08-2024 15:28:22\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Todo not found.\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Todos not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while retrieving the todos.\"\n}", "name": "" } ] }, { "name": "Update an existing todo.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/todos\/update", "query": [], "raw": "{{baseUrl}}\/api\/todos\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":1,\"title\":\"Finish report\",\"priority\":\"medium\",\"description\":\"Complete the report by end of day\"}" }, "description": "This endpoint updates an existing todo item with the specified title, priority, and description. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Todo updated successfully.\",\n\"id\": \"36\",\n\"data\": {\n \"id\": 36,\n \"is_completed\": 0,\n \"title\": \"test\",\n \"priority\": \"low\",\n \"description\": \"test\",\n \"created_at\": \"07-08-2024 16:30:09\",\n \"updated_at\": \"07-08-2024 16:30:09\"\n}\n}\n\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ],\n \"title\": [\n \"The title field is required.\"\n ],\n \"priority\": [\n \"The priority must be one of the following: low, medium, high.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the todo.\"\n}", "name": "" } ] }, { "name": "Update the completion status of a todo.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/todos\/:id\/status", "query": [], "raw": "{{baseUrl}}\/api\/todos\/:id\/status", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the todo whose status is to be updated." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":true}" }, "description": "This endpoint updates the completion status of a specified todo item. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Status updated successfully.\",\n\"id\": \"60\",\n\"activity_message\": \"Madhavan Vaidya marked todo iouyhgyu as Completed\",\n\"data\": {\n\"id\": 60,\n\"title\": \"iouyhgyu\",\n\"description\": \"ty8uifyu\",\n\"priority\": \"medium\",\n\"is_completed\": 1,\n\"created_at\": \"10-08-2024 10:28:59\",\n\"updated_at\": \"12-08-2024 18:08:14\"\n}\n\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ],\n \"status\": [\n \"The status field is required.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Status couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Update the priority of a todo.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/todos\/:id\/priority", "query": [], "raw": "{{baseUrl}}\/api\/todos\/:id\/priority", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the todo whose priority is to be updated." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"priority\":\"medium\"}" }, "description": "This endpoint updates the priority of a specified todo item. The user must be authenticated to perform this action. The priority must be one of 'low', 'medium', or 'high'." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Priority updated successfully.\",\n\"id\": \"60\",\n\"activity_message\": \"Madhavan Vaidya updated the priority of todo iouyhgyu from High to Low\",\n\"data\": {\n\"id\": 60,\n\"title\": \"iouyhgyu\",\n\"description\": \"ty8uifyu\",\n\"priority\": \"low\",\n\"is_completed\": 1,\n\"created_at\": \"10-08-2024 10:28:59\",\n\"updated_at\": \"12-08-2024 18:11:13\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ],\n \"priority\": [\n \"The priority field is required.\",\n \"The selected priority is invalid.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Priority couldn't be updated.\"\n}", "name": "" } ] }, { "name": "Remove the specified todo.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/todos\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/todos\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the todo to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a todo item based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Todo deleted successfully.\",\n \"id\": 1,\n \"title\": \"Todo Title\"\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Todo not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the todo.\"\n}", "name": "" } ] } ] }, { "name": "Note Management", "description": "", "item": [ { "name": "Create a new note.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notes\/store", "query": [], "raw": "{{baseUrl}}\/api\/notes\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Meeting notes\",\"color\":\"warning\",\"description\":\"Notes from the client meeting\"}" }, "description": "This endpoint creates a new note item with the specified title, color, and description. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Note created successfully.\",\n\"id\": 44,\n\"data\": {\n \"id\": 44,\n \"title\": \"Test Note\",\n \"color\": \"info\",\n \"note_type\" : \"text|drawing\",\n \"drawing_data\":\"urlencoded(base64encoded(Svg)),\n \"description\": \"test\",\n \"workspace_id\": 6,\n \"creator_id\": \"u_7\",\n \"created_at\": \"07-08-2024 16:24:57\",\n \"updated_at\": \"07-08-2024 16:24:57\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ],\n \"color\": [\n \"The color must be one of the following: info, warning, danger.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the note.\"\n}", "name": "" } ] }, { "name": "List or search notes.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notes\/:id", "query": [ { "key": "search", "value": "Test", "description": "optional The search term to filter notes by id, title, or description.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "optional The field to sort by. Defaults to \"is_completed\". All fields are sortable.", "disabled": false }, { "key": "order", "value": "asc", "description": "optional The sort order, either \"asc\" or \"desc\". Defaults to \"desc\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of notes per page for pagination. Defaults to 10.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results. Defaults to 0.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/notes\/:id?search=Test&sort=created_at&order=asc&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the note to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of notes based on various filters. The user must be authenticated to perform this action. The request allows filtering by search term and pagination parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Notes retrieved successfully.\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 43,\n \"title\": \"upper\",\n \"color\": \"warning\",\n \"description\": \"jhdcsd\",\n \"workspace_id\": 6,\n \"creator_id\": \"u_7\",\n \"created_at\": \"07-08-2024 16:12:13\",\n \"updated_at\": \"07-08-2024 16:12:13\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Note not found.\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Notes not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while retrieving the notes.\"\n}", "name": "" } ] }, { "name": "Update an existing note.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notes\/update", "query": [], "raw": "{{baseUrl}}\/api\/notes\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":1,\"title\":\"Meeting notes\",\"color\":\"warning\",\"description\":\"Notes from the client meeting\"}" }, "description": "This endpoint updates an existing note item with the specified title, color, and description. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Note updated successfully.\",\n\"id\": 44,\n\"data\": {\n \"id\": 44,\n \"title\": \"Test Note\",\n \"color\": \"info\",\n \"description\": \"test\",\n \"workspace_id\": 6,\n \"creator_id\": \"u_7\",\n \"created_at\": \"07-08-2024 16:24:57\",\n \"updated_at\": \"07-08-2024 16:24:57\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ],\n \"title\": [\n \"The title field is required.\"\n ],\n \"color\": [\n \"The color must be one of the following: info, warning, danger.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the note.\"\n}", "name": "" } ] }, { "name": "Remove the specified note.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notes\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/notes\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the note to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a note item based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Note deleted successfully.\",\n \"id\": 1,\n \"title\": \"Note Title\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Note not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the note.\"\n}", "name": "" } ] } ] }, { "name": "Leave Request Management", "description": "", "item": [ { "name": "Create a new leave request.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/leave-requests\/store", "query": [], "raw": "{{baseUrl}}\/api\/leave-requests\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"reason\":\"Family function\",\"from_date\":\"2024-08-05\",\"to_date\":\"2024-08-01\",\"from_time\":\"09:00\",\"to_time\":\"17:00\",\"status\":\"pending\",\"leaveVisibleToAll\":\"on\",\"visible_to_ids\":[1,2,3],\"user_id\":4,\"partialLeave\":\"on\",\"comment\":\"Approved due to exceptional circumstances\"}" }, "description": "This endpoint creates a new leave request with the provided details. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Leave request created successfully.\",\n\"id\": 187,\n\"type\": \"leave_request\",\n\"data\": {\n \"id\": 187,\n \"user_name\": \"Madhavan Vaidya\",\n \"user_photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\",\n \"action_by\": null,\n \"action_by_id\": null,\n \"from_date\": \"Wed, 07-08-2024\",\n \"to_date\": \"Wed, 07-08-2024\",\n \"type\": \"Full\",\n \"duration\": \"1 day\",\n \"reason\": \"Test\",\n \"status\": \"Pending\",\n \"visible_to\": null,\n \"created_at\": \"07-08-2024 18:31:28\",\n \"updated_at\": \"07-08-2024 18:31:28\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"reason\": [\n \"The reason field is required.\"\n ],\n \"from_date\": [\n \"The from date field is required.\"\n ],\n \"to_date\": [\n \"The to date field is required.\"\n ],\n \"from_time\": [\n \"The from time field is required when partial leave is checked.\"\n ],\n \"to_time\": [\n \"The to time field is required when partial leave is checked.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the leave request.\"\n}", "name": "" } ] }, { "name": "List or search leave requests.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/leave-requests\/:id", "query": [ { "key": "search", "value": "Vacation", "description": "optional The search term to filter leave requests by reason or id.", "disabled": false }, { "key": "sort", "value": "id", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, from_date, to_date, type, reason, status, action_by_id, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "status", "value": "pending", "description": "optional The status of the leave request to filter by. Can be \"pending\", \"approved\", \"rejected\", etc.", "disabled": false }, { "key": "user_id", "value": "1", "description": "optional The user ID to filter leave requests by.", "disabled": false }, { "key": "action_by_id", "value": "2", "description": "optional The ID of the user who acted on the request to filter by.", "disabled": false }, { "key": "start_date_from", "value": "2024-01-01", "description": "optional The start date range's start in YYYY-MM-DD format.", "disabled": false }, { "key": "start_date_to", "value": "2024-12-31", "description": "optional The start date range's end in YYYY-MM-DD format.", "disabled": false }, { "key": "end_date_from", "value": "2024-01-01", "description": "optional The end date range's start in YYYY-MM-DD format.", "disabled": false }, { "key": "end_date_to", "value": "2024-12-31", "description": "optional The end date range's end in YYYY-MM-DD format.", "disabled": false }, { "key": "type", "value": "full", "description": "optional The type of leave request. Can be \"full\" or \"partial\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of leave requests per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/leave-requests\/:id?search=Vacation&sort=id&order=ASC&status=pending&user_id=1&action_by_id=2&start_date_from=2024-01-01&start_date_to=2024-12-31&end_date_from=2024-01-01&end_date_to=2024-12-31&type=full&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the leave request to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of leave requests based on various filters. The user must be authenticated to perform this action. The request allows filtering by status, user, action_by, date ranges, type, and search term." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Leave requests retrieved successfully\",\n \"total\": 25,\n \"data\": [\n {\n \"id\": 175,\n \"user_name\": \"Admin Test\",\n \"user_photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\",\n \"action_by\": null,\n \"from_date\": \"Mon, 29-07-2024\",\n \"to_date\": \"Mon, 29-07-2024\",\n \"type\": \"Full\",\n \"duration\": \"1 day\",\n \"reason\": \"dsdsdsd\",\n \"status\": \"Pending\",\n \"visible_to\": [\n {\n \"id\": 183,\n \"first_name\": \"Girish\",\n \"last_name\": \"Thacker\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"created_at\": \"29-07-2024 10:02:45\",\n \"updated_at\": \"29-07-2024 10:02:45\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Leave request not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Leave requests not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Update an existing leave request.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/leave-requests\/update", "query": [], "raw": "{{baseUrl}}\/api\/leave-requests\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":1,\"reason\":\"Family function\",\"from_date\":\"2024-08-05\",\"to_date\":\"2024-08-01\",\"from_time\":\"09:00\",\"to_time\":\"17:00\",\"status\":\"pending\",\"leaveVisibleToAll\":\"on\",\"visible_to_ids\":[1,2,3],\"partialLeave\":\"on\",\"comment\":\"Approved due to exceptional circumstances\"}" }, "description": "This endpoint updates an existing leave request with the provided details. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Leave request updated successfully.\",\n\"id\": 187,\n\"type\": \"leave_request\",\n\"data\": {\n \"id\": 187,\n \"user_name\": \"Madhavan Vaidya\",\n \"user_photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/yxNYBlFLALdLomrL0JzUY2USPLILL9Ocr16j4n2o.png\",\n \"action_by\": null,\n \"action_by_id\": null,\n \"from_date\": \"Wed, 07-08-2024\",\n \"to_date\": \"Wed, 07-08-2024\",\n \"type\": \"Full\",\n \"duration\": \"1 day\",\n \"reason\": \"Test\",\n \"status\": \"Pending\",\n \"visible_to\": null,\n \"created_at\": \"07-08-2024 18:31:28\",\n \"updated_at\": \"07-08-2024 18:31:28\"\n}\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\",\n \"The selected id is invalid.\"\n ],\n \"reason\": [\n \"The reason field is required.\"\n ],\n \"from_date\": [\n \"The from date field is required.\"\n ],\n \"to_date\": [\n \"The to date field is required.\"\n ],\n \"from_time\": [\n \"The from time field is required when partial leave is checked.\"\n ],\n \"to_time\": [\n \"The to time field is required when partial leave is checked.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the leave request.\"\n}", "name": "" } ] }, { "name": "Remove the specified leave request.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/leave-requests\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/leave-requests\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the leave request to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a leave request item based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Leave request deleted successfully.\",\n \"id\": 1,\n \"type\": \"leave_request\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Leave request not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the leave request.\"\n}", "name": "" } ] } ] }, { "name": "Notification Management", "description": "", "item": [ { "name": "List or search notifications.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/:id", "query": [ { "key": "search", "value": "Alert", "description": "optional The search term to filter notifications by title, message and id.", "disabled": false }, { "key": "sort", "value": "title", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, title, message, type, status, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "status", "value": "unread", "description": "optional The status of the notification to filter by. Can be \"read\" or \"unread\".", "disabled": false }, { "key": "type", "value": "project", "description": "optional The type of notifications to filter by.", "disabled": false }, { "key": "user_id", "value": "1", "description": "optional The user ID to filter notifications by.", "disabled": false }, { "key": "client_id", "value": "5", "description": "optional The client ID to filter notifications by.", "disabled": false }, { "key": "notification_type", "value": "system", "description": "optional The notification type to filter by. Can be \"system\" or \"push\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of notifications per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/notifications\/:id?search=Alert&sort=title&order=ASC&status=unread&type=project&user_id=1&client_id=5¬ification_type=system&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the meeting to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of notifications based on various filters. The user must be authenticated to perform this action. The request allows filtering by status, type, user, client, and other parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Notifications retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 116,\n \"title\": \"Task Status Updated\",\n \"users\": [\n {\n \"id\": 183,\n \"first_name\": \"Girish\",\n \"last_name\": \"Thacker\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"clients\": [\n {\n \"id\": 102,\n \"first_name\": \"Test\",\n \"last_name\": \"Client\",\n \"photo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/photos\/no-image.jpg\"\n }\n ],\n \"type\": \"Task\",\n \"type_id\": 268,\n \"message\": \"Madhavan Vaidya has updated the status of task sdff, ID:#268, from Default to Test From Pro.\",\n \"status\": \"Unread\",\n \"read_at\": null,\n \"created_at\": \"23-07-2024 17:50:09\",\n \"updated_at\": \"23-07-2024 19:08:16\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Notification not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Notifications not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Remove the specified notification.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/notifications\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the notification to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a notification based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Notification deleted successfully.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Notification not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the notification.\"\n}", "name": "" } ] }, { "name": "Mark notification(s) as read.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/notifications\/mark-as-read\/:id", "query": [], "raw": "{{baseUrl}}\/api\/notifications\/mark-as-read\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the notification to mark as read." } ] }, "method": "PATCH", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint marks a specific notification as read if a notification ID is provided.\nIf no ID is provided, it will mark all unread notifications as read for the authenticated user.\nThe user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Notification marked as read successfully.\"\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"All notifications marked as read successfully.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Notification not found.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"Failed to mark notifications as read.\"\n}", "name": "" } ] } ] }, { "name": "Activity Log Management", "description": "", "item": [ { "name": "List or search activity logs.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activity-log\/:id", "query": [ { "key": "search", "value": "update", "description": "optional The search term to filter activity logs.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "optional The start date range's start in YYYY-MM-DD format.", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "optional The end date range's end in YYYY-MM-DD format.", "disabled": false }, { "key": "user_id", "value": "1", "description": "optional The user ID to filter activity logs by.", "disabled": false }, { "key": "client_id", "value": "5", "description": "optional The client ID to filter activity logs by.", "disabled": false }, { "key": "activity", "value": "update", "description": "optional The activity type to filter by.", "disabled": false }, { "key": "type", "value": "task", "description": "optional The type of activity to filter by.", "disabled": false }, { "key": "type_id", "value": "10", "description": "optional The type ID to filter activity logs by.", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of logs per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/activity-log\/:id?search=update&sort=created_at&order=ASC&date_from=2024-01-01&date_to=2024-12-31&user_id=1&client_id=5&activity=update&type=task&type_id=10&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the activity log to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of activity logs based on various filters. The user must be authenticated to perform this action. The request allows filtering by date ranges, user, client, activity type, and other parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Activity logs retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 974,\n \"actor_id\": 183,\n \"actor_name\": \"Girish Thacker\",\n \"actor_type\": \"User\",\n \"type_id\": 31,\n \"parent_type_id\": \"\",\n \"type\": \"Payslip\",\n \"parent_type\": \"\",\n \"type_title\": \"CTR-31\",\n \"parent_type_title\": \"\",\n \"activity\": \"Created\",\n \"message\": \"Girish Thacker created payslip PSL-31\",\n \"created_at\": \"06-08-2024 18:10:41\",\n \"updated_at\": \"06-08-2024 18:10:41\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Activity logs not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Remove the specified activity log.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/activity-log\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/activity-log\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the activity log to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a activity log based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Record deleted successfully.\",\n \"title\": null,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Record not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the activity log.\"\n}", "name": "" } ] } ] }, { "name": "Role\/Permission Management", "description": "", "item": [ { "name": "List or search roles.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/roles\/:id", "query": [ { "key": "search", "value": "Admin", "description": "optional The search term to filter roles by id, name or guard_name.", "disabled": false }, { "key": "sort", "value": "name", "description": "optional The field to sort by. all fields are sortable. Defaults to \"created_at\".", "disabled": false }, { "key": "order", "value": "asc", "description": "optional The sort order, either \"asc\" or \"desc\". Defaults to \"desc\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of roles per page for pagination. Defaults to 10.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results. Defaults to 0.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/roles\/:id?search=Admin&sort=name&order=asc&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the role to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of roles based on various filters. The request allows filtering by search term and pagination parameters.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Roles retrieved successfully.\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Admin\",\n \"guard_name\": \"web\",\n \"created_at\": \"10-10-2023 17:50:09\",\n \"updated_at\": \"23-07-2024 19:08:16\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Role not found.\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Roles not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while retrieving the roles.\"\n}", "name": "" } ] }, { "name": "Check user permissions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permissions\/:permission", "query": [], "raw": "{{baseUrl}}\/api\/permissions\/:permission", "variable": [ { "id": "permission", "key": "permission", "value": "%22edit-post%22%0A%0AHere+is+the+module-wise+permissions+list.%0A%0AActivity+Log%3A%0A-+manage_activity_log%0A-+delete_activity_log%0A%0AAllowances%3A%0A-+create_allowances%0A-+manage_allowances%0A-+edit_allowances%0A-+delete_allowances%0A%0AClients%3A%0A-+create_clients%0A-+manage_clients%0A-+edit_clients%0A-+delete_clients%0A%0AContract+Types%3A%0A-+create_contract_types%0A-+manage_contract_types%0A-+edit_contract_types%0A-+delete_contract_types%0A%0AContracts%3A%0A-+create_contracts%0A-+manage_contracts%0A-+edit_contracts%0A-+delete_contracts%0A%0ADeductions%3A%0A-+create_deductions%0A-+manage_deductions%0A-+edit_deductions%0A-+delete_deductions%0A%0AEstimates%2FInvoices%3A%0A-+create_estimates_invoices%0A-+manage_estimates_invoices%0A-+edit_estimates_invoices%0A-+delete_estimates_invoices%0A%0AExpense+Types%3A%0A-+create_expense_types%0A-+manage_expense_types%0A-+edit_expense_types%0A-+delete_expense_types%0A%0AExpenses%3A%0A-+create_expenses%0A-+manage_expenses%0A-+edit_expenses%0A-+delete_expenses%0A%0AItems%3A%0A-+create_items%0A-+manage_items%0A-+edit_items%0A-+delete_items%0A%0AMedia%3A%0A-+create_media%0A-+manage_media%0A-+delete_media%0A%0AMeetings%3A%0A-+create_meetings%0A-+manage_meetings%0A-+edit_meetings%0A-+delete_meetings%0A%0AMilestones%3A%0A-+create_milestones%0A-+manage_milestones%0A-+edit_milestones%0A-+delete_milestones%0A%0APayment+Methods%3A%0A-+create_payment_methods%0A-+manage_payment_methods%0A-+edit_payment_methods%0A-+delete_payment_methods%0A%0APayments%3A%0A-+create_payments%0A-+manage_payments%0A-+edit_payments%0A-+delete_payments%0A%0APayslips%3A%0A-+create_payslips%0A-+manage_payslips%0A-+edit_payslips%0A-+delete_payslips%0A%0APriorities%3A%0A-+create_priorities%0A-+manage_priorities%0A-+edit_priorities%0A-+delete_priorities%0A%0AProjects%3A%0A-+create_projects%0A-+manage_projects%0A-+edit_projects%0A-+delete_projects%0A%0AStatuses%3A%0A-+create_statuses%0A-+manage_statuses%0A-+edit_statuses%0A-+delete_statuses%0A%0ASystem+Notifications%3A%0A-+manage_system_notifications%0A-+delete_system_notifications%0A%0ATags%3A%0A-+create_tags%0A-+manage_tags%0A-+edit_tags%0A-+delete_tags%0A%0ATasks%3A%0A-+create_tasks%0A-+manage_tasks%0A-+edit_tasks%0A-+delete_tasks%0A%0ATaxes%3A%0A-+create_taxes%0A-+manage_taxes%0A-+edit_taxes%0A-+delete_taxes%0A%0ATimesheet%3A%0A-+create_timesheet%0A-+manage_timesheet%0A-+delete_timesheet%0A%0AUnits%3A%0A-+create_units%0A-+manage_units%0A-+edit_units%0A-+delete_units%0A%0AUsers%3A%0A-+create_users%0A-+manage_users%0A-+edit_users%0A-+delete_users%0A%0AWorkspaces%3A%0A-+create_workspaces%0A-+manage_workspaces%0A-+edit_workspaces%0A-+delete_workspaces", "description": "optional The specific permission to check." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint checks the module-wise permissions assigned to the authenticated user.\nIf a specific permission is provided in the URL, it checks only that permission for the authenticated user.\nOtherwise, it returns all permissions for the authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Permissions check completed.\",\n \"data\": {\n \"permissions\": {\n \"create_projects\": true,\n \"manage_projects\": false,\n ...\n }\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while checking the permission.\"\n}", "name": "" } ] }, { "name": "Create a new role.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/roles\/store", "query": [], "raw": "{{baseUrl}}\/api\/roles\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\\\"Supervisor\\\"\",\"permissions\":[1,2,3]}" }, "description": "This endpoint allows authenticated users to create a new role and assign permissions." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Role created successfully.\",\n \"role\": {\n \"id\": 5,\n \"name\": \"Supervisor\",\n \"permissions\": [\"edit_tasks\", \"assign_tasks\"]\n }\n}", "name": "" }, { "header": [], "code": 409, "body": "{\n \"error\": true,\n \"message\": \"A role `Manager` already exists.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation failed.\",\n \"errors\": {\n \"name\": [\"The name field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the role.\"\n}", "name": "" } ] }, { "name": "Update an existing role.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/roles\/update\/:id", "query": [], "raw": "{{baseUrl}}\/api\/roles\/update\/:id", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "The ID of the role to update." } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\\\"Supervisor\\\"\",\"permissions\":[1,2,3]}" }, "description": "This endpoint allows authenticated users to update a role name and modify its permissions." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Role updated successfully.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Role not found.\"\n}", "name": "" }, { "header": [], "code": 409, "body": "{\n \"error\": true,\n \"message\": \"A role `Manager` already exists.\"\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation failed.\",\n \"errors\": {\n \"name\": [\"The name field is required.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the role.\"\n}", "name": "" } ] }, { "name": "Delete a role.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/roles\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/roles\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the role to delete." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint allows authenticated users to delete a specific role." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Role deleted successfully.\"\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Role not found.\"\n}", "name": "" }, { "header": [], "code": 409, "body": "{\n \"error\": true,\n \"message\": \"Cannot delete this role because it is assigned to users.\"\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the role.\"\n}", "name": "" } ] }, { "name": "Get a specific role with its permissions, grouped by category.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/roles\/get\/:id", "query": [], "raw": "{{baseUrl}}\/api\/roles\/get\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the role to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"role\": {\n \"id\": 1,\n \"name\": \"Admin\",\n \"permissions\": {\n \"projects\": {\n \"create_projects\": true,\n \"delete_projects\": false\n },\n \"tasks\": {\n \"create_tasks\": true\n }\n }\n }\n}", "name": "" } ] }, { "name": "List all permissions.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/permissions-list", "query": [], "raw": "{{baseUrl}}\/api\/permissions-list" }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of all permissions.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Permissions retrieved successfully.\",\n \"total\": 5,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"create_projects\",\n \"guard_name\": \"web\",\n \"created_at\": \"2023-10-10T17:50:09.000000Z\",\n \"updated_at\": \"2024-07-23T19:08:16.000000Z\"\n },\n ...\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Permissions not found.\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while retrieving the permissions.\"\n}", "name": "" } ] } ] }, { "name": "Setting Management", "description": "", "item": [ { "name": "Retrieve the settings for a specific variable.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/settings\/:variable", "query": [], "raw": "{{baseUrl}}\/api\/settings\/:variable", "variable": [ { "id": "variable", "key": "variable", "value": "general_settings", "description": "The variable type for which settings are to be retrieved. Must be one of the following: general_settings, pusher_settings, email_settings, media_storage_settings, sms_gateway_settings, whatsapp_settings, privacy_policy, about_us, terms_conditions." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint returns the settings for a given variable. The user must be authenticated." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Settings retrieved successfully\",\n \"settings\": {\n \"company_title\": \"Taskify\",\n \"currency_full_form\": \"Indian Rupee\",\n \"currency_symbol\": \"\u20b9\",\n \"currency_code\": \"INR\",\n \"currency_symbol_position\": \"before\",\n \"currency_formate\": \"comma_separated\",\n \"decimal_points_in_currency\": \"2\",\n \"allowed_max_upload_size\": \"2000\",\n \"allowSignup\": 1,\n \"timezone\": \"Asia\/Kolkata\",\n \"date_format\": \"DD-MM-YYYY|d-m-Y\",\n \"time_format\": \"H:i:s\",\n \"toast_position\": \"toast-bottom-center\",\n \"toast_time_out\": \"2\",\n \"footer_text\": \"

made with \u2764\ufe0f by Infinitie Technologies<\/a><\/p>\",\n \"full_logo\": \"https:\/\/test-taskify.infinitietech.com\/storage\/logos\/zEy4tSCAFSMczWbOoxBZ3B43Nc9eeqMlNBXDrOzn.png\",\n \"half_logo\": null,\n \"favicon\": \"https:\/\/test-taskify.infinitietech.com\/storage\/logos\/2FZTNY1qDTz7CTtwWC8Hh1eY4l7cIHgOXG2stVIU.png\"\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Un Authorized Action!\"\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Setting not found\"\n}", "name": "" } ] }, { "name": "Store the settings for a specific variable.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/settings\/update", "query": [], "raw": "{{baseUrl}}\/api\/settings\/update", "variable": [ { "id": "variable", "key": "variable", "value": "general_settings", "description": "The variable type for which settings are to be stored. Must be one of the following: general_settings, pusher_settings, email_settings, media_storage_settings, sms_gateway_settings, whatsapp_settings, privacy_policy, about_us, terms_conditions." } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"variable\":\"general_settings\",\"company_title\":\"Taskify\",\"site_url\":\"https:\\\/\\\/www.taskify.com\",\"timezone\":\"Asia\\\/Kolkata\",\"currency_full_form\":\"Indian Rupee\",\"currency_symbol\":\"\u20b9\",\"currency_code\":\"INR\",\"date_format\":\"DD-MM-YYYY|d-m-Y\",\"toast_time_out\":\"2\",\"allowed_max_upload_size\":\"2000\"}" }, "description": "This endpoint stores the settings for a given variable. The user must be authenticated." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Settings saved successfully.\"\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Un Authorized Action!\"\n}", "name": "" } ] } ] }, { "name": "Expense Management", "description": "", "item": [ { "name": "Create a new expense.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/expenses\/store", "query": [], "raw": "{{baseUrl}}\/api\/expenses\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Finish report\"}" }, "description": "This endpoint creates a new expense item with the specified title, expense_type_id,user_id,amount,expense_date,note. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Expense created successfully.\",\n\"id\": 36,\n\"data\": {\n 'id' => '1',\n 'title' => 'Expense Title',\n 'expense_type_id' => '1',\n 'user_id' => '1',\n 'amount' => '100.00',\n 'expense_date' => '2023-10-01',\n 'note' => 'Expense note',\n 'created_by' => 'John Doe',\n 'created_at' => format_date($exp->created_at, true),\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ],\n \"expense_type_id\": [\n \"The expense type field is required.\"\n ],\n \"user_id\": [\n \"The user id field is required.\"\n ],\n \"amount\": [\n \"The amount field is required.\"\n ],\n \"expense_date\": [\n \"The expense date field is required.\"\n ],\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the expense.\"\n}", "name": "" } ] }, { "name": "List or search expenses.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/expenses\/:id", "query": [ { "key": "search", "value": "Lunch", "description": "optional Search keyword for title, amount, note, or ID.", "disabled": false }, { "key": "sort", "value": "title", "description": "optional Column to sort by. Default: id. Allowed: id, title, created_at, updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional Sort order: ASC or DESC. Default: DESC.", "disabled": false }, { "key": "limit", "value": "10", "description": "optional Number of records per page.", "disabled": false }, { "key": "offset", "value": "", "description": "optional Offset for pagination.", "disabled": true }, { "key": "type_ids[][0]", "value": 1, "description": "optional Filter by expense type IDs.", "disabled": false }, { "key": "type_ids[][1]", "value": 2, "description": "optional Filter by expense type IDs.", "disabled": false }, { "key": "user_ids[][0]", "value": 3, "description": "optional Filter by user IDs.", "disabled": false }, { "key": "user_ids[][1]", "value": 5, "description": "optional Filter by user IDs.", "disabled": false }, { "key": "date_from", "value": "2023-01-01", "description": "date optional Start date for expense_date filtering.", "disabled": false }, { "key": "date_to", "value": "2023-01-31", "description": "date optional End date for expense_date filtering.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/expenses\/:id?search=Lunch&sort=title&order=ASC&limit=10&offset=&type_ids[][0]=1&type_ids[][1]=2&user_ids[][0]=3&user_ids[][1]=5&date_from=2023-01-01&date_to=2023-01-31", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the expense to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "Retrieve a paginated list of expenses or a single expense by ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Expenses retrieved successfully\",\n \"total\": 2,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Travel Reimbursement\",\n \"expense_type_id\": 2,\n \"expense_type\": \"Travel\",\n \"user_id\": 5,\n \"user\": {\n \"id\": 5,\n \"first_name\": \"Alice\",\n \"last_name\": \"Smith\",\n \"email\": \"alice@example.com\",\n \"photo\": \"https:\/\/yourdomain.com\/storage\/photos\/alice.jpg\"\n },\n \"amount\": \"150.00\",\n \"expense_date\": \"2023-10-01\",\n \"note\": \"Flight ticket\",\n \"created_by\": \"John Doe\",\n \"created_at\": \"2023-10-01\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 404, "body": "{\n \"error\": true,\n \"message\": \"Expense not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Update a existing expense.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/expenses\/update", "query": [], "raw": "{{baseUrl}}\/api\/expenses\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"1\",\"title\":\"Finish report\",\"expense_type_id\":\"1\",\"user_id\":\"1\",\"amount\":\"Finish report\",\"expense_date\":\"2024-08-07\",\"note\":\"Finish report\"}" }, "description": "This endpoint update existing expense item with the specified title, expense_type_id,user_id,amount,expense_date,note. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Expense created successfully.\",\n\"id\": 36,\n\"data\": {\n 'id' => '1',\n 'title' => 'Expense Title',\n 'expense_type_id' => '1',\n 'user_id' => '1',\n 'amount' => '100.00',\n 'expense_date' => '2023-10-01',\n 'note' => 'Expense note',\n 'created_by' => 'John Doe',\n 'created_at' => format_date($exp->created_at, true),\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ],\n \"expense_type_id\": [\n \"The expense type field is required.\"\n ],\n \"user_id\": [\n \"The user id field is required.\"\n ],\n \"amount\": [\n \"The amount field is required.\"\n ],\n \"expense_date\": [\n \"The expense date field is required.\"\n ],\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the expense.\"\n}", "name": "" } ] }, { "name": "Remove the specified expense.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/expenses\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/expenses\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the todo to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a expense item based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Expense deleted successfully.\",\n \"id\": 1,\n \"title\": \"Expense Title\"\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Expense not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the expense.\"\n}", "name": "" } ] }, { "name": "Create a new expense type.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/expenses\/expense-types\/store", "query": [], "raw": "{{baseUrl}}\/api\/expenses\/expense-types\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Finish report\",\"description\":\"Finish report\"}" }, "description": "This endpoint creates a new expense type item with the specified title, description. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Expense Type created successfully.\",\n\"id\": 1,\n\"data\": {\n 'id' => '1',\n 'title' => 'Expense Title',\n 'description' => 'Expense Description',\n 'created_at' => 2023-10-01 12:00:00',\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ],\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the expense type.\"\n}", "name": "" } ] }, { "name": "List or search expense types.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/expenses\/expense-types\/list\/:id", "query": [ { "key": "search", "value": "Travel", "description": "optional Search term for title, description, or ID.", "disabled": false }, { "key": "sort", "value": "title", "description": "optional Field to sort by. Defaults to `id`. Sortable fields: `id`, `title`, `created_at`, `updated_at`.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional Sort order: `ASC` or `DESC`. Defaults to `DESC`.", "disabled": false }, { "key": "limit", "value": "10", "description": "optional Number of items per page. Default is 10.", "disabled": false }, { "key": "offset", "value": "", "description": "optional Number of items to skip (for pagination). Default is 0.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/expenses\/expense-types\/list\/:id?search=Travel&sort=title&order=ASC&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the specific expense type to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "Retrieve a list of expense types, optionally filtered by search term or a specific ID.\nSupports sorting, pagination, and workspace scoping. Authentication is required." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Expense type retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Travel\",\n \"description\": \"Travel expenses\",\n \"created_at\": \"2023-10-01\"\n }\n ]\n}", "name": "Single Expense Type Found" }, { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Expense types retrieved successfully\",\n \"total\": 2,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Travel\",\n \"description\": \"Travel expenses\",\n \"created_at\": \"2023-10-01\"\n },\n {\n \"id\": 2,\n \"title\": \"Office Supplies\",\n \"description\": \"Stationery and office supplies\",\n \"created_at\": \"2023-10-03\"\n }\n ]\n}", "name": "Multiple Expense Types Found" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Expense type not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "No Results Found" } ] }, { "name": "Update an existing expense type.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/expenses\/expense-types\/update", "query": [], "raw": "{{baseUrl}}\/api\/expenses\/expense-types\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"1\",\"title\":\"Finish report\",\"description\":\"Finish report\"}" }, "description": "This endpoint update an existing expense type item with the specified title, description. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Expense Type created successfully.\",\n\"id\": 1,\n\"data\": {\n 'id' => '1',\n 'title' => 'Expense Title',\n 'description' => 'Expense Description',\n 'created_at' => 2023-10-01 12:00:00',\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"title\": [\n \"The title field is required.\"\n ],\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the expense type.\"\n}", "name": "" } ] }, { "name": "Remove the specified expense type.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/expenses\/expense-types\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/expenses\/expense-types\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the todo to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a expense type item based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Expense Type deleted successfully.\",\n \"id\": 1,\n \"title\": \"Expense Type Title\"\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Expense Type not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the expense type.\"\n}", "name": "" } ] } ] }, { "name": "Payment Management", "description": "", "item": [ { "name": "Create a new payment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payments\/store", "query": [], "raw": "{{baseUrl}}\/api\/payments\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"user_id\":\"1\",\"invoice_id\":\"1\",\"payment_method_id\":\"1\",\"amount\":\"100\",\"payment_date\":\"2024-08-07\",\"note\":\"Finish report\"}" }, "description": "This endpoint creates a new payment with the specified user_id, invoice_id,payment_method_id,amount,payment_date,note. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Payment created successfully.\",\n\"id\": 36,\n\"data\": {\n 'id' => '1',\n 'user_id' => '1',\n 'invoice_id' => '1',\n 'payment_method_id' => '1',\n 'amount' => '100.00',\n 'payment_date' => '2023-10-01',\n 'note' => 'Payment note',\n 'created_at' => format_date($exp->created_at, true),\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"user_id\": [\n \"The user_id field is required.\"\n ],\n \"invoice_id\": [\n \"The invoice_id field is required.\"\n ],\n \"payment_method_id\": [\n \"The payment method id field is required.\"\n ],\n \"amount\": [\n \"The amount field is required.\"\n ],\n \"payment_date\": [\n \"The payment date field is required.\"\n ],\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the payment.\"\n}", "name": "" } ] }, { "name": "List or search payments.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payments\/:id", "query": [ { "key": "search", "value": "Title", "description": "optional The search term to filter tags by title or id.", "disabled": false }, { "key": "sort", "value": "id", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of tags per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/payments\/:id?search=Title&sort=id&order=ASC&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the tag to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of payments based on various filters. The user must be authenticated to perform this action. The request allows searching and sorting by different parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Payment retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n\"id\": 1,\n\"user_id\": 1,\n\"user\": {\n\"id\": 1,\n\"first_name\": \"Admin\",\n\"last_name\": \"User\",\n\"email\": \"admin@gmail.com\",\n\"photo\": \"https:\/\/dev-taskify.taskhub.company\/storage\/photos\/C03PJmIQInts2j3O2on99Nilu45UcChrepcsIFxO.jpg\"\n},\n\"invoice_id\": null,\n\"invoice\": \"-\",\n\"payment_method_id\": 1,\n\"payment_method\": \"some\",\n\"amount\": \"\u20b9 100.00\",\n\"payment_date\": \"2025-04-16\",\n\"note\": \"123\",\n\"created_by\": \"Admin User\",\n\"created_at\": \"2025-04-16 09:41:57\",\n\"updated_at\": \"2025-04-16 09:41:57\"\n}\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Payment not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Payments not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Update an existing payment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payments\/update", "query": [], "raw": "{{baseUrl}}\/api\/payments\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"quia\",\"user_id\":\"1\",\"invoice_id\":\"1\",\"payment_method_id\":\"1\",\"amount\":\"100\",\"payment_date\":\"2024-08-07\",\"note\":\"Finish report\"}" }, "description": "This endpoint updates an existing payment with the specified user_id, invoice_id,payment_method_id,amount,payment_date,note. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Payment created successfully.\",\n\"id\": 36,\n\"data\": {\n 'id' => '1',\n 'user_id' => '1',\n 'invoice_id' => '1',\n 'payment_method_id' => '1',\n 'amount' => '100.00',\n 'payment_date' => '2023-10-01',\n 'note' => 'Payment note',\n 'created_at' => format_date($exp->created_at, true),\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"user_id\": [\n \"The user_id field is required.\"\n ],\n \"invoice_id\": [\n \"The invoice_id field is required.\"\n ],\n \"payment_method_id\": [\n \"The payment method id field is required.\"\n ],\n \"amount\": [\n \"The amount field is required.\"\n ],\n \"payment_date\": [\n \"The payment date field is required.\"\n ],\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the payment.\"\n}", "name": "" } ] }, { "name": "Remove the specified payment.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payments\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/payments\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the todo to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a payment based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Payment deleted successfully.\",\n \"id\": 1,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Payment not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the Payment.\"\n}", "name": "" } ] } ] }, { "name": "Payment Method Management", "description": "", "item": [ { "name": "List or search payments methods.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-methods\/:id", "query": [ { "key": "search", "value": "Title", "description": "optional The search term to filter tags by title or id.", "disabled": false }, { "key": "sort", "value": "id", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of tags per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/payment-methods\/:id?search=Title&sort=id&order=ASC&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the tag to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of payments methods based on various filters. The user must be authenticated to perform this action. The request allows searching and sorting by different parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Payment Method retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n\"id\": 1,\n\"title\": \"Payment Method Title\",\n\"created_at\": \"2025-04-16 09:41:57\",\n\"updated_at\": \"2025-04-16 09:41:57\"\n}\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Payment Method not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Payment Methods not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Create a payment method.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-methods\/store", "query": [], "raw": "{{baseUrl}}\/api\/payment-methods\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Title\"}" }, "description": "This endpoint creates a payment method. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Payment Method created successfully.\",\n\"id\": 36,\n\"data\": {\n 'id' => '1',\n 'title' => 'Title',\n 'created_at =>'2025-04-16',\n 'updated_at' =>'2025-04-16',\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ],\n \"title\": [\n \"The title field is required.\"\n ],\n\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the payment method.\"\n}", "name": "" } ] }, { "name": "Update an existing payment method.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-methods\/update", "query": [], "raw": "{{baseUrl}}\/api\/payment-methods\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"vero\",\"title\":\"Title\"}" }, "description": "This endpoint updates an existing payment method with the specified id. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Payment Method created successfully.\",\n\"id\": 36,\n\"data\": {\n 'id' => '1',\n 'title' => 'Title',\n 'created_at =>'2025-04-16',\n 'updated_at' =>'2025-04-16',\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ],\n \"title\": [\n \"The title field is required.\"\n ],\n\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the payment method.\"\n}", "name": "" } ] }, { "name": "Remove the specified payment method.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/payment-methods\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/payment-methods\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the todo to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a payment method based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Payment Method deleted successfully.\",\n \"id\": 1,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Payment Method not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the Payment Method.\"\n}", "name": "" } ] } ] }, { "name": "Tax Management", "description": "", "item": [ { "name": "List or search taxes.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/taxes\/:id", "query": [ { "key": "search", "value": "GST", "description": "optional The term to search taxes by title, amount, percentage, type, or ID.", "disabled": false }, { "key": "sort", "value": "created_at", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, created_at, updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sorting order, either ASC or DESC. Defaults to DESC.", "disabled": false }, { "key": "types[0]", "value": "percentage", "description": "optional Filter taxes by type. Accepts an array of types such as \"percentage\" or \"fixed\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional Number of records per page. Defaults to 10.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination. Defaults to 0.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/taxes\/:id?search=GST&sort=created_at&order=ASC&types[0]=percentage&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the tax to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of taxes based on various filters. The user must be authenticated to perform this action.\nIt supports searching, sorting, filtering by type, and pagination." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Taxes retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"GST\",\n \"type\": \"percentage\",\n \"amount\": null,\n \"percentage\": 18,\n \"created_at\": \"2025-04-16\",\n \"updated_at\": \"2025-04-16\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Tax retrieved successfully\",\n \"total\": 1,\n \"data\": {\n \"id\": 1,\n \"title\": \"GST\",\n \"type\": \"percentage\",\n \"amount\": null,\n \"percentage\": 18,\n \"created_at\": \"2025-04-16\",\n \"updated_at\": \"2025-04-16\"\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Tax not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Create a tax.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/taxes\/store", "query": [], "raw": "{{baseUrl}}\/api\/taxes\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Title\",\"type\":\"amount\",\"amount\":\"100\",\"percentage\":\"10\"}" }, "description": "This endpoint creates a tax. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Tax created successfully.\",\n\"id\": 36,\n\"data\": {\n 'id' => '1',\n 'title' => 'Title',\n 'type' => 'amount',\n 'amount' => '100',\n 'percentage' => null,\n 'created_at =>'2025-04-16',\n 'updated_at' =>'2025-04-16',\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ],\n \"title\": [\n \"The title field is required.\"\n ],\n \"type\": [\n \"The type field is required.\"\n ],\n\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the tax.\"\n}", "name": "" } ] }, { "name": "Update a tax.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/taxes\/update", "query": [], "raw": "{{baseUrl}}\/api\/taxes\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"1\",\"title\":\"Title\"}" }, "description": "This endpoint updates an existing tax. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Tax updated successfully.\",\n\"id\": 36,\n\"data\": {\n 'id' => '1',\n 'title' => 'Title',\n 'type' => 'amount',\n 'amount' => '100',\n 'percentage' => null,\n 'created_at =>'2025-04-16',\n 'updated_at' =>'2025-04-16',\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ],\n \"title\": [\n \"The title field is required.\"\n ],\n\n\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the tax.\"\n}", "name": "" } ] }, { "name": "Remove the specified tax.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/taxes\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/taxes\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the todo to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a tax based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Tax deleted successfully.\",\n \"id\": 1,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Tax not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the Tax.\"\n}", "name": "" } ] } ] }, { "name": "Unit Management", "description": "", "item": [ { "name": "List or search units.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/units\/:id", "query": [ { "key": "search", "value": "Title", "description": "optional The search term to filter tags by title or id.", "disabled": false }, { "key": "sort", "value": "id", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of tags per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination, indicating the starting point of results.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/units\/:id?search=Title&sort=id&order=ASC&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the tag to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of units based on various filters. The user must be authenticated to perform this action. The request allows searching and sorting by different parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Unit retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n\"id\": 1,\n\"title\": \"title\",\n\"description\" : \"unit description\",\n\"created_at\": \"2025-04-16 09:41:57\",\n\"updated_at\": \"2025-04-16 09:41:57\"\n}\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Unit not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Units not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Create an unit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/units\/store", "query": [], "raw": "{{baseUrl}}\/api\/units\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"Title\",\"description\":\"amount\"}" }, "description": "This endpoint creates an unit. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Unit created successfully.\",\n\"id\": 36,\n\"data\": {\n 'id' => '1',\n 'title' => 'Title',\n 'description' => 'Unit Description',\n 'created_at =>'2025-04-16',\n 'updated_at' =>'2025-04-16',\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n\n \"title\": [\n \"The title field is required.\"\n ],\n\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the unit.\"\n}", "name": "" } ] }, { "name": "Update an unit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/units\/update", "query": [], "raw": "{{baseUrl}}\/api\/units\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"1\",\"title\":\"Title\",\"description\":\"unit description\"}" }, "description": "This endpoint updates an unit. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Unit created successfully.\",\n\"id\": 36,\n\"data\": {\n 'id' => '1',\n 'title' => 'Title',\n 'description' => 'Unit Description',\n 'created_at =>'2025-04-16',\n 'updated_at' =>'2025-04-16',\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The title id is required.\"\n ],\n \"title\": [\n \"The title field is required.\"\n ],\n\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the unit.\"\n}", "name": "" } ] }, { "name": "Remove the specified unit.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/units\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/units\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the todo to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a unit based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Unit deleted successfully.\",\n \"id\": 1,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Unit not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the Unit.\"\n}", "name": "" } ] } ] }, { "name": "Item Management", "description": "", "item": [ { "name": "Retrieve a list of items or a specific item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/items\/:id", "query": [ { "key": "search", "value": "Water+Bottle", "description": "optional Filter items by title, description, price, unit_id, or item ID.", "disabled": false }, { "key": "sort", "value": "title", "description": "optional Column to sort by. Defaults to \"id\". Available values: id, title, price, created_at, updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional Sort direction: ASC or DESC. Defaults to \"DESC\".", "disabled": false }, { "key": "unit_ids[0]", "value": 1, "description": "optional Filter items by one or more unit IDs.", "disabled": false }, { "key": "unit_ids[1]", "value": 2, "description": "optional Filter items by one or more unit IDs.", "disabled": false }, { "key": "unit_ids[2]", "value": 3, "description": "optional Filter items by one or more unit IDs.", "disabled": false }, { "key": "limit", "value": "15", "description": "optional Number of items to return. Default is 10.", "disabled": false }, { "key": "offset", "value": "20", "description": "optional Offset for paginated data. Default is 0.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/items\/:id?search=Water+Bottle&sort=title&order=ASC&unit_ids[0]=1&unit_ids[1]=2&unit_ids[2]=3&limit=15&offset=20", "variable": [ { "id": "id", "key": "id", "value": "5", "description": "optional The ID of the item to retrieve a single record. If not provided, a list will be returned." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint fetches item records associated with the authenticated user's workspace. You can retrieve a single item by its ID or fetch a paginated list using filters such as search terms, sorting, unit filters, and pagination controls.\n\nFilters available:\n- **search**: Filter by title, description, price, unit ID, or item ID (partial match).\n- **unit_ids**: Filter by one or more unit IDs (exact match).\n- **id**: If provided, fetches a single item record with detailed fields." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Items Retrieved Successfully\",\n \"total\": 2,\n \"data\": [\n {\n \"id\": 1,\n \"title\": \"Notebook\",\n \"price\": \"\u20b9100.00\",\n \"unit_id\": 2,\n \"unit_name\": \"Piece\",\n \"description\": \"A ruled notebook\",\n \"created_at\": \"2025-05-01\",\n \"updated_at\": \"2025-05-04\"\n },\n ...\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Item Retrieved Successfully\",\n \"total\": 1,\n \"data\": {\n \"id\": 1,\n \"title\": \"Notebook\",\n \"price\": \"\u20b9100.00\",\n \"unit_id\": 2,\n \"unit_name\": \"Piece\",\n \"description\": \"A ruled notebook\",\n \"created_at\": \"2025-05-01\",\n \"updated_at\": \"2025-05-04\"\n }\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Item not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Items Not Found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Create an item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/items\/store", "query": [], "raw": "{{baseUrl}}\/api\/items\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"1\",\"title\":\"Title\",\"description\":\"description\",\"price\":\"400\",\"unit_id\":\"4\"}" }, "description": "This endpoint creates an item. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Item created successfully.\",\n\"id\": 36,\n\"data\": {\n \"id\": 1,\n\"title\": \"title\",\n\"price\" : 100,\n\"unit_id\": 1,\n\"description\" : \"description\",\n\"created_at\": \"2025-04-16 09:41:57\",\n\"updated_at\": \"2025-04-16 09:41:57\"\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ],\n \"title\": [\n \"The title field is required.\"\n ],\n\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the item.\"\n}", "name": "" } ] }, { "name": "Update an item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/items\/update", "query": [], "raw": "{{baseUrl}}\/api\/items\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"1\",\"title\":\"Title\",\"description\":\"description\",\"price\":\"400\",\"unit_id\":\"4\"}" }, "description": "This endpoint updates an item. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n\"error\": false,\n\"message\": \"Item updated successfully.\",\n\"id\": 36,\n\"data\": {\n \"id\": 1,\n\"title\": \"title\",\n\"price\" : 100,\n\"unit_id\": 1,\n\"description\" : \"description\",\n\"created_at\": \"2025-04-16 09:41:57\",\n\"updated_at\": \"2025-04-16 09:41:57\"\n }", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"id\": [\n \"The id field is required.\"\n ],\n \"title\": [\n \"The title field is required.\"\n ],\n\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the item.\"\n}", "name": "" } ] }, { "name": "Remove the specified item.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/items\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/items\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the item to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a item based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Item deleted successfully.\",\n \"id\": 1,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Item not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the Item.\"\n}", "name": "" } ] } ] }, { "name": "Estimate Invoice Management", "description": "", "item": [ { "name": "List or search estimate invoices.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/estimates-invoices", "query": [ { "key": "search", "value": "INVC-1001", "description": "optional The search term to filter invoices by id or note.", "disabled": false }, { "key": "sort", "value": "id", "description": "optional The field to sort by. Defaults to \"id\". Sortable fields include: id, created_at, and updated_at.", "disabled": false }, { "key": "order", "value": "ASC", "description": "optional The sort order, either \"ASC\" or \"DESC\". Defaults to \"DESC\".", "disabled": false }, { "key": "limit", "value": "10", "description": "optional The number of items per page for pagination.", "disabled": false }, { "key": "offset", "value": "", "description": "optional The offset for pagination.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/estimates-invoices?search=INVC-1001&sort=id&order=ASC&limit=10&offset=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "optional The ID of the estimate invoice to retrieve." } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint retrieves a list of estimate invoices based on various filters. The user must be authenticated to perform this action. The request allows searching and sorting by different parameters." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Estimate invoice retrieved successfully\",\n \"total\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"client\": {\n \"id\": 2,\n \"name\": \"John Doe\",\n \"email\": \"client@example.com\",\n \"photo\": \"https:\/\/example.com\/storage\/photos\/client.jpg\"\n },\n \"total\": \"\u20b9 1,000.00\",\n \"status\": \"Pending\",\n \"due_date\": \"2025-04-30\",\n \"created_by\": \"Admin User\",\n \"created_at\": \"2025-04-15\",\n \"updated_at\": \"2025-04-15\"\n }\n ]\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Estimate invoice not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Estimate invoices not found\",\n \"total\": 0,\n \"data\": []\n}", "name": "" } ] }, { "name": "Store a new invoice or estimate.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/estimates-invoices\/store", "query": [], "raw": "{{baseUrl}}\/api\/estimates-invoices\/store" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"invoice\",\"client_id\":1,\"name\":\"Website Development\",\"address\":\"123 Main St.\",\"city\":\"New York\",\"state\":\"NY\",\"country\":\"USA\",\"zip_code\":\"10001\",\"phone\":\"+1234567890\",\"note\":\"Handle with urgency\",\"personal_note\":\"Discussed pricing\",\"from_date\":\"2024-01-01\",\"to_date\":\"2024-01-31\",\"status\":\"draft\",\"total\":\"1000.00\",\"tax_amount\":\"100.00\",\"final_total\":\"1100.00\",\"item_ids\":[1,2],\"item\":[1,2],\"quantity\":[2,1],\"unit\":[1,2],\"rate\":[\"500.00\",\"1000.00\"],\"tax\":[1,2],\"amount\":[\"1000.00\",\"1000.00\"]}" }, "description": "This endpoint allows the creation of a new invoice or estimate by providing details such as client, dates, items, amount, and tax info.\nThe user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Estimate\/Invoice created successfully.\",\n \"data\": {\n \"id\": 1,\n \"type\": \"invoice\",\n \"client_id\": 1,\n \"from_date\": \"2024-01-01\",\n \"to_date\": \"2024-01-31\",\n \"total\": \"1000.00\",\n \"tax_amount\": \"100.00\",\n \"final_total\": \"1100.00\",\n \"status\": \"draft\",\n \"created_at\": \"2024-01-01T10:00:00.000000Z\",\n \"items\": [...]\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred\",\n \"errors\": {\n \"type\": [\n \"The type field is required.\"\n ],\n \"client_id\": [\n \"The client field is required.\"\n ],\n \"from_date\": [\n \"The from date field is required and must be before the to date.\"\n ],\n \"to_date\": [\n \"The to date field is required and must be after the from date.\"\n ],\n \"final_total\": [\n \"The final total field is required and must be a valid currency format.\"\n ]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while creating the estimate\/invoice.\"\n}", "name": "" } ] }, { "name": "Update an existing estimate or invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/estimates-invoices\/update", "query": [], "raw": "{{baseUrl}}\/api\/estimates-invoices\/update" }, "method": "POST", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" }, { "key": "Content-Type", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":5,\"type\":\"invoice\",\"client_id\":2,\"name\":\"Invoice April 2024\",\"address\":\"123 Main St\",\"city\":\"New York\",\"state\":\"NY\",\"country\":\"USA\",\"zip_code\":\"10001\",\"phone\":\"+1 1234567890\",\"note\":\"Payment due within 15 days\",\"personal_note\":\"Send reminder after 10 days\",\"from_date\":\"2024-04-01\",\"to_date\":\"2024-04-30\",\"status\":\"due\",\"total\":\"1000.00\",\"tax_amount\":\"100.00\",\"final_total\":\"1100.00\",\"item\":[1,2,3]}" }, "description": "This endpoint updates an existing estimate or invoice record with provided details including type, client, date range, financials, items, and notes.\nThe request must be authenticated." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Estimate\/Invoice updated successfully.\",\n \"data\": {\n \"id\": 5,\n \"type\": \"invoice\",\n \"client_id\": 2,\n \"from_date\": \"2024-04-01\",\n \"to_date\": \"2024-04-30\",\n \"total\": \"1000.00\",\n \"tax_amount\": \"100.00\",\n \"final_total\": \"1100.00\"\n }\n}", "name": "" }, { "header": [], "code": 422, "body": "{\n \"error\": true,\n \"message\": \"Validation errors occurred.\",\n \"errors\": {\n \"client_id\": [\"The client field is required.\"],\n \"from_date\": [\"The from date must be a valid date.\"],\n \"to_date\": [\"The to date must be a valid date.\"],\n \"total\": [\"The total format is invalid.\"],\n \"final_total\": [\"The final total format is invalid.\"]\n }\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while updating the estimate or invoice.\"\n}", "name": "" } ] }, { "name": "Remove the specified estimate invoice.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/estimates-invoices\/destroy\/:id", "query": [], "raw": "{{baseUrl}}\/api\/estimates-invoices\/destroy\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the todo to be deleted." } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application\/json" }, { "key": "workspace-id", "value": "1" } ], "body": null, "description": "This endpoint deletes a estimate invoice based on the provided ID. The user must be authenticated to perform this action." }, "response": [ { "header": [], "code": 200, "body": "{\n \"error\": false,\n \"message\": \"Estimate Invoice deleted successfully.\",\n \"id\": 1,\n \"data\": []\n}", "name": "" }, { "header": [], "code": 200, "body": "{\n \"error\": true,\n \"message\": \"Estimate Invoice not found.\",\n \"data\": []\n}", "name": "" }, { "header": [], "code": 500, "body": "{\n \"error\": true,\n \"message\": \"An error occurred while deleting the Estimate Invoice.\"\n}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }