{ "swagger": "2.0", "basePath": "/", "paths": { "/chat/channel/{channel_id}/message": { "parameters": [ { "name": "channel_id", "in": "path", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Discussion" } }, "400": { "description": "Bad request" } }, "summary": "Get all channels for an organization", "operationId": "post_send_chat_message", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Send message" } } ], "tags": [ "chat" ] } }, "/chat/{organization_id}": { "parameters": [ { "name": "organization_id", "in": "path", "required": true, "type": "integer" } ], "get": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Discussion" } }, "400": { "description": "Bad request" } }, "summary": "Get all channels for an organization", "operationId": "get_user_chats", "tags": [ "chat" ] } }, "/organizations": { "post": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Create organization", "operationId": "post_user_organizations", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Organization" } } ], "tags": [ "organizations" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Organization" } }, "400": { "description": "Bad request" } }, "summary": "Get user organizations", "operationId": "get_user_organizations", "tags": [ "organizations" ] } }, "/organizations/{organization_id}": { "parameters": [ { "in": "path", "description": "Id of the organization", "name": "organization_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Delete organization", "operationId": "delete_organization_actions", "tags": [ "organizations" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Update organization", "operationId": "put_organization_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Organization" } } ], "tags": [ "organizations" ] } }, "/organizations/{organization_id}/folders": { "parameters": [ { "in": "query", "description": "The id of the parent folder", "name": "folder_id", "type": "string" }, { "in": "path", "description": "Id of the organization", "name": "organization_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Create folder", "operationId": "post_organization_folders", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Folder" } } ], "tags": [ "organizations" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Folder" } }, "400": { "description": "Bad request" } }, "summary": "Get folders", "operationId": "get_organization_folders", "tags": [ "organizations" ] } }, "/organizations/{organization_id}/folders/{folder_id}": { "parameters": [ { "in": "path", "description": "The id of the parent folder", "name": "folder_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the organization", "name": "organization_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Delete folder", "operationId": "delete_organization_folders_actions", "tags": [ "organizations" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Update folder", "operationId": "put_organization_folders_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Folder" } } ], "tags": [ "organizations" ] } }, "/organizations/{organization_id}/folders/{folder_id}/archive": { "parameters": [ { "in": "path", "description": "The id of the parent folder", "name": "folder_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the organization", "name": "organization_id", "required": true, "type": "integer" } ], "put": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Archive folder", "operationId": "put_organization_folders_archive_actions", "tags": [ "organizations" ] } }, "/organizations/{organization_id}/members": { "parameters": [ { "in": "path", "description": "Id of the organization", "name": "organization_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Add organization member", "operationId": "post_organization_members", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Add Organization Member" } } ], "tags": [ "organizations" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Organization Member" } }, "400": { "description": "Bad request" } }, "summary": "Get organization members", "operationId": "get_organization_members", "tags": [ "organizations" ] } }, "/organizations/{organization_id}/members/search/{name}": { "parameters": [ { "in": "path", "description": "Name or username of the member to be searched in the organization", "name": "name", "required": true, "type": "string" }, { "in": "path", "description": "Id of the organization", "name": "organization_id", "required": true, "type": "integer" } ], "get": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Search organization members", "operationId": "get_search_organization_members", "tags": [ "organizations" ] } }, "/organizations/{organization_id}/members/{user_id}": { "parameters": [ { "in": "path", "description": "The id of the user to be removed from the organization", "name": "user_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the organization", "name": "organization_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Remove invited member", "operationId": "delete_organization_remove_invited_member", "tags": [ "organizations" ] } }, "/organizations/{organization_id}/projects": { "parameters": [ { "in": "path", "description": "Id of the organization", "name": "organization_id", "required": true, "type": "integer" } ], "get": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Project" } }, "400": { "description": "Bad request" } }, "summary": "Get projects in organization", "operationId": "get_organization_projects", "tags": [ "organizations" ] } }, "/projects": { "post": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Create project", "operationId": "post_get_projects", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Project" } } ], "tags": [ "projects" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Project" } }, "400": { "description": "Bad request" } }, "summary": "Get projects", "operationId": "get_get_projects", "tags": [ "projects" ] } }, "/projects/tasks/types/icons": { "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success" } }, "summary": "Get task types icons", "operationId": "get_get_types_icons", "tags": [ "project" ] } }, "/projects/{project_id}": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Delete project", "operationId": "delete_project_action", "tags": [ "projects" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Project" } }, "400": { "description": "Bad request" } }, "summary": "Get project", "operationId": "get_project_action", "tags": [ "projects" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Update project", "operationId": "put_project_action", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Project" } } ], "tags": [ "projects" ] } }, "/projects/{project_id}/archive": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "put": { "responses": { "401": { "description": "Unauthorized" }, "200": { "description": "OK" }, "400": { "description": "Bad request" } }, "summary": "Archive project", "operationId": "put_archive_project", "tags": [ "projects" ] } }, "/projects/{project_id}/create_webhook": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create or Update a project webhook", "operationId": "post_create_project_webhook", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Link Zendesk" } } ], "tags": [ "project" ] } }, "/projects/{project_id}/custom_fields": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create Custom field", "operationId": "post_project_custom_fields", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Custom Field" } } ], "tags": [ "project" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Custom Field" } } }, "summary": "Get project custom fields", "operationId": "get_project_custom_fields", "tags": [ "project" ] } }, "/projects/{project_id}/custom_fields/{uuid}": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" }, { "name": "uuid", "in": "path", "required": true, "type": "string" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Remove custom field", "operationId": "delete_project_custom_field", "tags": [ "project" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update custom field", "operationId": "put_project_custom_field", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Custom Field" } } ], "tags": [ "project" ] } }, "/projects/{project_id}/labels": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create label", "operationId": "post_get_labels", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Label" } } ], "tags": [ "project" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Label" } } }, "summary": "Get labels", "operationId": "get_get_labels", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "project" ] } }, "/projects/{project_id}/labels/{label_id}": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" }, { "name": "label_id", "in": "path", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Delete label", "operationId": "delete_label_actions", "tags": [ "project" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update label", "operationId": "put_label_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Label" } } ], "tags": [ "project" ] } }, "/projects/{project_id}/lists": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create list", "operationId": "post_get_lists", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create List" } } ], "tags": [ "project" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/List" } } }, "summary": "Get lists", "operationId": "get_get_lists", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "project" ] } }, "/projects/{project_id}/lists/{list_id}": { "parameters": [ { "in": "path", "description": "Id of the list", "name": "list_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Delete list", "operationId": "delete_list_actions", "tags": [ "project" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/List" } } }, "summary": "List details", "operationId": "get_list_actions", "tags": [ "project" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update list", "operationId": "put_list_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update List" } } ], "tags": [ "project" ] } }, "/projects/{project_id}/lists/{list_id}/tasks": { "parameters": [ { "in": "path", "description": "Id of the list", "name": "list_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create task", "operationId": "post_get_list_tasks", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Task" } } ], "tags": [ "task" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task" } } }, "summary": "Get tasks in list", "operationId": "get_get_list_tasks", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "task" ] } }, "/projects/{project_id}/lists_and_views": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Lists and view getter", "operationId": "get_project_views_and_lists", "tags": [ "project" ] } }, "/projects/{project_id}/members": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Project Member" } } }, "summary": "Add member", "operationId": "post_add_member", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Add Project Member" } } ], "tags": [ "project" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Project Member" } } }, "summary": "Get project members", "operationId": "get_add_member", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "project" ] } }, "/projects/{project_id}/members/{user_id}": { "parameters": [ { "in": "path", "description": "Id of the user", "name": "user_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Remove member", "operationId": "delete_remove_member", "tags": [ "project" ] } }, "/projects/{project_id}/milestones": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create milestone", "operationId": "post_get_milestones", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Milestone" } } ], "tags": [ "project" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Milestone" } } }, "summary": "Get milestones", "operationId": "get_get_milestones", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "project" ] } }, "/projects/{project_id}/milestones/{milestone_id}": { "parameters": [ { "in": "path", "description": "Id of the milestone", "name": "milestone_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "operationId": "delete_milestone_actions", "tags": [ "project" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "operationId": "put_milestone_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Milestone" } } ], "tags": [ "project" ] } }, "/projects/{project_id}/pin": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Pin/Unpin project", "operationId": "post_pin_unpin_project", "tags": [ "project" ] } }, "/projects/{project_id}/sprints": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create sprint", "operationId": "post_get_sprints", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Sprint" } } ], "tags": [ "project" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Sprint" } } }, "summary": "Get sprints", "operationId": "get_get_sprints", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "project" ] } }, "/projects/{project_id}/sprints/{sprint_id}": { "parameters": [ { "in": "path", "description": "Id of the sprint", "name": "sprint_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Delete sprint", "operationId": "delete_sprint_actions", "tags": [ "project" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Get sprint", "operationId": "get_sprint_actions", "tags": [ "project" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update sprint", "operationId": "put_sprint_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Sprint" } } ], "tags": [ "project" ] } }, "/projects/{project_id}/tasks": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task" } } }, "summary": "Get project tasks", "operationId": "get_get_tasks", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/local/{local_id}": { "parameters": [ { "in": "path", "description": "Local id of the task", "name": "local_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task" } } }, "summary": "Get single task", "operationId": "get_task_actions_by_second_id", "tags": [ "task" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update task", "operationId": "put_task_actions_by_second_id", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Task" } } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/local/{local_id}/move": { "parameters": [ { "in": "path", "description": "Local id of the task", "name": "local_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Move task", "operationId": "put_task_move_with_local_id", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Move Task" } } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/types": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create task type", "operationId": "post_task_types", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Task Type" } } ], "tags": [ "project" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Type" } } }, "summary": "Get task types", "operationId": "get_task_types", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "project" ] } }, "/projects/{project_id}/tasks/types/{type_id}": { "parameters": [ { "in": "path", "description": "Id of the type", "name": "type_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Remove task type", "operationId": "delete_type_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Delete Task Type" } } ], "tags": [ "project" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Get task type", "operationId": "get_type_actions", "tags": [ "project" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update task type", "operationId": "put_type_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Task Type" } } ], "tags": [ "project" ] } }, "/projects/{project_id}/tasks/{task_id}": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Delete task", "operationId": "delete_task_actions", "tags": [ "task" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task" } } }, "summary": "Get single task", "operationId": "get_task_actions", "tags": [ "task" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update task", "operationId": "put_task_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Task" } } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/activity": { "parameters": [ { "type": "boolean", "in": "query", "description": "True if you want only task activity associated with task comments, false - all the task activity.", "name": "comments_only" }, { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Get task activity", "operationId": "get_task_activity", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/archive": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Archive task", "operationId": "put_task_archive", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/attachments": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Add attachment", "operationId": "post_get_attachments", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Add Task Attachement" } } ], "tags": [ "task" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Attachment" } } }, "summary": "Get attachments", "operationId": "get_get_attachments", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/attachments/{attachment_id}": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" }, { "name": "attachment_id", "in": "path", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Delete attachment", "operationId": "delete_get_attachment", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/checklists": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create checklist", "operationId": "post_get_checklists", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Task Checklist" } } ], "tags": [ "task" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Checklist" } } }, "summary": "Get checklists", "operationId": "get_get_checklists", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/checklists/{checklist_id}": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" }, { "name": "checklist_id", "in": "path", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Delete checklist", "operationId": "delete_checklist_actions", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/checklists/{checklist_id}/items": { "parameters": [ { "in": "path", "description": "Id of the checklist", "name": "checklist_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create checklist item", "operationId": "post_add_checklist_items", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Task Checklist" } } ], "tags": [ "task" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Checklist" } } }, "summary": "Get checklist items", "operationId": "get_add_checklist_items", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/checklists/{checklist_id}/items/{item_id}": { "parameters": [ { "in": "path", "description": "Id of the checklist item", "name": "item_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the checklist", "name": "checklist_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Delete checklist item", "operationId": "delete_checklist_item_actions", "tags": [ "task" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update checklist item", "operationId": "put_checklist_item_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Task Checklist" } } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/comments": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create comment", "operationId": "post_get_comments", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Task Comment" } } ], "tags": [ "task" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Comment" } } }, "summary": "Get comments", "operationId": "get_get_comments", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/comments/{comment_id}": { "parameters": [ { "in": "path", "description": "Id of the comment", "name": "comment_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Delete comment", "operationId": "delete_comment_actions", "tags": [ "task" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update comment", "operationId": "put_comment_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Task Comment" } } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/custom_fields": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Custom Field" } } }, "summary": "Create Task Custom field", "operationId": "post_task_custom_fields", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create Task Custom Field" } } ], "tags": [ "task" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Custom Field" } } }, "summary": "Get task custom fields", "operationId": "get_task_custom_fields", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/custom_fields/{uuid}": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" }, { "name": "uuid", "in": "path", "required": true, "type": "string" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Remove custom field", "operationId": "delete_project_custom_field", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/labels": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Label" } } }, "summary": "Get labels", "operationId": "get_get_labels", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/labels/{label_id}": { "parameters": [ { "in": "path", "description": "Id of the label", "name": "label_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Remove label from task", "operationId": "delete_label_actions", "tags": [ "task" ] }, "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Link label to task", "operationId": "post_label_actions", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/members": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Add task assignee", "operationId": "post_task_members", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Add Task Member" } } ], "tags": [ "task" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Member" } } }, "summary": "Get task assignees", "operationId": "get_task_members", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/members/{user_id}": { "parameters": [ { "in": "path", "description": "Id of the user", "name": "user_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Remove task assignee", "operationId": "delete_member_actions", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/move": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Move task", "operationId": "put_task_move", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Move Task" } } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/relations": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ] }, "/projects/{project_id}/tasks/{task_id}/schedules": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create schedule", "operationId": "post_get_schedules", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Create TaskSchedule" } } ], "tags": [ "task" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Schedule" } } }, "summary": "Get schedules", "operationId": "get_get_schedules", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/schedules/{schedule_id}": { "parameters": [ { "in": "path", "description": "Id of the schedule", "name": "schedule_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Remove schedule", "operationId": "delete_schedule_actions", "tags": [ "task" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update schedule", "operationId": "put_schedule_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Task Schedule" } } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/start_timer": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Start timer", "operationId": "post_start_timer", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/subscribe": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Watch task", "operationId": "post_task_subscribe", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/timers": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create timer", "operationId": "post_get_timers", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Add Task Timer" } } ], "tags": [ "task" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Timer" } } }, "summary": "Get timers", "operationId": "get_get_timers", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/timers/{timer_id}": { "parameters": [ { "in": "path", "description": "Id of the timer", "name": "timer_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Delete timer", "operationId": "delete_timer_actions", "tags": [ "task" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update task timer", "operationId": "put_timer_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/Update Task Timer" } } ], "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/timers/{timer_id}/pause": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" }, { "name": "timer_id", "in": "path", "required": true, "type": "integer" } ], "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Pause timer", "operationId": "put_pause_timer", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/timers/{timer_id}/resume": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" }, { "name": "timer_id", "in": "path", "required": true, "type": "integer" } ], "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Resume timer", "operationId": "put_resume_timer", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/timers/{timer_id}/stop": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" }, { "name": "timer_id", "in": "path", "required": true, "type": "integer" } ], "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Stop timer", "operationId": "put_stop_timer", "tags": [ "task" ] } }, "/projects/{project_id}/tasks/{task_id}/vote": { "parameters": [ { "in": "path", "description": "Id of the task", "name": "task_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Vote for task", "operationId": "post_task_vote", "tags": [ "task" ] } }, "/projects/{project_id}/timers": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/Task Timer" } } }, "summary": "Get project timers", "operationId": "get_get_milestones", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "project" ] } }, "/projects/{project_id}/views": { "parameters": [ { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "post": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Create views", "operationId": "post_get_views", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/CreateViewModel" } } ], "tags": [ "project" ] }, "get": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "Success", "schema": { "$ref": "#/definitions/ViewModel" } } }, "summary": "Get views", "operationId": "get_get_views", "parameters": [ { "in": "query", "description": "Number of items already displayed", "name": "offset", "type": "string" }, { "in": "query", "description": "Number of items per page", "name": "limit", "type": "string" } ], "tags": [ "project" ] } }, "/projects/{project_id}/views/{view_id}": { "parameters": [ { "in": "path", "description": "Id of the view", "name": "view_id", "required": true, "type": "integer" }, { "in": "path", "description": "Id of the project", "name": "project_id", "required": true, "type": "integer" } ], "delete": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Delete view", "operationId": "delete_view_actions", "tags": [ "project" ] }, "put": { "responses": { "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" }, "200": { "description": "OK" } }, "summary": "Update view", "operationId": "put_view_actions", "parameters": [ { "name": "payload", "required": true, "in": "body", "schema": { "$ref": "#/definitions/CreateViewModel" } } ], "tags": [ "project" ] } } }, "info": { "title": "Ora API", "version": "1.0", "description": "\nThis is Ora's api.\n\nTo use it you should create an application inside your organization. Check out our tutorial at https://help.ora.pm/article/79-getting-started-with-ora-public-api \n\nTo try the API calls here, provide your application's client_id and client_secret in the authorization modal. Use https://api.ora.pm/swaggerui/oauth2-redirect.html as redirect uri\n" }, "produces": [ "application/json" ], "consumes": [ "application/json" ], "securityDefinitions": { "oauth2": { "type": "oauth2", "flow": "accessCode", "tokenUrl": "https://api.ora.pm/oauth/token", "oauth2RedirectUrl": "https://api.ora.pm/swaggerui/oauth2-redirect.html", "authorizationUrl": "https://app.ora.pm/authorize" } }, "security": [ { "oauth2": [ "read", "write" ] } ], "tags": [ { "name": "organizations", "description": "Organization apis" }, { "name": "projects", "description": "Projects apis" }, { "name": "project", "description": "Project Apis" }, { "name": "task", "description": "Task Apis" }, { "name": "chat", "description": "Chat apis" } ], "definitions": { "Create Organization": { "properties": { "name": { "type": "string", "description": "The name of the organization. (Deprecated) This will be ignored", "example": "Deprecated, this field will be ignored" }, "title": { "type": "string", "description": "The name of the organization.", "example": "Very cool organization name" }, "org_type": { "type": "integer", "description": "Type of organization. Two types of constants. 1 - Private and 2 - Public", "example": "1 or 2" }, "description": { "type": "string", "description": "Description of the organization.", "example": "Here you can tell something about the organization." }, "web": { "type": "string", "description": "Url referencing to the organization.", "example": "organizationName.com" } }, "type": "object" }, "Organization": { "required": [ "created_at", "description", "name", "org_picture", "org_type", "owner_id", "premium_plan", "quantity", "title", "updated_at" ], "properties": { "owner_id": { "type": "integer", "description": "The id of the user that created the organization.", "example": 1234 }, "name": { "type": "string", "description": "The name of the organization. (Deprecated)", "example": "Deprecated" }, "title": { "type": "string", "description": "The name of the organization.", "example": "Very cool organization name" }, "description": { "type": "string", "description": "Description of the organization.", "example": "Here you can tell something about the organization." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the organization was created.", "example": "2019-07-31T12:42:49.096305Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the organization was last updated.", "example": "2019-07-31T12:42:49.096305Z" }, "org_picture": { "type": "string", "description": "Organization picture displayed in Ora. Stored in Amazon S3.", "example": "s3-us-west-2.amazonaws.com/ora-organizations/default" }, "org_type": { "type": "string", "description": "Type of organization. Two types of constants. 1 - Private and 2 - Public.", "example": "1 or 2" }, "premium_plan": { "type": "string", "description": "Shows the plan of the organization. By default it is free and it can be changed to different types of premium(Professional(Professional Year), Startup(Startup year) and Enterprise(Enterprise year)).", "example": "ora_professional, ora_professional_year" }, "quantity": { "type": "integer", "description": "Counter of members in the organization.", "example": 4321 } }, "type": "object" }, "Add Organization Member": { "required": [ "email" ], "properties": { "email": { "type": "string", "description": "The email of the user to be added in the organization.", "example": "test@test.com" } }, "type": "object" }, "Organization Member": { "required": [ "joined", "leaves", "member_type" ], "properties": { "joined": { "type": "string", "format": "date-time", "description": "Date and time when the user joined the organization.", "example": "2019-07-31T12:42:49.096305Z" }, "leaves": { "type": "string", "format": "date-time", "description": "Date and time when the user left the organization.", "example": "2020-01-02T13:12:00.023451Z" }, "member_type": { "type": "integer", "description": "The type of the member. 1 - admin and 2 - normal user.", "example": "1 or 2" } }, "type": "object" }, "Project": { "properties": { "picture": { "type": "string", "description": "The picture of the project.", "example": "ora-projects.s3.amazonaws.com/default-15.svg" }, "organization_id": { "type": "string", "description": "Id of the organization where the project is created.", "example": 1234 }, "owner": { "type": "string", "description": "Id of the user that created the project.", "example": 1234 }, "title": { "type": "string", "description": "Title of the project.", "example": "Cool project title" }, "web": { "type": "string", "description": "Url referencing to the organization.", "example": "projectName.com" }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the organization was created.", "example": "2019-07-31T12:42:49.096305Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the organization was last updated.", "example": "2019-08-02T13:22:22.000001Z" }, "description": { "type": "string", "description": "Description about the project.", "example": "Here you can tell something about the project." }, "tasks": { "type": "integer", "description": "Counter of tasks that is used for second id for tasks. In task model there is a second_id field that is this counter.", "example": 201 }, "starred": { "type": "integer", "description": "Counter showing how many people have starred this project.", "example": 123 }, "archived": { "type": "boolean", "description": "True if the project is archived, if false it is not.", "example": "true" }, "default_view": { "type": "boolean", "description": "True is list, false is kanban.", "example": "true" }, "item_name": { "type": "string", "description": "Name that you want to be used for the tasks in the project.", "example": "card" }, "items_name": { "type": "string", "description": "It is just plural of item_name.", "example": "cards" }, "project_type": { "type": "string", "description": "Constant about the type of the project. 1 - Private, 2 - Public and 3 - Secret.", "example": "1, 2 or 3" }, "comment_all": { "type": "string", "description": "Constant about who can comment in a project. 1 - Members, 2 - Public and 3 - Observers.", "example": "1, 2 or 3" }, "commits_visibility": { "type": "string", "description": "Constant about who can see the commits in a project. 1 - Members, 2 - Public and 3 - Observers.", "example": "1, 2 or 3" }, "invite_all": { "type": "boolean", "description": "If true then everybody can invite members to the project, if false than not everybody can invite.", "example": "true" }, "project_color": { "type": "string", "description": "Project color shown in repost or agenda.", "example": "#473a4f" }, "view_title": { "type": "string", "description": "The title of the default view.", "example": "Backlog" }, "position": { "type": "integer", "description": "Position of the project in a folder.", "example": 22 } }, "type": "object" }, "Create Folder": { "required": [ "color", "title" ], "properties": { "title": { "type": "string", "description": "The title of the folder.", "example": "Cool folder title" }, "color": { "type": "string", "description": "The color of the folder.", "example": "#ffdf99" } }, "type": "object" }, "Folder": { "required": [ "color", "folders_count", "parent_id", "position", "privacy", "projects_count", "title" ], "properties": { "parent_id": { "type": "integer", "description": "If a folder is located into another folder then this parent_id field is the id of that another folder.", "example": 1234 }, "personal": { "type": "boolean", "description": "Boolean if the folder is personal." }, "position": { "type": "integer", "description": "The position of the folder.", "example": 213 }, "title": { "type": "string", "description": "The title of the folder.", "example": "Cool folder title" }, "color": { "type": "string", "description": "The color of the folder.", "example": "#ffdf99" }, "privacy": { "type": "integer", "description": "Folder privacy it can be public(1) or private(2).", "example": "1 or 2" }, "folders_count": { "type": "integer", "description": "Counter for how many folders are in the folder.", "example": 123 }, "projects_count": { "type": "integer", "description": "Counter for how many projects are in the folder.", "example": 123 } }, "type": "object" }, "Update Folder": { "properties": { "title": { "type": "string", "description": "The title of the folder.", "example": "Cool folder title" }, "color": { "type": "string", "description": "The color of the folder.", "example": "#ffdf99" } }, "type": "object" }, "Create Project": { "properties": { "title": { "type": "string", "description": "Title of the project.", "example": "Cool project title" }, "web": { "type": "string", "description": "Url referencing to the organization.", "example": "projectName.com" }, "description": { "type": "string", "description": "Description about the project.", "example": "Here you can tell something about the project." }, "default_view": { "type": "boolean", "description": "True is list, false is kanban.", "example": "true" }, "item_name": { "type": "string", "description": "Name that you want to be used for the tasks in the project.", "example": "card" }, "items_name": { "type": "string", "description": "It is just plural of item_name.", "example": "cards" }, "project_color": { "type": "string", "description": "Project color shown in repost or agenda.", "example": "#473a4f" } }, "type": "object" }, "Create Label": { "required": [ "color", "title" ], "properties": { "title": { "type": "string", "description": "Title of the label", "example": "Cool label title" }, "color": { "type": "string", "description": "Color of the label", "example": "#FBFCFD" } }, "type": "object" }, "Label": { "required": [ "archived", "color", "title", "updated_at" ], "properties": { "title": { "type": "string", "description": "Title of the label", "example": "Cool label title" }, "color": { "type": "string", "description": "Color of the label", "example": "#FBFCFD" }, "updated_at": { "type": "string", "description": "Color of the label", "example": "2019-08-01T10:33:12.070602Z" }, "archived": { "type": "string", "description": "Color of the label" } }, "type": "object" }, "Update Label": { "properties": { "title": { "type": "string", "description": "Title of the label", "example": "Cool label title" }, "color": { "type": "string", "description": "Color of the label", "example": "#FBFCFD" } }, "type": "object" }, "Create Sprint": { "required": [ "duration", "title" ], "properties": { "title": { "type": "string", "description": "Title of the sprint.", "example": "Cool sprint title" }, "duration": { "type": "integer", "description": "Duration of the sprint in days.", "example": 4 }, "done_list": { "type": "integer", "description": "Counter for completed tasks in the done list.", "example": 423 } }, "type": "object" }, "Sprint": { "properties": { "title": { "type": "string", "description": "Title of the sprint.", "example": "Cool sprint title" }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the sprint was created.", "example": "2019-07-31T12:42:49.096305Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the sprint was last updated.", "example": "2019-08-01T10:33:12.070602Z" }, "start_date": { "type": "string", "format": "date-time", "description": "Date and time when the sprint starts.", "example": "2019-07-31T13:00:00.000000Z" }, "end_date": { "type": "string", "format": "date-time", "description": "Date and time when the sprint ends.", "example": "2019-08-03T13:00:00.000000Z" }, "duration": { "type": "integer", "description": "Duration of the sprint in days.", "example": 4 }, "done_list": { "type": "integer", "description": "Counter for completed tasks in the done list.", "example": 423 }, "state": { "type": "string", "description": "State of the sprint.", "example": "unactive" }, "number": { "type": "integer", "description": "Autogenerated. Can not be changed. Number of the sprint.", "example": "1, 2, 3, etc." }, "archived": { "type": "boolean", "description": "False if the project is archived, if false it is not." }, "tasks": { "type": "integer", "description": "Counter for the tasks in sprint.", "example": 450 }, "tasks_completed": { "type": "integer", "description": "Counter for completed tasks in sprint.", "example": 423 }, "points": { "type": "integer", "description": "Effort estimate in points. Every task has Story points. They are combined.", "example": 567 }, "points_completed": { "type": "integer", "description": "Completed Story points in the sprint.", "example": 546 }, "value": { "type": "integer", "description": "Business value estimate of the sprint. Every task has business value points. They are combined.", "example": 451 }, "value_completed": { "type": "integer", "description": "Completed Business value points in the sprint.", "example": 234 } }, "type": "object" }, "Update Sprint": { "properties": { "title": { "type": "string", "description": "Title of the sprint.", "example": "Cool sprint title" }, "duration": { "type": "integer", "description": "Duration of the sprint in days.", "example": 4 }, "done_list": { "type": "integer", "description": "Counter for completed tasks in the done list.", "example": 423 }, "start_date": { "type": "string", "format": "date-time", "description": "Date and time when the sprint starts.", "example": "2019-07-31T13:00:00.000000Z" }, "end_date": { "type": "string", "format": "date-time", "description": "Date and time when the sprint ends.", "example": "2019-08-03T13:00:00.000000Z" }, "state": { "type": "string", "description": "State of the sprint.", "example": "unactive" } }, "type": "object" }, "Add Project Member": { "required": [ "user" ], "properties": { "user": { "type": "string", "description": "You can add registered user to a project with his email, username or name." } }, "type": "object" }, "Project Member": { "required": [ "active", "dev_type", "email", "full_name", "joined", "last_list", "last_view", "leaves", "profile_picture", "updated_at", "user_id" ], "properties": { "joined": { "type": "string", "format": "date-time", "description": "Date and time when the user joined the project.", "example": "2019-07-31T12:42:49.096305Z" }, "leaves": { "type": "string", "format": "date-time", "description": "Date and time when the user left the project.", "example": "2020-01-02T13:12:00.023451Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the project member was last updated.", "example": "2019-09-22T23:22:33.000004Z" }, "user_id": { "type": "integer", "description": "Id of the user that is a member to the project.", "example": 1234 }, "last_list": { "type": "integer", "description": "Id of the list in the project that was last changed by the member.", "example": 2134 }, "last_view": { "type": "integer", "description": "Id of the view in the project that was last changed by the member.", "example": 2134 }, "active": { "type": "boolean", "description": "If true the user is active, false - inactive.", "example": "true" }, "email": { "type": "string", "description": "Email of the member.", "example": "test@test.com" }, "full_name": { "type": "string", "description": "Full name of the member(first and last name).", "example": "Mike Davidson" }, "profile_picture": { "type": "string", "description": "Profile picture of the member. Stored in Amazon S3.", "example": "ora-profile-pictures.s3.amazonaws.com/ea514609774436e65bbfb5780fb8015470339173?1562833472" }, "dev_type": { "type": "integer", "description": "The type of the member. 1 - admin and 2 - regular member.", "example": "1 or 2" } }, "type": "object" }, "Create List": { "required": [ "title" ], "properties": { "title": { "type": "string", "description": "Title of the list.", "example": "Cool list title" }, "color": { "type": "string", "description": "Color of the list.", "example": "#FBFCFD" }, "list_type": { "type": "integer", "description": "Type of the list. 1 - Open, 2 - Closed, 3 - Review and 4 - Frosen.", "example": 1 }, "public": { "type": "boolean", "description": "If true the list is public, if false - private." } }, "type": "object" }, "List": { "required": [ "title", "updated_at" ], "properties": { "view_id": { "type": "integer", "description": "Id of the view where the list is located.", "example": 1234 }, "updated_at": { "type": "string", "description": "Date and time when the list was last updated.", "example": "2019-09-22T23:22:33.000004Z" }, "title": { "type": "string", "description": "Title of the list.", "example": "Cool list title" }, "color": { "type": "string", "description": "Color of the list.", "example": "#FBFCFD" }, "list_type": { "type": "integer", "description": "Type of the list. 1 - Open, 2 - Closed, 3 - Review and 4 - Frosen.", "example": "1, 2, 3 or 4" }, "archived": { "type": "boolean", "description": "True if the project is archived, if false it is not." }, "actions": { "type": "integer", "description": "Counter of the list actions.", "example": 334 }, "public": { "type": "string", "description": "If true the list is public, if false - private." }, "position": { "type": "integer", "description": "Position of the list.", "example": 2442 } }, "type": "object" }, "Update List": { "properties": { "title": { "type": "string", "description": "Title of the list.", "example": "Cool list title" }, "color": { "type": "string", "description": "Color of the list.", "example": "#FBFCFD" }, "list_type": { "type": "integer", "description": "Type of the list. 1 - Open, 2 - Closed, 3 - Review and 4 - Frosen.", "example": "1, 2, 3 or 4" }, "position": { "type": "integer", "description": "Position of the list.", "example": 1234 }, "actions": { "type": "integer", "description": "Counter of the list actions.", "example": 334 }, "public": { "type": "string", "description": "If true the list is public, if false - private.", "example": 2442 } }, "type": "object" }, "CreateViewModel": { "required": [ "title" ], "properties": { "title": { "type": "string", "description": "Title of the view.", "example": "Cool view title" } }, "type": "object" }, "ViewModel": { "properties": { "type": { "type": "integer", "description": "Type of the view. 0 - Custom and 1 - Sprint.", "example": "0 or 1" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the view was last updated.", "example": "2019-09-22T23:22:33.000004Z" }, "title": { "type": "string", "description": "Title of the view.", "example": "Cool view title" }, "active": { "type": "boolean", "description": "If true the view is active, if false - inactive.", "example": "true" }, "position": { "type": "integer", "description": "Positionof the view.", "example": 130 } }, "type": "object" }, "Create Task Type": { "required": [ "color", "icon", "name" ], "properties": { "name": { "type": "string", "description": "Name of the task type.", "example": "Cool task type name" }, "icon": { "type": "string", "description": "Icon for the task type.", "example": "icon-feature" }, "color": { "type": "string", "description": "The color of the task type.", "example": "#70C471" } }, "type": "object" }, "Task Type": { "properties": { "name": { "type": "string", "description": "Name of the task type.", "example": "Cool task type name" }, "icon": { "type": "string", "description": "Icon for the task type.", "example": "icon-feature" }, "color": { "type": "string", "description": "The color of the task type.", "example": "#70C471" }, "active": { "type": "boolean", "description": "Boolean if the task type is active.", "example": "true" }, "initial": { "type": "boolean", "description": "Boolean if the task type is initial.", "example": "true" }, "archived": { "type": "boolean", "description": "True if the task type is archived, if false it is not." } }, "type": "object" }, "Delete Task Type": { "required": [ "color", "icon", "name" ], "properties": { "name": { "type": "string", "description": "Name of the task type.", "example": "Cool task type name" }, "icon": { "type": "string", "description": "Icon for the task type.", "example": "icon-feature" }, "color": { "type": "string", "description": "The color of the task type.", "example": "#70C471" }, "active": { "type": "boolean", "description": "Boolean if the task type is active.", "example": "true" }, "initial": { "type": "boolean", "description": "Boolean if the task type is initial.", "example": "true" } }, "type": "object" }, "Update Task Type": { "required": [ "color", "icon", "name" ], "properties": { "name": { "type": "string", "description": "Name of the task type.", "example": "Cool task type name" }, "icon": { "type": "string", "description": "Icon for the task type.", "example": "icon-feature" }, "color": { "type": "string", "description": "The color of the task type.", "example": "#70C471" }, "active": { "type": "boolean", "description": "Boolean if the task type is active.", "example": "true" }, "initial": { "type": "boolean", "description": "Boolean if the task type is initial.", "example": "true" } }, "type": "object" }, "Create Milestone": { "required": [ "title" ], "properties": { "title": { "type": "string", "description": "Title of the milestone.", "example": "Cool milestone title" }, "color": { "type": "string", "description": "Color of the milestone.", "example": "#ffdf99" } }, "type": "object" }, "Milestone": { "properties": { "title": { "type": "string", "description": "Title of the milestone.", "example": "Cool milestone title" }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the milestone was created.", "example": "2019-09-22T23:22:33.000004Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the milestone was last updated.", "example": "2019-09-22T23:22:33.000004Z" }, "archived": { "type": "boolean", "description": "If true the milestone is archived, if false - not archived." }, "complete": { "type": "boolean", "description": "If true the milestone is completed, if false - not completed." }, "deadline": { "type": "string", "format": "date-time", "description": "Deadline of the milestone.", "example": "2019-09-22T23:22:33.000004Z" }, "color": { "type": "string", "description": "Color of the milestone.", "example": "#ffdf99" }, "position": { "type": "integer", "description": "Position of the milestone.", "example": 4562 } }, "type": "object" }, "Update Milestone": { "properties": { "title": { "type": "string", "description": "Title of the milestone.", "example": "Cool milestone title" }, "color": { "type": "string", "description": "Color of the milestone.", "example": "#ffdf99" }, "complete": { "type": "boolean", "description": "If true the milestone is completed, if false - not completed." }, "position": { "type": "integer", "description": "Position of the milestone.", "example": 4562 } }, "type": "object" }, "Link Zendesk": { "required": [ "task_assignee_added", "task_comment_added", "task_created", "task_label_added", "task_moved", "task_timer_changed", "url" ], "properties": { "url": { "type": "string", "description": "The webhook URL", "example": "https://ora.pm" }, "task_created": { "type": "boolean", "description": "Should send a webhook when a task is created.", "example": true }, "task_moved": { "type": "boolean", "description": "Should send a webhook when a task is moved.", "example": true }, "task_label_added": { "type": "boolean", "description": "Should send a webhook when a task label is added.", "example": true }, "task_assignee_added": { "type": "boolean", "description": "Should send a webhook when a task assignee is added.", "example": true }, "task_comment_added": { "type": "boolean", "description": "Should send a webhook when a task comment is added.", "example": true }, "task_timer_changed": { "type": "boolean", "description": "Should send a webhook when a task timer is started or stopped.", "example": true } }, "type": "object" }, "Task Timer": { "properties": { "user_id": { "type": "integer", "description": "Id of the user that started the timer.", "example": 1234 }, "checklist_id": { "type": "integer", "description": "If the timer is started on a checklist then checklist_id is the id of that checklist.", "example": 1234 }, "task_title": { "type": "string", "description": "Title of the task where the timer is started.", "example": "Cool task title" }, "status": { "type": "string", "description": "Status of the timer.", "example": "unpause_timer" }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the timer was created.", "example": "2019-07-31T12:42:49.096305Z" }, "total": { "type": "string", "description": "Total time the timer tracked.", "example": "2h 30m" }, "last_time": { "type": "string", "description": "Time spent last time.", "example": "1h 10m" }, "ended_at": { "type": "string", "format": "date-time", "description": "Date and time when the timer has been stopped.", "example": "2019-08-31T13:00:0.000000Z" }, "archived": { "type": "boolean", "description": "True if the timer is archived" }, "notes": { "type": "string", "description": "Notes for the timer.", "example": "Some kind of notes" } }, "type": "object" }, "Create Custom Field": { "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Title of the custom field.", "example": "Custom field name" }, "description": { "type": "string", "description": "Description about the custom field.", "example": "Here you can tell something about the custom field." }, "type": { "type": "integer", "description": "Type of the custom field (1 - Dropdown, 2 - Number, 3 - Text, 4 - Number, 5 - Date, 6 - Checkbox).", "example": 1 }, "options": { "type": "array", "description": "List with the dropdown options. (It's returned if the type is 1).", "example": [ { "color": "#1B9AF7", "position": 0, "text": "Movie", "uuid": "8a28a100-70b0-4c27-9790-591f24549e0e" } ], "items": { "type": "object", "example": { "color": "#1B9AF7", "position": 0, "text": "Movie", "uuid": "8a28a100-70b0-4c27-9790-591f24549e0e" }, "additionalProperties": { "type": "string" } } }, "is_multiline": { "type": "boolean", "description": "True if the textfield is multiline. (It's returned if the type is 3).", "example": true }, "number_format": { "type": "integer", "description": "1 - Number, 2 - USD, 3 - EUR, 4 - GBP, 5 - YEN, 6 - Percent, 7 - Custom, 8 - Unformatted (It's returned if the type is 3).", "example": 1 }, "position": { "type": "integer", "description": "0 - None, 1 - Left, 2 - Right (It's returned if the type is 2).", "example": 1 }, "label": { "type": "string", "description": "Which label to show, Example: %, $. (It's returned if the type is 2).", "example": "$" }, "decimals": { "type": "integer", "description": "(It's returned if the type is 2).", "example": 1 } }, "type": "object" }, "Custom Field": { "properties": { "uuid": { "type": "string", "description": "UUID of the custom field.", "example": "ceca0749-7cea-4ddf-beb9-33ea0b043519" }, "creator_id": { "type": "integer", "description": "Id of the user that created the custom field.", "example": 1 }, "project_id": { "type": "integer", "description": "Id of the project", "example": 10 }, "name": { "type": "string", "description": "Title of the custom field.", "example": "Custom field name" }, "description": { "type": "string", "description": "Description about the custom field.", "example": "Here you can tell something about the custom field." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the custom field is created.", "example": "2019-07-31T12:42:49.096305Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the custom field is last updated.", "example": "2019-07-31T12:42:49.096305Z" }, "position": { "type": "integer", "description": "0 - None, 1 - Left, 2 - Right (It's returned if the type is 2).", "example": 1 }, "type": { "type": "integer", "description": "Type of the custom field (1 - Dropdown, 2 - Number, 3 - Text, 4 - Number, 5 - Date, 6 - Checkbox).", "example": 1 }, "options": { "type": "array", "description": "List with the dropdown options. (It's returned if the type is 1).", "example": [ { "color": "#1B9AF7", "position": 0, "text": "Movie", "uuid": "8a28a100-70b0-4c27-9790-591f24549e0e" } ], "items": { "type": "object", "example": { "color": "#1B9AF7", "position": 0, "text": "Movie", "uuid": "8a28a100-70b0-4c27-9790-591f24549e0e" }, "additionalProperties": { "type": "string" } } }, "is_multiline": { "type": "boolean", "description": "True if the textfield is multiline. (It's returned if the type is 3).", "example": true }, "number_format": { "type": "integer", "description": "1 - Number, 2 - USD, 3 - EUR, 4 - GBP, 5 - YEN, 6 - Percent, 7 - Custom, 8 - Unformatted (It's returned if the type is 3).", "example": 1 }, "label": { "type": "string", "description": "Which label to show, Example: %, $. (It's returned if the type is 2).", "example": "$" }, "decimals": { "type": "integer", "description": "(It's returned if the type is 2).", "example": 1 } }, "type": "object" }, "Update Custom Field": { "properties": { "name": { "type": "string", "description": "Title of the custom field.", "example": "Custom field name" }, "description": { "type": "string", "description": "Description about the custom field.", "example": "Here you can tell something about the custom field." }, "position": { "type": "number", "description": "Position of the custom field.", "example": 13 }, "options": { "type": "array", "description": "List with the dropdown options. (It's returned if the type is 1).", "example": [ { "color": "#1B9AF7", "position": 0, "text": "Movie", "uuid": "8a28a100-70b0-4c27-9790-591f24549e0e" } ], "items": { "type": "object", "example": { "color": "#1B9AF7", "position": 0, "text": "Movie", "uuid": "8a28a100-70b0-4c27-9790-591f24549e0e" }, "additionalProperties": { "type": "string" } } }, "is_multiline": { "type": "boolean", "description": "True if the textfield is multiline. (It's returned if the type is 3).", "example": true }, "number_format": { "type": "integer", "description": "1 - Number, 2 - USD, 3 - EUR, 4 - GBP, 5 - YEN, 6 - Percent, 7 - Custom, 8 - Unformatted (It's returned if the type is 3).", "example": 1 }, "label_position": { "type": "integer", "description": "0 - None, 1 - Left, 2 - Right (It's returned if the type is 2).", "example": 1 }, "label": { "type": "string", "description": "Which label to show, Example: %, $. (It's returned if the type is 2).", "example": "$" }, "decimals": { "type": "integer", "description": "(It's returned if the type is 2).", "example": 2 } }, "type": "object" }, "Create Task": { "required": [ "title" ], "properties": { "title": { "type": "string", "description": "Title of the task.", "example": "Cool task title" } }, "type": "object" }, "Task": { "properties": { "milestone_id": { "type": "integer", "description": "Id of the milestone in the task(milestone can be attached to the task).", "example": 1234 }, "task_type": { "type": "integer", "description": "Id of the task type(show what type is the task - bug, feature, etc.).", "example": 1234 }, "creator": { "type": "integer", "description": "Id of the user that created the task.", "example": 1234 }, "second_id": { "type": "integer", "description": "Id that is equal to tasks counter in Project model. It is shown when you click the task under the task title(#10, #11, etc.).", "example": 10 }, "title": { "type": "string", "description": "Title of the task.", "example": "Cool task title" }, "description": { "type": "string", "description": "Description about the task.", "example": "Here you can tell something about the task." }, "last_picture": { "type": "string", "description": "Last picture that is uploaded to the task through Ora.", "example": "ora-projects.s3.amazonaws.com/default-15.svg" }, "last_picture_external_url": { "type": "string", "description": "Last picture that is uploaded to the task through external service(Trelo, etc.).", "example": "ora-projects.s3.amazonaws.com/default-15.svg" }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the project was created.", "example": "2019-07-31T12:42:49.096305Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the project was last updated.", "example": "2019-07-31T12:42:49.096305Z" }, "deadline": { "type": "string", "format": "date-time", "description": "Deadline of the task.", "example": "2019-09-12T15:22:33.106501Z" }, "archived": { "type": "boolean", "description": "True if the task is archived, if false it is not." }, "color": { "type": "string", "description": "Color of the task.", "example": "#473a4f" }, "estimated": { "type": "string", "description": "Estimated time for completing the task.", "example": "16:33:22" }, "time_tracked": { "type": "string", "description": "Time that is tracked while working on the task.", "example": "10:12:33" }, "public": { "type": "boolean", "description": "True if the task has to be public, false if it should not. By default it is true(public).", "example": "true" }, "state": { "type": "integer", "description": "The state of the task. 1 - Frosen, 2 - Open, 3 - Review, 4 - Closed.", "example": "1, 2, 3 or 4" }, "cover_width": { "type": "integer", "description": "Width of the task.", "example": 10 }, "cover_height": { "type": "integer", "description": "Height of the task.", "example": 10 }, "checklist": { "type": "string", "description": "Counter for how many points of the checklist in the task are completed. Completed points are on the left and total points are on the right(2/5, 1/5, 5/5, etc.).", "example": "1/10" }, "comments": { "type": "integer", "description": "Counter for comments on a task.", "example": 20 }, "public_comments": { "type": "integer", "description": "Counter for public comments on a task.", "example": 14 }, "likes": { "type": "integer", "description": "Counter for likes on a task.", "example": 9 }, "attachments": { "type": "integer", "description": "Counter for attachments on a task.", "example": 6 }, "commits": { "type": "integer", "description": "Counter for commits on a task.", "example": 3 }, "support_tickets": { "type": "integer", "description": "Counter for support tickets on a task.", "example": 1 }, "value": { "type": "integer", "description": "Business value of the task. What importance for the business it has.", "example": 12 }, "points": { "type": "integer", "description": "Difficulty of the task. How many points in the task there are to be done.", "example": 10 }, "points_done": { "type": "integer", "description": "Counter for how many points are done.", "example": 5 }, "sprint_id": { "type": "integer", "description": "Id of the sprint in which is the task.", "example": 1234 }, "position": { "type": "integer", "description": "Position of the task in the sprint.", "example": 13 } }, "type": "object" }, "Update Task": { "properties": { "title": { "type": "string", "description": "Title of the task.", "example": "Cool task title" }, "color": { "type": "string", "description": "Color of the task.", "example": "#473a4f" }, "task_type": { "type": "integer", "description": "Id of the task type(show what type is the task - bug, feature, etc.).", "example": 1234 }, "position": { "type": "integer", "description": "Position of the task in the sprint.", "example": 13 }, "points": { "type": "integer", "description": "Difficulty of the task. How many points in the task there are to be done.", "example": 10 }, "points_done": { "type": "integer", "description": "Counter for how many points are done.", "example": 5 }, "state": { "type": "integer", "description": "The state of the task. 1 - Frosen, 2 - Open, 3 - Review, 4 - Closed.", "example": "1, 2, 3 or 4" }, "estimated": { "type": "string", "description": "Estimated time for completing the task.", "example": "16:33:22" }, "deadline": { "type": "string", "format": "date-time", "description": "Deadline of the task.", "example": "2019-09-12T15:22:33.106501Z" }, "value": { "type": "integer", "description": "Business value of the task. What importance for the business it has.", "example": 12 }, "description": { "type": "string", "description": "Description about the task.", "example": "Here you can tell something about the task." }, "milestone_id": { "type": "integer", "description": "Id of the milestone in the task(milestone can be attached to the task).", "example": 1234 } }, "type": "object" }, "Move Task": { "properties": { "list_id": { "type": "integer", "description": "The id of the new list.", "example": 13 } }, "type": "object" }, "Create TaskSchedule": { "required": [ "daily_hours_estimate", "end", "start" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Date and time when the schedule starts.", "example": "2019-07-31T12:42:49.096305Z" }, "end": { "type": "string", "format": "date-time", "description": "Date and time when the schedule ends.", "example": "2019-08-31T13:00:00.000000Z" }, "daily_hours_estimate": { "type": "integer", "description": "Estimated daily hours", "example": 4 }, "user_id": { "type": "integer", "description": "The id of the user that is voting the task.", "default": 0, "example": 1234 } }, "type": "object" }, "Task Schedule": { "properties": { "user_id": { "type": "integer", "description": "The id of the user that is voting the task.", "example": 1234 }, "start": { "type": "string", "format": "date-time", "description": "Date and time when the schedule starts.", "example": "2019-07-31T12:42:49.096305Z" }, "end": { "type": "string", "format": "date-time", "description": "Date and time when the schedule ends.", "example": "2019-08-31T13:00:00.000000Z" }, "estimate": { "type": "integer", "description": "Estimated time for completing the schedule. In hours.", "example": 10 }, "daily_estimate": { "type": "integer", "description": "Estimated time for working daily on the schedule. In hours.", "example": 2 }, "deleted": { "type": "boolean", "description": "True if the schedule is deleted, if false it is not." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the schedule was last updated.", "example": "2019-08-01T11:22:33.000000Z" } }, "type": "object" }, "Update Task Schedule": { "properties": { "user_id": { "type": "integer", "description": "The id of the user that is voting the task.", "example": 1234 }, "start": { "type": "string", "format": "date-time", "description": "Date and time when the schedule starts.", "example": "2019-07-31T12:42:49.096305Z" }, "end": { "type": "string", "format": "date-time", "description": "Date and time when the schedule ends.", "example": "2019-08-31T13:00:00.000000Z" }, "estimate": { "type": "integer", "description": "Estimated time for completing the schedule. In hours.", "example": 10 } }, "type": "object" }, "Task Label": { "properties": { "label_id": { "type": "integer", "description": "Id of the label that is added to the task.", "example": 1234 }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the label was added to the task.", "example": "2019-07-31T12:42:49.096305Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the label was last updated.", "example": "2019-07-31T12:42:49.096305Z" }, "archived": { "type": "boolean", "description": "True if the label is archived, if false it is not." }, "deleted": { "type": "boolean", "description": "True if the label is deleted, if false it is not." } }, "type": "object" }, "Create Task Comment": { "required": [ "data" ], "properties": { "data": { "type": "string", "description": "Content of the comment.", "example": "Commenting about stuff." }, "public": { "type": "boolean", "description": "If the field is true, the comment will be team only visible. If false - the comment is public.", "example": true } }, "type": "object" }, "Task Comment": { "required": [ "comment" ], "properties": { "comment": { "type": "string", "description": "Content of the comment.", "example": "Commenting about stuff." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the comment was created.", "example": "2019-08-05T13:54:22.210841Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the comment was last updated.", "example": "2019-08-06T13:55:50.511923Z" }, "public": { "type": "boolean", "description": "If the field is true, the comment will be team only visible. If false - the comment is public.", "example": true } }, "type": "object" }, "Update Task Comment": { "required": [ "data" ], "properties": { "data": { "type": "string", "description": "Content of the comment.", "example": "Commenting about stuff." } }, "type": "object" }, "Add Task Attachement": { "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The url of the attachment.", "example": "https://upload.wikimedia.org/wikipedia/commons/thumb/0/0c/Ora_logo.svg/1200px-Ora_logo.svg.png" } }, "type": "object" }, "Task Attachment": { "properties": { "upload_date": { "type": "string", "format": "date-time", "description": "The picture of the project.", "example": "2019-07-31T12:42:49.096305Z" }, "data_path": { "type": "string", "description": "Path of the uploaded data.", "example": "355758021e5c5a2ec828925ca97d50e4770fc46f7261" }, "external_url": { "type": "string", "description": "Path of the uploaded data if the attachment is not uploaded from Ora but from external service.", "example": "355758021e5c5a2ec828925ca97d50e4770fc46f7261" }, "file_title": { "type": "string", "description": "Title of the file that is uploaded.", "example": "Cool project title" }, "file_size": { "type": "string", "description": "Size of the file uploaded.", "example": "projectName.com" }, "file_type": { "type": "string", "description": "Type of the file uploaded.", "example": "txt, png, jpeg, etc." }, "picture_width": { "type": "integer", "description": "Width of the attachment if it is a picture.", "example": "2019-08-02T13:22:22.000001Z" }, "picture_height": { "type": "integer", "description": "Height of the attachment if it is a picture.", "example": "Here you can tell something about the project." }, "activity_id": { "type": "integer", "description": "Description about the project.", "example": "Here you can tell something about the project." } }, "type": "object" }, "Add Task Member": { "required": [ "user_id" ], "properties": { "user_id": { "type": "integer", "description": "The id of the user to be assigned to task.", "example": 1234 } }, "type": "object" }, "Task Member": { "properties": { "user_id": { "type": "integer", "description": "Id of the user that is assigned to the task.", "example": 1234 }, "joined": { "type": "string", "format": "date-time", "description": "Date and time when the user was assigned to the task.", "example": "2019-07-31T12:42:49.096305Z" }, "archived": { "type": "boolean", "description": "The id of the user to be assigned to task." }, "deleted": { "type": "boolean", "description": "True if the assignee is deleted, if false it is not." }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the assignee was last updated.", "example": "2019-08-01T11:22:33.000000Z" } }, "type": "object" }, "Create Task Checklist": { "required": [ "related_task", "relation_type" ], "properties": { "related_task": { "type": "integer", "description": "If of the task you want to related to ", "example": 1234 }, "relation_type": { "type": "integer", "description": "Type of the relation ", "example": 1 } }, "type": "object" }, "Task Checklist": { "properties": { "main_id": { "type": "integer", "description": "If the checklist is a item to another checklist then this main_id will be the id of the parent checklist.", "example": 1234 }, "title": { "type": "string", "description": "Title of the checklist.", "example": "Cool checklist title" }, "deadline": { "type": "string", "format": "date-time", "description": "Date and time when the deadline for completing the checklist is.", "example": "2019-07-31T12:42:49.096305Z" }, "total_time": { "type": "integer", "description": "Total time spent working on the checklist.", "example": 10 }, "checked": { "type": "boolean", "description": "If this checklist is a item to another checklist then when it is completed it will be checked(true) which means it is done." }, "position": { "type": "integer", "description": "Position of the checklist.", "example": 1032 } }, "type": "object" }, "Update Task Checklist": { "properties": { "title": { "type": "string", "description": "Title of the checklist.", "example": "Cool checklist title" }, "deadline": { "type": "string", "format": "date-time", "description": "Date and time when the deadline for completing the checklist is.", "example": "2019-07-31T12:42:49.096305Z" }, "total_time": { "type": "integer", "description": "Total time spent working on the checklist.", "example": 10 }, "checked": { "type": "boolean", "description": "If this checklist is a item to another checklist then when it is completed it will be checked(true) which means it is done." } }, "type": "object" }, "Add Task Timer": { "required": [ "end_date", "start_date" ], "properties": { "start_date": { "type": "string", "format": "date-time", "description": "Date and time when the timer was started." }, "end_date": { "type": "string", "format": "date-time", "description": "Date and time when the timer has been stoped." }, "notes": { "type": "string", "description": "Notes for the timer.", "example": "What have you done" } }, "type": "object" }, "Update Task Timer": { "properties": { "start_date": { "type": "string", "format": "date-time", "description": "Date and time when the timer was started." }, "end_date": { "type": "string", "format": "date-time", "description": "Date and time when the timer has been stoped." }, "notes": { "type": "string", "description": "Notes for the timer.", "example": "What have you done" } }, "type": "object" }, "Create Task Custom Field": { "properties": { "custom_field_id": { "type": "integer", "description": "Id of the project custom field", "example": 10 }, "date": { "type": "string", "format": "date", "description": "Selected date value.", "example": "2019-07-31T12:42:49.096305Z" }, "is_checked": { "type": "boolean", "description": "Id of the selected member.", "example": true }, "selected_member": { "type": "string", "description": "List of selected members.", "example": 1 }, "numeric_value": { "type": "number", "description": "Numeric value added to the custom field.", "example": 220.1 }, "selected_dropdown": { "type": "string", "description": "UUID of the selected dropdown.", "example": "ceca0749-7cea-4ddf-beb9-33ea0b043519" }, "text": { "type": "string", "description": "Text of the custom field.", "example": "Some text goes here" } }, "type": "object" }, "Task Custom Field": { "properties": { "uuid": { "type": "string", "description": "UUID of the custom field.", "example": "ceca0749-7cea-4ddf-beb9-33ea0b043519" }, "creator_id": { "type": "integer", "description": "Id of the user that created the custom field.", "example": 1 }, "task_id": { "type": "integer", "description": "Id of the task", "example": 10 }, "project_id": { "type": "integer", "description": "Id of the project", "example": 10 }, "custom_field_id": { "type": "integer", "description": "Id of the project custom field", "example": 10 }, "name": { "type": "string", "description": "Title of the custom field.", "example": "Custom field name" }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the custom field is created.", "example": "2019-07-31T12:42:49.096305Z" }, "updated_at": { "type": "string", "format": "date-time", "description": "Date and time when the custom field is last updated.", "example": "2019-07-31T12:42:49.096305Z" }, "date": { "type": "string", "format": "date", "description": "Selected date value.", "example": "2019-07-31T12:42:49.096305Z" }, "is_checked": { "type": "boolean", "description": "Id of the selected member.", "example": true }, "selected_member": { "type": "string", "description": "List of selected members.", "example": 1 }, "numeric_value": { "type": "number", "description": "Numeric value added to the custom field.", "example": 220.1 }, "selected_dropdown": { "type": "string", "description": "UUID of the selected dropdown.", "example": "ceca0749-7cea-4ddf-beb9-33ea0b043519" }, "text": { "type": "string", "description": "Text of the custom field.", "example": "Some text goes here" } }, "type": "object" }, "Discussion": { "required": [ "description", "name" ], "properties": { "id": { "type": "integer", "description": "ID of the channel.", "example": 1 }, "autojoin": { "type": "boolean", "description": "True if new members are added to the channel automatically" }, "archived": { "type": "boolean", "description": "True if the project is archived, if false it is not." }, "created_at": { "type": "string", "format": "date-time", "description": "Date and time when the channel is created.", "example": "2019-07-31T12:42:49.096305Z" }, "last_update": { "type": "string", "description": "Date and time when the channel was last updated.", "example": "2019-09-22T23:22:33.000004Z" }, "created_by": { "type": "integer", "description": "ID of the channel creator.", "example": 1 }, "name": { "type": "string", "description": "Name of the channel.", "example": "Watercooler" }, "description": { "type": "string", "description": "Description of the channel.", "example": "Cool channel description" }, "picture": { "type": "string", "example": "https://some-image.com" } }, "type": "object" }, "Send message": { "required": [ "text" ], "properties": { "text": { "type": "string", "description": "Text of the message.", "example": "Hi, how are you?" } }, "type": "object" } }, "responses": { "ParseError": { "description": "When a mask can't be parsed" }, "MaskError": { "description": "When any error occurs on mask" } } }