{ "openapi": "3.0.0", "paths": { "/api/v1.0/apps": { "get": { "operationId": "AppsController_getApps", "summary": "Get Apps", "description": "This endpoint fetch the apps for team member.", "parameters": [ { "name": "limit", "required": true, "in": "query", "description": "No of records per page", "schema": { "example": "25", "type": "number" } }, { "name": "offset", "required": true, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "number" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "type": "array" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Apps" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/apps/{appId}": { "get": { "operationId": "AppsController_getApp", "summary": "Get App", "description": "This endpoint fetch the app for team member.", "parameters": [ { "name": "appId", "required": true, "in": "path", "description": "Enter app id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Apps" ], "security": [ { "bearer": [] } ] } }, "/oauth/token": { "post": { "operationId": "AuthenticationController_refreshToken", "summary": "Generate Token", "description": "Exchange OAuth app credentials for a bearer token pair (`access_token` + `refresh_token`) — returns both in one call.\n\n**`grant_type: \"authorization_code\"`** — first-time exchange, right after the user approves your app. Requires `code` (from the authorization redirect) and `redirect_uri` (must match the one used to obtain that code).\n\n**`grant_type: \"refresh_token\"`** — mint a fresh token pair once the access token nears expiry, without asking the user to re-approve. Requires `refresh_token` (from a prior call to this endpoint).\n\nBoth grant types also require `client_id` and `client_secret`, sent either as the request body fields or as HTTP Basic auth (`Authorization: Basic base64(client_id:client_secret)`).\n\nThe resulting `access_token` authenticates like any bearer token — `Authorization: Bearer ` — on both the v1.0 and v3 APIs.", "parameters": [ { "name": "authorization", "in": "header", "description": "The string Basic with your Client ID and Client Secret separated with colon (:), Base64-encoded. For example, Client_ID:Client_Secret Base64-encoded is Q2xpZW50X0lEOkNsaWVudF9TZWNyZXQ=.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateRefreshToken" } } } }, "responses": { "201": { "description": "The refresh and access token pair.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "401": { "description": "The client request has not been completed because it lacks valid authentication credentials for the requested resource." }, "403": { "description": "The client does not have access rights to the content." } }, "tags": [ "Authentication" ], "security": [ { "basic": [] } ] } }, "/oauth/authorize": { "get": { "operationId": "AuthenticationController_authorizeRedirect", "summary": "Authorize (browser entry point)", "description": "The OAuth 2.1 authorization endpoint (RFC 8414 `authorization_endpoint`).\nRedirect the end user's browser here to start the interactive consent\nflow — this is not an endpoint your application code calls directly.\nReturns a 302 to the Nifty consent screen; after the user approves or\ndenies, they land back on your `redirect_uri` with either a `code` or\nan `error` query parameter.", "parameters": [ { "name": "code_challenge_method", "required": false, "in": "query", "schema": { "type": "string", "enum": [ "S256", "plain" ] }, "description": "PKCE challenge method; use S256." }, { "name": "code_challenge", "required": false, "in": "query", "description": "PKCE challenge derived from your code verifier (RFC 7636).", "schema": { "type": "string" } }, { "name": "state", "required": false, "in": "query", "description": "Opaque value echoed back on the redirect; use it to defend against CSRF.", "schema": { "type": "string" } }, { "name": "scope", "required": false, "in": "query", "description": "Space-separated scopes to request.", "schema": { "type": "string" } }, { "name": "redirect_uri", "required": true, "in": "query", "description": "Where to send the user back to. Must be one of the app's registered redirect URLs.", "schema": { "type": "string" } }, { "name": "client_id", "required": true, "in": "query", "description": "Client id of your OAuth app.", "schema": { "type": "string" } }, { "name": "response_type", "required": true, "in": "query", "schema": { "type": "string", "enum": [ "code" ] }, "description": "Always `code` — Nifty implements the authorization-code flow." } ], "responses": { "302": { "description": "Redirects to the consent screen." } }, "tags": [ "Authentication" ] } }, "/api/v1.0/chats": { "get": { "operationId": "ChatApiController_getChats", "summary": "Get Chats", "description": "This endpoint fetch the list of chat id for team member.", "parameters": [], "responses": { "200": { "description": "Success Response" }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Chats" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/chats/{chat_id}": { "get": { "operationId": "ChatApiController_getChat", "summary": "Get Chat", "description": "This endpoint fetch the details for chat based on given chat id.", "parameters": [ { "name": "chat_id", "required": true, "in": "path", "description": "Chat id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Chats" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/docs": { "post": { "operationId": "DocumentsApiController_createDocument", "summary": "Create document", "description": "This endpoint creates a new document.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocument" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocumentResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] }, "get": { "operationId": "DocumentsApiController_getDocuments", "summary": "Get Documents", "description": "This endpoint fetch list of all the documents based on given query parameters. Documents are called \"docs\" on the wire; the path is /api/v1.0/docs.", "parameters": [ { "name": "project_id", "required": true, "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "task_id", "required": true, "in": "query", "description": "Task ID", "schema": { "type": "string" } }, { "name": "parent_doc_id", "required": false, "in": "query", "description": "Parent Document ID", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "No of records per page", "schema": { "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } }, { "name": "folder_id", "required": false, "in": "query", "description": "Folder ID", "schema": { "type": "string" } }, { "name": "author", "required": false, "in": "query", "description": "Document Author", "schema": { "type": "string" } }, { "name": "name", "required": false, "in": "query", "description": "Document Name", "schema": { "type": "string" } }, { "name": "tag", "required": false, "in": "query", "description": "Document Tag", "schema": { "type": "string" } }, { "name": "sort", "required": false, "in": "query", "description": "Sorting order, default is descending", "schema": { "enum": [ "ascending", "descending" ], "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentsResponse" }, "example": { "items": [ { "id": "Dc1sVb6Ky", "name": "Launch checklist", "access_type": "project", "type": "doc", "subtype": "nifty", "external_id": null, "author": "i5vtiganU9y25V", "project_id": "Pq4nZt7Rm", "tasks": [], "archived": false, "members": [ "i5vtiganU9y25V" ], "discussion_keys": [], "created_at": "2026-08-19T08:55:10.004Z", "comments": 0, "hasAccess": true, "labels": [ "Lb6yTn3Qw" ], "folder": "Fk3mQ8vTz", "order": 100, "multipage": false, "parent_doc_id": null } ], "hasMore": false } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/docs/personal": { "post": { "operationId": "DocumentsApiController_createPersonalDocument", "summary": "Create Personal Document", "description": "This endpoint creates a new personal document based on given request data.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocument" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonalDocumentResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] }, "get": { "operationId": "DocumentsApiController_getPersonalDocuments", "summary": "Get Personal Documents", "description": "This endpoint fetch lsit of all the personal documents based on given query parameters.", "parameters": [ { "name": "parent_doc_id", "required": false, "in": "query", "description": "Parent Document ID", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "No of records per page", "schema": { "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } }, { "name": "folder_id", "required": false, "in": "query", "description": "Folder ID", "schema": { "type": "string" } }, { "name": "author", "required": false, "in": "query", "description": "Document Author", "schema": { "type": "string" } }, { "name": "name", "required": false, "in": "query", "description": "Document name", "schema": { "type": "string" } }, { "name": "tag", "required": false, "in": "query", "description": "Document Tag", "schema": { "type": "string" } }, { "name": "sort", "required": false, "in": "query", "description": "Sorting order, default is descending", "schema": { "enum": [ "ascending", "descending" ], "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentsResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/docs/{document_id}": { "get": { "operationId": "DocumentsApiController_getDocument", "summary": "Get Document", "description": "This endpoint fetch a particular document based on document id.", "parameters": [ { "name": "document_id", "required": true, "in": "path", "description": "Document ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] }, "put": { "operationId": "DocumentsApiController_editDocument", "summary": "Update Document Metadata", "description": "This endpoint updates document using unique document id with given data.", "parameters": [ { "name": "document_id", "required": true, "in": "path", "description": "Document ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditDocument" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonalDocumentResponse" } } } }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "DocumentsApiController_removeDocument", "summary": "Remove Document", "description": "This endpoint removes a document using unique identifier id.", "parameters": [ { "name": "document_id", "required": true, "in": "path", "description": "Document ID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveDocumentResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/docs/{document_id}/move_to_project": { "put": { "operationId": "DocumentsApiController_moveDocument", "summary": "Move Document", "description": "This endpoint moves a document into another project folder.", "parameters": [ { "name": "document_id", "required": true, "in": "path", "description": "Document ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveDocument" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePersonalDocumentResponse" } } } }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/docs/{document_id}/members": { "put": { "operationId": "DocumentsApiController_addMembersToDocument", "summary": "Update Document Member", "description": "This endpoint updates document's members list", "parameters": [ { "name": "document_id", "required": true, "in": "path", "description": "Document ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentInvite" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddMembersToDocumentResponse" } } } }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "DocumentsApiController_removeMembersFromDocument", "summary": "Remove Document Member", "description": "This endpoint removes member from given document.", "parameters": [ { "name": "document_id", "required": true, "in": "path", "description": "Document ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentMemberRemove" } } } }, "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveMembersFromDocumentResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/docs/{document_id}/change": { "post": { "operationId": "DocumentsApiController_changeDocument", "summary": "Apply Document Changes", "description": "This endpoint update the document.", "parameters": [ { "name": "document_id", "required": true, "in": "path", "description": "Document ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeDocument" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessDocumentChangeResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/docs/{document_id}/labels": { "put": { "operationId": "DocumentsApiController_addLabels", "summary": "Update Document Labels", "description": "This endpoint updates the labels for the document.", "parameters": [ { "name": "document_id", "required": true, "in": "path", "description": "Document ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLabels" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLabelsReponse" } } } }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "DocumentsApiController_removeLabels", "summary": "Remove Document Labels", "description": "This endpoint removes labels from the document.", "parameters": [ { "name": "document_id", "required": true, "in": "path", "description": "Document ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLabels" } } } }, "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveLabelsResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Documents" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/fields": { "get": { "operationId": "FieldsApiController_getCustomFields", "summary": "Get Custom fields", "description": "This endpoint provides list of all the custom fields in the project.", "parameters": [ { "name": "Project ID", "required": false, "in": "query", "description": "If `project_id` parameter is not passed it will return team level all the custom fields.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "No of records per page", "schema": { "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldResponse" } } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Custom Fields" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/fields/{field_id}": { "get": { "operationId": "FieldsApiController_getCustomField", "summary": "Get Custom field", "description": "This endpoint provides details of the custom field in the project.", "parameters": [ { "name": "field_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Custom Fields" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/files": { "get": { "operationId": "FileApiController_getFiles", "summary": "Get Files", "description": "This endpoint fetch list of files based on the given query parameters. ", "parameters": [ { "name": "project_id", "required": true, "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "task_id", "required": true, "in": "query", "description": "Task ID", "schema": { "type": "string" } }, { "name": "doc_id", "required": true, "in": "query", "description": "Document ID", "schema": { "type": "string" } }, { "name": "user_id", "required": true, "in": "query", "description": "User ID", "schema": { "type": "string" } }, { "name": "type", "required": false, "in": "query", "description": "Type", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "No of records per page", "schema": { "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } }, { "name": "folder_id", "required": false, "in": "query", "description": "Folder ID", "schema": { "type": "string" } }, { "name": "name", "required": false, "in": "query", "description": "File Name", "schema": { "type": "string" } }, { "name": "group", "required": false, "in": "query", "description": "Group", "schema": { "type": "string" } }, { "name": "tag", "required": false, "in": "query", "description": "Tag", "schema": { "type": "string" } }, { "name": "sort", "required": false, "in": "query", "description": "Sorting order, default is descending", "schema": { "enum": [ "ascending", "descending" ], "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFilesResponseDto" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Files" ], "security": [ { "bearer": [] } ] }, "post": { "operationId": "FileApiController_uploadFiles", "summary": "Upload Files", "description": "This endpoint uploads multiples files.", "parameters": [ { "name": "project_id", "required": true, "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "task_id", "required": true, "in": "query", "description": "Task ID", "schema": { "type": "string" } }, { "name": "doc_id", "required": true, "in": "query", "description": "Document ID", "schema": { "type": "string" } }, { "name": "folder_id", "required": false, "in": "query", "description": "Folder ID", "schema": { "type": "string" } }, { "name": "folder_stack", "required": false, "in": "query", "description": "Folder stack", "schema": { "type": "array", "items": { "type": "string" } } } ], "requestBody": { "required": true, "description": "List of files", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/FilesUploadDto" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadFilesResponseDto" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Files" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/files/{file_id}": { "get": { "operationId": "FileApiController_getFile", "summary": "Get File", "description": "This endpoint fetch the details of the file based on unique file identified", "parameters": [ { "name": "file_id", "required": true, "in": "path", "description": "File ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileFullResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Files" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "FileApiController_removeFile", "summary": "Remove File", "description": "This endpoint removes the file using the unique file idetifier.", "parameters": [ { "name": "file_id", "required": true, "in": "path", "description": "File ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralFileResponse" } } } }, "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralFileResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Files" ], "security": [ { "bearer": [] } ] }, "put": { "operationId": "FileApiController_editFile", "summary": "Update File", "description": "This endpoint update the file details.", "parameters": [ { "name": "file_id", "required": true, "in": "path", "description": "File ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFile" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFileResponse" } } } }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Files" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/files/{file_id}/copy": { "post": { "operationId": "FileApiController_copyFile", "summary": "Copy File", "description": "This endpoint creates a new copy of the file.", "parameters": [ { "name": "file_id", "required": true, "in": "path", "description": "File ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyFile" } } } }, "responses": { "201": { "description": "The resource created successfully" }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Files" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/files/{file_id}/labels": { "put": { "operationId": "FileApiController_addLabels", "summary": "Add File Labels", "description": "This endpoint adds the labels for the file.", "parameters": [ { "name": "file_id", "required": true, "in": "path", "description": "File ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLabels" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLabelsReponse" } } } }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Files" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "FileApiController_removeLabels", "summary": "Remove File Labels", "description": "This endpoint remove the labels from the file.", "parameters": [ { "name": "file_id", "required": true, "in": "path", "description": "File ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLabels" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveLabelsResponse" } } } }, "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveLabelsResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Files" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/invites": { "get": { "operationId": "InviteController_getInviteLinks", "summary": "List Invite Links", "description": "Returns the workspace's invite links.", "parameters": [], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteTeamReponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Invite" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/labels": { "get": { "operationId": "LabelApiController_getLabels", "summary": "Get Tags", "description": "This endpoint fetch list of all the tag based on given query parameters. Tags are called \"labels\" on the wire; the path is /api/v1.0/labels.", "parameters": [ { "name": "limit", "required": false, "in": "query", "description": "No of records per page", "schema": { "example": 25, "type": "number" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": 0, "type": "number" } }, { "name": "type", "required": false, "in": "query", "description": "Label Type", "schema": { "enum": [ 0, 1 ], "type": "number" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLabelsDto" }, "example": { "items": [ { "id": "Lb6yTn3Qw", "name": "blocked", "color": "#E11D48", "type": "task", "created_by": "i5vtiganU9y25V", "team": "Tm9xPl4Vs", "default": "false" } ], "hasMore": false } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tags" ], "security": [ { "bearer": [] } ] }, "post": { "operationId": "LabelApiController_createLabel", "summary": "Create Tag", "description": "This endpoint create a new tag record.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabelBody" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralLabelResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tags" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/labels/{label_id}": { "get": { "operationId": "LabelApiController_getLabel", "summary": "Get Tag", "description": "This endpoint fetch the tag details using unique label_id.", "parameters": [ { "name": "label_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LabelResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tags" ], "security": [ { "bearer": [] } ] }, "put": { "operationId": "LabelApiController_editLabel", "summary": "Update Tag", "description": "This endpoint update the tag details using unique label_id.", "parameters": [ { "name": "label_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLabelBody" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralLabelResponse" } } } }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tags" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "LabelApiController_removeLabel", "summary": "Remove Tag", "description": "This endpoint removes the tag using unique label_id.", "parameters": [ { "name": "label_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralLabelResponse" } } } }, "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralLabelResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tags" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/members": { "get": { "operationId": "MemberController_getMembers", "summary": "List Members", "description": "This endpoint fetch the members details. The { items, hasMore } envelope shown below is returned only when BOTH limit and offset are sent; without them the response is a bare array of members.", "parameters": [], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMembersReponse" }, "example": { "items": [ { "id": "i5vtiganU9y25V", "user_id": "Us8rDq2Wt", "email": "ada@example.com", "name": "Ada Lovelace", "initials": "AL", "avatar": "https://cdn.niftypm.com/avatars/ada.png", "pending": false, "removed": false, "theme": "light", "team": "Tm9xPl4Vs", "role": "Owner", "tz": -300, "tz_iana": "America/New_York", "tz_offset": "-05:00", "color": "#00A99B", "secondary_color": "#0F172A", "online": true, "signedUp": true, "tours": [], "skipped_help": [], "notificationSettings": [], "labels": [], "sidebar_tabs": true, "total_story_points": 34, "completed_story_points": 13 } ], "hasMore": false } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Members" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/members/{member_id}": { "get": { "operationId": "MemberController_getMember", "summary": "Get Member", "description": "This endpoint fetch the user using user id parameter.", "parameters": [ { "name": "member_id", "required": true, "in": "path", "description": "Provide member id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response" }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Members" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/messages": { "post": { "operationId": "MessagesApiController_createMessage", "summary": "Create Message", "description": "This endpoint creates a new message.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessageDto" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMessageResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Messages" ], "security": [ { "bearer": [] } ] }, "get": { "operationId": "MessagesApiController_getMessages", "summary": "Get Messages", "description": "This endpoint fetch the list of recent messages.", "parameters": [ { "name": "chat_id", "required": false, "in": "query", "description": "Chat ID", "schema": { "type": "string" } }, { "name": "message_id", "required": false, "in": "query", "description": "Message ID", "schema": { "type": "string" } }, { "name": "task_id", "required": false, "in": "query", "description": "Task ID", "schema": { "type": "string" } }, { "name": "file_id", "required": false, "in": "query", "description": "File ID", "schema": { "type": "string" } }, { "name": "doc_id", "required": false, "in": "query", "description": "Document ID", "schema": { "type": "string" } }, { "name": "entity_key", "required": false, "in": "query", "description": "Entity Key", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "No of records per page", "schema": { "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } }, { "name": "before_id", "required": false, "in": "query", "description": "Before ID", "schema": { "type": "string" } }, { "name": "after_id", "required": false, "in": "query", "description": "After ID", "schema": { "type": "string" } }, { "name": "before_date", "required": false, "in": "query", "description": "Before Date", "schema": { "type": "string" } }, { "name": "after_date", "required": false, "in": "query", "description": "After Date", "schema": { "type": "string" } }, { "name": "annotation_id", "required": false, "in": "query", "description": "Annotation ID", "schema": { "type": "string" } }, { "name": "type", "required": false, "in": "query", "description": "Type", "schema": { "type": "string" } }, { "name": "useCache", "required": false, "in": "query", "description": "Use Cache", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMessagesResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Messages" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/messages/{message_id}": { "get": { "operationId": "MessagesApiController_getMessage", "summary": "Get Message", "description": "This endpoint fetch more details about the message.", "parameters": [ { "name": "message_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Messages" ], "security": [ { "bearer": [] } ] }, "put": { "operationId": "MessagesApiController_editMessage", "summary": "Update Message", "description": "This endpoint update the message.", "parameters": [ { "name": "message_id", "required": true, "in": "path", "description": "Message ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditMessageDto" } } } }, "responses": { "200": { "description": "Success Response" }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Messages" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "MessagesApiController_deleteMessage", "summary": "Remove Message", "description": "This endpoint removes the message.", "parameters": [ { "name": "message_id", "required": true, "in": "path", "description": "Message ID", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteMessageResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Messages" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/messages/{message_id}/see": { "post": { "operationId": "MessagesApiController_seeMessage", "summary": "Mark Message seen", "description": "This endpoint marks the message as seen by the member.", "parameters": [ { "name": "message_id", "required": true, "in": "path", "description": "Message ID", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeeMessageResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Messages" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/messages/{message_id}/hear": { "post": { "operationId": "MessagesApiController_hearMessage", "summary": "Mark Message heard", "description": "This endpoint marks the message as heard by the member.", "parameters": [ { "name": "message_id", "required": true, "in": "path", "description": "Message ID", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HearMessageResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Messages" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/milestones": { "get": { "operationId": "MilestoneApiController_getMilestones", "summary": "Get Milestones", "description": "This endpoint fetch the list of milestones. Milestones are what the app calls \"Lists\"; the path is /api/v1.0/milestones.", "parameters": [ { "name": "project_id", "required": true, "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "No of records per page", "schema": { "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } }, { "name": "sort", "required": false, "in": "query", "description": "Sorting order, default is descending", "schema": { "enum": [ "ascending", "descending" ], "type": "string" } }, { "name": "is_list", "required": false, "in": "query", "description": "List Flag", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMilestonesReponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Milestones & Lists" ], "security": [ { "bearer": [] } ] }, "post": { "operationId": "MilestoneApiController_createMilestone", "summary": "Create Milestone", "description": "This endpoint creates the milestone.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMilestone" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MilestoneReponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Milestones & Lists" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/milestones/{milestone_id}": { "get": { "operationId": "MilestoneApiController_getMilestone", "summary": "Get Milestone", "description": "This endpoint fetch the milestone information.", "parameters": [ { "name": "milestone_id", "required": true, "in": "path", "description": "Milestone ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MilestoneShortView" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Milestones & Lists" ], "security": [ { "bearer": [] } ] }, "put": { "operationId": "MilestoneApiController_editMilestone", "summary": "Update Milestone", "description": "This endpoint updates the milestone details.", "parameters": [ { "name": "milestone_id", "required": true, "in": "path", "description": "Milestone ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMilestoneDto" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMilestoneResponse" } } } }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Milestones & Lists" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "MilestoneApiController_removeMilestone", "summary": "Remove Milestone", "description": "This endpoint removes the milestone.", "parameters": [ { "name": "milestone_id", "required": true, "in": "path", "description": "Milestone ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMilestoneResponse" } } } }, "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMilestoneResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Milestones & Lists" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/milestones/{milestone_id}/move_to_project": { "put": { "operationId": "MilestoneApiController_moveToProject", "summary": "Move Milestone", "description": "This endpoint moves the milestone to the project.", "parameters": [ { "name": "milestone_id", "required": true, "in": "path", "description": "Milestone ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveToProjectMilestoneDto" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMilestoneResponse" } } } }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Milestones & Lists" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/milestones/{milestone_id}/tasks": { "put": { "operationId": "MilestoneApiController_tieTasks", "summary": "Tie Task To Milestone", "description": "This endpoint adds the list of tasks to the milestone.", "parameters": [ { "name": "milestone_id", "required": true, "in": "path", "description": "Milestone ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTasks" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MilestoneTasksResponse" } } } }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Milestones & Lists" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "MilestoneApiController_untieTasks", "summary": "Remove Milestone Task", "description": "This endpoint removes the list of task from the milestone.", "parameters": [ { "name": "milestone_id", "required": true, "in": "path", "description": "Milestone ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTasks" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MilestoneTasksResponse" } } } }, "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MilestoneTasksResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Milestones & Lists" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/milestones/{milestone_id}/archive": { "post": { "operationId": "MilestoneApiController_changeMilestoneStatus", "summary": "Archive Milestone", "description": "This endpoint archives the milestone details.", "parameters": [ { "name": "milestone_id", "required": true, "in": "path", "description": "Milestone ID", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStatus" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMilestoneResponse" } } } }, "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMilestoneResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Milestones & Lists" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/projects": { "get": { "operationId": "ProjectAPIController_getProjects", "summary": "Get Projects", "description": "This endpoint fetch the list of projects for the team member.", "parameters": [ { "name": "subteam_id", "required": false, "in": "query", "description": "Subteam ID", "schema": { "type": "string" } }, { "name": "archived", "required": false, "in": "query", "description": "Archived : true or false", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "No of records to fetch", "schema": { "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } }, { "name": "sort", "required": false, "in": "query", "description": "Sorting order, default is ascending", "schema": { "enum": [ "ascending", "descending" ], "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectListResponse" }, "example": { "projects": [ { "id": "Pq4nZt7Rm", "nice_id": "PROJ", "name": "Website relaunch", "description": "Marketing site rebuild for the Q4 launch.", "initials": "WR", "logo": null, "color": "#00A99B", "secondary_color": "#0F172A", "demo": false, "archived": false, "auto_milestones": false, "default_tasks_view": "kanban", "access_type": "team", "owner": "i5vtiganU9y25V", "members": [ "i5vtiganU9y25V", "j7kwmqbxT2p9Lm" ], "general_discussion": "Ds3vRk8Wq", "subteam": "St5hYc1Bn", "progress": 42, "joined": true, "general_discussion_muted": false, "enabled_modules": [ "tasks", "discussions", "docs" ], "disabled_modules": [ "time" ], "total_story_points": 34, "completed_story_points": 13, "removed": false } ], "hasMore": false } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Projects" ], "security": [ { "bearer": [] } ] }, "post": { "operationId": "ProjectAPIController_createProject", "summary": "Create Project", "description": "This endpoint creates the project details.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectDto" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectResponse" }, "example": { "id": "Pq4nZt7Rm", "nice_id": "PROJ", "name": "Website relaunch", "description": "Marketing site rebuild for the Q4 launch.", "initials": "WR", "logo": null, "color": "#00A99B", "secondary_color": "#0F172A", "demo": false, "archived": false, "auto_milestones": false, "default_tasks_view": "kanban", "access_type": "team", "owner": "i5vtiganU9y25V", "members": [ "i5vtiganU9y25V", "j7kwmqbxT2p9Lm" ], "general_discussion": "Ds3vRk8Wq", "subteam": "St5hYc1Bn", "progress": 42, "joined": true, "general_discussion_muted": false, "enabled_modules": [ "tasks", "discussions", "docs" ], "disabled_modules": [ "time" ], "total_story_points": 34, "completed_story_points": 13, "removed": false } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Projects" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/projects/{project_id}": { "get": { "operationId": "ProjectAPIController_getProjectById", "summary": "Get Project", "description": "This endpoint fetch the project details.", "parameters": [ { "name": "project_id", "required": true, "in": "path", "description": "Enter project id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectResponse" }, "example": { "id": "Pq4nZt7Rm", "nice_id": "PROJ", "name": "Website relaunch", "description": "Marketing site rebuild for the Q4 launch.", "initials": "WR", "logo": null, "color": "#00A99B", "secondary_color": "#0F172A", "demo": false, "archived": false, "auto_milestones": false, "default_tasks_view": "kanban", "access_type": "team", "owner": "i5vtiganU9y25V", "members": [ "i5vtiganU9y25V", "j7kwmqbxT2p9Lm" ], "general_discussion": "Ds3vRk8Wq", "subteam": "St5hYc1Bn", "progress": 42, "joined": true, "general_discussion_muted": false, "enabled_modules": [ "tasks", "discussions", "docs" ], "disabled_modules": [ "time" ], "total_story_points": 34, "completed_story_points": 13, "removed": false } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Projects" ], "security": [ { "bearer": [] } ] }, "put": { "operationId": "ProjectAPIController_updateProject", "summary": "Update Project", "description": "This endpoint updates the project details.", "parameters": [ { "name": "project_id", "required": true, "in": "path", "description": "Enter project id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectDto" } }, "multipart/form-data": { "schema": { "$ref": "#/components/schemas/UpdateProjectDto" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralProjectReponse" } } } }, "400": { "description": "Neither a new name nor a logo file was sent.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Projects" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "ProjectAPIController_deleteProject", "summary": "Remove Project", "description": "This endpoint removes the project details.", "parameters": [ { "name": "project_id", "required": true, "in": "path", "description": "Enter project id", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteProjectReponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Projects" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/projects/{project_id}/invite": { "post": { "operationId": "ProjectAPIController_invite", "summary": "Invite Team Member for project", "description": "This endpoint sends invitation details to the team member.", "parameters": [ { "name": "project_id", "required": true, "in": "path", "description": "Enter project id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteProjectDto" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectInviteResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Projects" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/projects/{project_id}/leave": { "post": { "operationId": "ProjectAPIController_leaveProject", "summary": "Leave Project", "description": "This endpoint use to leave the project by team member.", "parameters": [ { "name": "project_id", "required": true, "in": "path", "description": "Enter project id", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaveProjectReponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Projects" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/projects/{project_id}/start": { "post": { "operationId": "ProjectAPIController_startProject", "summary": "Start Project", "description": "This endpoint marks the project as start state.", "parameters": [ { "name": "project_id", "required": true, "in": "path", "description": "Enter project id", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The resource created successfully" }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Projects" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/projects/{project_id}/fields": { "post": { "operationId": "ProjectAPIController_addField", "summary": "Add Project Custom Fields", "description": "This endpoint creates the custom fields for the project.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomField" } } } }, "responses": { "201": { "description": "The resource created successfully" }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Projects" ], "security": [ { "bearer": [] } ] }, "get": { "operationId": "ProjectAPIController_getFields", "summary": "Get Project Custom Fields", "description": "This endpoint fetch the custom fields for the project.", "parameters": [ { "name": "project_id", "required": true, "in": "path", "description": "Enter project id", "schema": { "type": "string" } }, { "name": "Project ID", "required": false, "in": "query", "description": "If `project_id` parameter is not passed it will return team level all the custom fields.", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "No of records per page", "schema": { "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachedCustomFieldResponse" } } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Projects" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/projects/{project_id}/fields/{field_id}": { "put": { "operationId": "ProjectAPIController_updateField", "summary": "Update Project Custom Fields", "description": "This endpoint update the custom fields details for the project.", "parameters": [ { "name": "project_id", "required": true, "in": "path", "description": "Enter project id", "schema": { "type": "string" } }, { "name": "field_id", "required": true, "in": "path", "description": "Enter field id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response" }, "204": { "description": "The record doesn't exist." }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Projects" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/subteams": { "post": { "operationId": "SubTeamsApiController_createSubteam", "summary": "Create Portfolio", "description": "This endpoint creates new portfolio", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubteam" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubteamGeneralResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Portfolios" ], "security": [ { "bearer": [] } ] }, "get": { "operationId": "SubTeamsApiController_getSubteams", "summary": "Get Portfolios", "description": "This endpoint fetch list of portfolios. Portfolios are called \"subteams\" on the wire; the path is /api/v1.0/subteams.", "parameters": [], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSubTeamsResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Portfolios" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/subteams/{subteam_id}": { "get": { "operationId": "SubTeamsApiController_getSubteam", "summary": "Get Portfolio", "description": "This endpoint fetch the prortfolio details using unique identifier id.", "parameters": [ { "name": "subteam_id", "required": true, "in": "path", "description": "Enter sub team id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubteamResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Portfolios" ], "security": [ { "bearer": [] } ] }, "put": { "operationId": "SubTeamsApiController_editSubteam", "summary": "Update Portfolio", "description": "This endpoint update the portfolio details using unique identifier id.", "parameters": [ { "name": "subteam_id", "required": true, "in": "path", "description": "Enter subteam id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSubteam" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubteamGeneralResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Portfolios" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "SubTeamsApiController_removeSubteam", "summary": "Remove Portfolio", "description": "This endpoint removes the portfolio using unique identifier id.", "parameters": [ { "name": "subteam_id", "required": true, "in": "path", "description": "Enter subteam id", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubteamGeneralResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Portfolios" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/subteams/{subteam_id}/members": { "put": { "operationId": "SubTeamsApiController_addMembers", "summary": "Update Portfolio Member", "description": "This endpoint update the list of members in the portfolio.", "parameters": [ { "name": "subteam_id", "required": true, "in": "path", "description": "Enter subteam id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubteamMembersModify" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubteamGeneralResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Portfolios" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "SubTeamsApiController_removeMembers", "summary": "Remove Portfolio Member", "description": "This endpoint removes the member from the portfolio.", "parameters": [ { "name": "subteam_id", "required": true, "in": "path", "description": "Enter subteam id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubteamMembersModify" } } } }, "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubteamGeneralResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Portfolios" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/subteams/{subteam_id}/leave": { "post": { "operationId": "SubTeamsApiController_leaveSubteam", "summary": "Leave Portfolio", "description": "This endpoint helps the member to leave from the portfolio.", "parameters": [ { "name": "subteam_id", "required": true, "in": "path", "description": "Enter subteam id", "schema": { "type": "string" } } ], "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubteamGeneralResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Portfolios" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks": { "get": { "operationId": "TaskApiController_getTasks", "summary": "Get Tasks", "description": "This endpoint fetch the list of tasks for the team member.", "parameters": [ { "name": "project_id", "required": false, "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "task_group_id", "required": false, "in": "query", "description": "Task Group ID", "schema": { "type": "string" } }, { "name": "task_id", "required": false, "in": "query", "description": "Task ID", "schema": { "type": "string" } }, { "name": "member_id", "required": false, "in": "query", "description": "Member ID", "schema": { "type": "string" } }, { "name": "meeting_id", "required": false, "in": "query", "description": "Meeting ID", "schema": { "type": "string" } }, { "name": "milestone_id", "required": false, "in": "query", "description": "Milestone ID", "schema": { "type": "string" } }, { "name": "completed_by", "required": false, "in": "query", "description": "Completed By", "schema": { "type": "string" } }, { "name": "archived", "required": false, "in": "query", "description": "Archived", "schema": { "type": "string" } }, { "name": "include_archived", "required": false, "in": "query", "description": "Include Archived", "schema": { "type": "string" } }, { "name": "completed", "required": false, "in": "query", "description": "Completed", "schema": { "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Page size. There is no server maximum; keep it at or below 100.", "schema": { "default": "25", "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } }, { "name": "order", "required": false, "in": "query", "description": "Sort field and direction, colon-separated: dueDate:ASC, dueDate:DESC, archivedOn:DESC, completedOn:DESC. When order is set, sort is ignored.", "schema": { "example": "dueDate:DESC", "type": "string" } }, { "name": "from", "required": false, "in": "query", "description": "Start of the due-date window. Both `from` and `to` must be sent for the filter to apply; ISO 8601, UTC.", "schema": { "type": "string" } }, { "name": "to", "required": false, "in": "query", "description": "End of the due-date window. Both `from` and `to` must be sent for the filter to apply; ISO 8601, UTC.", "schema": { "type": "string" } }, { "name": "archived_from", "required": false, "in": "query", "description": "Start of the archived-on window. Both `archived_from` and `archived_to` must be sent for the filter to apply; ISO 8601, UTC.", "schema": { "type": "string" } }, { "name": "archived_to", "required": false, "in": "query", "description": "End of the archived-on window. Both `archived_from` and `archived_to` must be sent for the filter to apply; ISO 8601, UTC.", "schema": { "type": "string" } }, { "name": "completed_from", "required": false, "in": "query", "description": "Start of the completed-on window. Both `completed_from` and `completed_to` must be sent for the filter to apply; ISO 8601, UTC.", "schema": { "type": "string" } }, { "name": "completed_to", "required": false, "in": "query", "description": "End of the completed-on window. Both `completed_from` and `completed_to` must be sent for the filter to apply; ISO 8601, UTC.", "schema": { "type": "string" } }, { "name": "include_subtasks", "required": false, "in": "query", "description": "Include Subtask", "schema": { "type": "boolean" } }, { "name": "sort", "required": false, "in": "query", "description": "Sorting order, default is ascending. Ignored when `order` is present.", "schema": { "enum": [ "ascending", "descending" ], "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTasksResponse" }, "example": { "tasks": [ { "id": "Kx8vQ2mT1", "nice_id": "142", "name": "Draft the Q4 board deck", "description": "Pull the revenue chart from the finance sheet first.", "order": 300, "created_at": "2026-09-01T10:12:44.128Z", "created_by": "i5vtiganU9y25V", "archived": false, "completed": false, "due_date": "2026-09-11T17:00:00.000Z", "start_date": "2026-09-07T09:00:00.000Z", "reminder": null, "task_group": "Tg4pQw9Zx", "task": null, "project": "Pq4nZt7Rm", "milestone": "Ms2kLp8Vd", "assignees": [ "i5vtiganU9y25V" ], "subscribers": [ "i5vtiganU9y25V" ], "labels": [ "Lb6yTn3Qw" ], "linked_tasks": [], "documents": [], "attachments": [], "fields": [], "hidden": [], "total_subtasks": 3, "completed_subtasks": 1, "comments": 2, "story_points": 5, "tracked_time": 5400, "project_archived": false, "meeting_ids": [], "related_commits": [], "related_prs": [] } ], "hasMore": false } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] }, "post": { "operationId": "TaskApiController_createTask", "summary": "Create Task", "description": "This endpoint creates the task for the team member.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTaskBody" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskResponse" }, "example": { "id": "Kx8vQ2mT1", "nice_id": "142", "name": "Draft the Q4 board deck", "description": "Pull the revenue chart from the finance sheet first.", "order": 300, "created_at": "2026-09-01T10:12:44.128Z", "created_by": "i5vtiganU9y25V", "archived": false, "completed": false, "due_date": "2026-09-11T17:00:00.000Z", "start_date": "2026-09-07T09:00:00.000Z", "reminder": null, "task_group": "Tg4pQw9Zx", "task": null, "project": "Pq4nZt7Rm", "milestone": "Ms2kLp8Vd", "assignees": [ "i5vtiganU9y25V" ], "subscribers": [ "i5vtiganU9y25V" ], "labels": [ "Lb6yTn3Qw" ], "linked_tasks": [], "documents": [], "attachments": [], "fields": [], "hidden": [], "total_subtasks": 3, "completed_subtasks": 1, "comments": 2, "story_points": 5, "tracked_time": 5400, "project_archived": false, "meeting_ids": [], "related_commits": [], "related_prs": [] } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "TaskApiController_deleteTasks", "summary": "Remove Tasks (bulk)", "description": "This endpoint removes the task.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveTasks" } } } }, "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/personal": { "get": { "operationId": "TaskApiController_getPersonalTasks", "summary": "Get Personal Tasks", "description": "This endpoint fetch the list of personal tasks for the team member.", "parameters": [ { "name": "limit", "required": true, "in": "query", "description": "No of records per page", "schema": { "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } }, { "name": "meeting_id", "required": false, "in": "query", "description": "Meeting ID", "schema": { "type": "string" } }, { "name": "completed", "required": false, "in": "query", "description": "Completed?", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTasksResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] }, "post": { "operationId": "TaskApiController_createPersonalTask", "summary": "Create Personal Task", "description": "This endpoint creates a personal task for the team member.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPersonalTasksDto" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonalTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/{task_id}": { "get": { "operationId": "TaskApiController_getTask", "summary": "Get Task", "description": "This endpoint fetch the task details for the team member.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskResponse" }, "example": { "id": "Kx8vQ2mT1", "nice_id": "142", "name": "Draft the Q4 board deck", "description": "Pull the revenue chart from the finance sheet first.", "order": 300, "created_at": "2026-09-01T10:12:44.128Z", "created_by": "i5vtiganU9y25V", "archived": false, "completed": false, "due_date": "2026-09-11T17:00:00.000Z", "start_date": "2026-09-07T09:00:00.000Z", "reminder": null, "task_group": "Tg4pQw9Zx", "task": null, "project": "Pq4nZt7Rm", "milestone": "Ms2kLp8Vd", "assignees": [ "i5vtiganU9y25V" ], "subscribers": [ "i5vtiganU9y25V" ], "labels": [ "Lb6yTn3Qw" ], "linked_tasks": [], "documents": [], "attachments": [], "fields": [], "hidden": [], "total_subtasks": 3, "completed_subtasks": 1, "comments": 2, "story_points": 5, "tracked_time": 5400, "project_archived": false, "meeting_ids": [], "related_commits": [], "related_prs": [] } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] }, "put": { "operationId": "TaskApiController_editTask", "summary": "Update Task", "description": "This endpoint update the task details.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "TaskApiController_removeTask", "summary": "Remove Task", "description": "This endpoint removes the task details.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/{task_id}/milestone": { "put": { "operationId": "TaskApiController_updateTaskMilestone", "summary": "Update Task Milestone", "description": "This endpoint adds milestone details for the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskMilestoneReponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/{task_id}/complete": { "post": { "operationId": "TaskApiController_completeTask", "summary": "Complete Task", "description": "This endpoint updates the task as completed.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "boolean" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletedTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/{task_id}/archive": { "post": { "operationId": "TaskApiController_archiveTask", "summary": "Archive Task", "description": "This endpoint archives the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "boolean" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletedTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/{task_id}/moveOrder": { "post": { "operationId": "TaskApiController_moveTaskNew", "summary": "Reorder Task", "description": "This endpoint moves the order of the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveTaskNew" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletedTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/{task_id}/assignees": { "put": { "operationId": "TaskApiController_assignTask", "summary": "Assign Task", "description": "This endpoint adds assignee to the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssigneesBody" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletedTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "TaskApiController_unassignTask", "summary": "Remove Assignee", "description": "This endpoint removes the assignee to the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssigneesBody" } } } }, "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletedTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/{task_id}/labels": { "put": { "operationId": "TaskApiController_addLabels", "summary": "Add Labels", "description": "This endpoint adds the labels to the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLabels" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLabelsToTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "TaskApiController_removeLabels", "summary": "Remove Labels", "description": "This endpoint removes the labels from the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLabels" } } } }, "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddLabelsToTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/{task_id}/fields": { "post": { "operationId": "TaskApiController_addField", "summary": "Add Fields", "description": "This endpoint adds the custom field to the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomField" } } } }, "responses": { "201": { "description": "The resource created successfully" }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] }, "get": { "operationId": "TaskApiController_getFields", "summary": "Get Fields", "description": "This endpoint fetch the custom field of the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttachedCustomFieldResponse" } } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/{task_id}/fields/{field_id}": { "put": { "operationId": "TaskApiController_updateField", "summary": "Update Fields", "description": "This endpoint updates the custom field detail of the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } }, { "name": "field_id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response" }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/{task_id}/documents": { "put": { "operationId": "TaskApiController_attachDocument", "summary": "Add Document", "description": "This endpoint adds document to the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/{task_id}/clone": { "post": { "operationId": "TaskApiController_cloneTask", "summary": "Clone Task", "description": "This endpoint creates clone copy of the task.", "parameters": [ { "name": "task_id", "required": true, "in": "path", "description": "Enter task id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/tasks/move": { "post": { "operationId": "TaskApiController_moveTasks", "summary": "Move Tasks to Project", "description": "This endpoint moves the task.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveTasks" } } } }, "responses": { "201": { "description": "The resource created successfully" }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Tasks" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/taskgroups": { "get": { "operationId": "TaskgroupApiController_getTaskGroups", "summary": "Get Statuses", "description": "This endpoint fetch the list of statuses for the team member. Statuses are called \"taskgroups\" on the wire; the path is /api/v1.0/taskgroups.", "parameters": [ { "name": "project_id", "required": true, "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "archived", "required": false, "in": "query", "description": "Archived", "schema": { "type": "boolean" } }, { "name": "limit", "required": false, "in": "query", "description": "No of records per page", "schema": { "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } }, { "name": "sort", "required": false, "in": "query", "description": "Sorting order, default is ascending", "schema": { "enum": [ "ascending", "descending" ], "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTaskGroupsResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Status" ], "security": [ { "bearer": [] } ] }, "post": { "operationId": "TaskgroupApiController_createTaskGroup", "summary": "Create Status", "description": "This endpoint creates a new status using the provided details.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTaskGroupBody" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskGroupCompactResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Status" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/taskgroups/{taskgroup_id}": { "get": { "operationId": "TaskgroupApiController_getTaskGroup", "summary": "Get Status", "description": "This endpoint fetch the status details using unique identifier.", "parameters": [ { "name": "taskgroup_id", "required": true, "in": "path", "description": "Enter status id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskGroupResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Status" ], "security": [ { "bearer": [] } ] }, "put": { "operationId": "TaskgroupApiController_updateTaskGroup", "summary": "Update Status", "description": "This endpoint updates the status details using unique identifier.", "parameters": [ { "name": "taskgroup_id", "required": true, "in": "path", "description": "Enter status id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskGroupDto" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskGroupGeneralResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Status" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "TaskgroupApiController_removeTaskGroup", "summary": "Remove Status", "description": "This endpoint removes the status details using unique identifier.", "parameters": [ { "name": "taskgroup_id", "required": true, "in": "path", "description": "Enter status id", "schema": { "type": "string" } } ], "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskGroupGeneralResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Status" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/taskgroups/{taskgroup_id}/move": { "post": { "operationId": "TaskgroupApiController_moveAllTasks", "summary": "Move Tasks", "description": "This endpoint transfers list of all the tasks to the given status.", "parameters": [ { "name": "taskgroup_id", "required": true, "in": "path", "description": "Enter status id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveAllTasks" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskGroupGeneralResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Status" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/taskgroups/{taskgroup_id}/assignees": { "put": { "operationId": "TaskgroupApiController_assignTask", "summary": "Assign Status Members", "description": "This endpoint assignes the list of members to the status.", "parameters": [ { "name": "taskgroup_id", "required": true, "in": "path", "description": "Enter status id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssigneesBody" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskGroupGeneralResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Status" ], "security": [ { "bearer": [] } ] }, "delete": { "operationId": "TaskgroupApiController_unassignTask", "summary": "Remove Status Member", "description": "This endpoint removes the list of members to the status.", "parameters": [ { "name": "taskgroup_id", "required": true, "in": "path", "description": "Enter status id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssigneesBody" } } } }, "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskGroupGeneralResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Status" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/templates": { "get": { "operationId": "TemplateController_getProjectTemplates", "summary": "Get Templates", "description": "This endpoint fetch the list of all project templates.", "parameters": [ { "name": "type", "required": true, "in": "query", "description": "Template Type", "schema": { "enum": [ 0, 1, 2, 3 ], "type": "number" } }, { "name": "limit", "required": false, "in": "query", "description": "No of records to fetch", "schema": { "example": "25", "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Record Offset", "schema": { "example": "0", "type": "string" } } ], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateResponseDto" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Templates" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/time": { "get": { "operationId": "TimeController_getTimeReport", "summary": "Get Tracked Time Report", "description": "This endpoint fetch the tracked time report information based on provided criteria.", "parameters": [ { "name": "project_id", "required": false, "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "task_id", "required": false, "in": "query", "description": "Task ID", "schema": { "type": "string" } }, { "name": "member_id", "required": false, "in": "query", "description": "Member ID", "schema": { "type": "string" } }, { "name": "start_date", "required": false, "in": "query", "description": "Start Date", "schema": { "format": "date-time", "type": "string" } }, { "name": "end_date", "required": false, "in": "query", "description": "End Date", "schema": { "format": "date-time", "type": "string" } }, { "name": "limit", "required": false, "in": "query", "description": "Limit", "schema": { "type": "string" } }, { "name": "offset", "required": false, "in": "query", "description": "Offset", "schema": { "type": "string" } }, { "name": "type", "required": false, "in": "query", "description": "Type", "schema": { "enum": [ "running", "all" ], "type": "string" } } ], "responses": { "200": { "description": "Success Response" }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Time Tracking" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/time/duration": { "get": { "operationId": "TimeController_getDuration", "summary": "Get Tracked Time Duration", "description": "This endpoint fetch the tracked time duration information based on provided criteria.", "parameters": [ { "name": "start", "required": true, "in": "query", "description": "Start Date", "schema": { "type": "string" } }, { "name": "end", "required": true, "in": "query", "description": "End Date", "schema": { "type": "string" } }, { "name": "project_id", "required": false, "in": "query", "description": "Project ID", "schema": { "type": "string" } }, { "name": "task_id", "required": false, "in": "query", "description": "Task ID", "schema": { "type": "string" } }, { "name": "user_id", "required": false, "in": "query", "description": "User ID", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success Response" }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Time Tracking" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/users/me": { "get": { "operationId": "UserApiController_getMe", "summary": "Get User Details", "description": "This endpoint fetch the user information.", "parameters": [], "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberViewResponse" }, "example": { "id": "i5vtiganU9y25V", "user_id": "Us8rDq2Wt", "email": "ada@example.com", "name": "Ada Lovelace", "initials": "AL", "avatar": "https://cdn.niftypm.com/avatars/ada.png", "pending": false, "removed": false, "theme": "light", "team": "Tm9xPl4Vs", "role": "Owner", "tz": -300, "tz_iana": "America/New_York", "tz_offset": "-05:00", "color": "#00A99B", "secondary_color": "#0F172A", "online": true, "signedUp": true, "tours": [], "skipped_help": [], "notificationSettings": [], "labels": [], "sidebar_tabs": true, "total_story_points": 34, "completed_story_points": 13 } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Users" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/webhooks/{app_id}": { "get": { "operationId": "WebhookApiController_getWebhooks", "summary": "Get Webhooks", "description": "This endpoint fetch list of all webhook registerd by team member.", "parameters": [ { "name": "app_id", "required": true, "in": "path", "description": "Enter application id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhooksDto" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWebhooksResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Webhook" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/webhooks": { "post": { "operationId": "WebhookApiController_addWebhook", "summary": "Create Webhook", "description": "This endpoint register a new webhook endpoint.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookDto" } } } }, "responses": { "201": { "description": "The resource created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookReponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Webhook" ], "security": [ { "bearer": [] } ] } }, "/api/v1.0/webhooks/{webhook_id}": { "delete": { "operationId": "WebhookApiController_removeWebhook", "summary": "Remove Webhook", "description": "This endpoint remove webhook endpoint.", "parameters": [ { "name": "webhook_id", "required": true, "in": "path", "description": "Enter webhook id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveWebhookDto" } } } }, "responses": { "204": { "description": "The record has been updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveWebhookResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "The record doesn't exist." }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Webhook" ], "security": [ { "bearer": [] } ] }, "put": { "operationId": "WebhookApiController_updateWebhook", "summary": "Update Webhook", "description": "This endpoint updates an existing webhook endpoint.", "parameters": [ { "name": "webhook_id", "required": true, "in": "path", "description": "Enter webhook id", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookDto" } } } }, "responses": { "200": { "description": "Success Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWebhookResponse" } } } }, "400": { "description": "Validation failed or a required field is missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Missing, invalid or revoked bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "403": { "description": "The client does not have access rights to the content." }, "404": { "description": "No resource with that id in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "429": { "description": "Rate limit exceeded; wait for Retry-After seconds.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": [ "Webhook" ], "security": [ { "bearer": [] } ] } } }, "info": { "title": "Nifty API v1.0", "description": "Base URL: `https://openapi.niftypm.com`. Every path below already carries its own\n`/api/v1.0` prefix — send it verbatim.\n\n**v1.0 is the legacy surface.** It stops serving requests on 1 September\n2027. Start new work on the v3 API, which is camelCase and consistently\npaginated.\n\n**Authentication.** Every operation takes `Authorization: Bearer `.\nMint a personal access token, or run the OAuth 2.1 flow for an app that\nacts on other people's behalf — see [Authentication](/authentication) and\n[OAuth 2.1](/authorization).\n\n**Pagination.** List operations take `limit` (default `25`) and `offset`,\nand answer with `hasMore`. `hasMore` is true whenever the page came back\nfull, so a final page that happens to be exactly `limit` long also reports\ntrue — fetch the next page to confirm you are done.\n\n**Errors.** Failures answer with `{ \"message\": string, \"code\": number }`.\n`code` equals the HTTP status for framework errors. Exception: the OAuth\nendpoints under `/oauth` answer with RFC 6749's `{ \"error\": string }`.\n\n**Rate limits.** Exceeding a limit answers `429` with a `Retry-After`\nheader giving the seconds to wait. Retry after that delay rather than\nimmediately.\n\n**Field naming.** v1.0 is snake_case on the wire (`task_group_id`,\n`due_date`); v3 is camelCase. The two are not interchangeable.\n\nNew here? Start with the [quickstart](/getting-started).", "version": "1.0", "contact": {} }, "tags": [ { "name": "Tasks", "description": "The unit of work. Subtasks are tasks with a parent." }, { "name": "Documents", "description": "Rich-text docs; called \"docs\" on the wire — the path is /api/v1.0/docs." }, { "name": "Projects", "description": "Workspaces for tasks, docs, files and discussions." }, { "name": "Milestones & Lists", "description": "Date-bounded groupings of tasks; the app calls them Lists, the path is /api/v1.0/milestones." }, { "name": "Files", "description": "Uploaded attachments and their folders." }, { "name": "Portfolios", "description": "Groupings of projects; called \"subteams\" on the wire — the path is /api/v1.0/subteams." }, { "name": "Status", "description": "Kanban columns a task sits in; called \"taskgroups\" on the wire — the path is /api/v1.0/taskgroups." }, { "name": "Messages", "description": "Comments and chat messages on any resource." }, { "name": "Tags", "description": "Coloured labels applied to tasks, docs and files; called \"labels\" on the wire — the path is /api/v1.0/labels." }, { "name": "Webhook", "description": "Register endpoints that receive workspace events." }, { "name": "Apps", "description": "OAuth applications registered against the workspace." }, { "name": "Authentication", "description": "Token endpoints on this host." }, { "name": "Chats", "description": "Direct and group conversations." }, { "name": "Custom Fields", "description": "Workspace-defined fields attached to tasks and projects." }, { "name": "Members", "description": "People in the workspace. A member is a user within one team." }, { "name": "Time Tracking", "description": "Time records logged against tasks." }, { "name": "Invite", "description": "Shareable links that let people join the workspace." }, { "name": "Templates", "description": "Reusable project blueprints." }, { "name": "Users", "description": "The authenticated identity behind the current token." } ], "servers": [ { "url": "https://openapi.niftypm.com", "description": "" } ], "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "type": "http", "description": "Bearer token — a personal access token (`nft_user_…`) or an OAuth 2.1 access token (`nft_oauth_…`)." } }, "schemas": { "ErrorResponse": { "type": "object", "properties": { "message": { "type": "string", "example": "Unauthorized", "description": "Human-readable reason." }, "code": { "type": "number", "example": 401, "description": "Numeric code; equals the HTTP status for framework errors." } }, "required": [ "message", "code" ] }, "AppResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Application ID" }, "name": { "type": "string", "description": "Name" }, "logo": { "type": "string", "description": "Logo" }, "redirect_urls": { "type": "string", "description": "Redirect URLs" }, "description": { "type": "string", "description": "Description" }, "scopes": { "type": "string", "description": "Application scope", "enum": [ "file", "label", "doc", "milestone", "message", "subtask", "project", "task_group", "task", "subteam", "member", "folder", "time_tracking" ] }, "created_by": { "type": "string", "description": "Created by" }, "created_at": { "format": "date-time", "type": "string", "description": "Created date" }, "updated_at": { "format": "date-time", "type": "string", "description": "Last updated date" } }, "required": [ "id", "name", "logo", "redirect_urls", "description", "scopes", "created_by", "created_at", "updated_at" ] }, "GenerateRefreshToken": { "type": "object", "properties": { "code": { "type": "string", "nullable": false, "description": "Authorization code from the authorize redirect. Required for grant_type=authorization_code.", "example": "Pk6DnFY4q9Z1X7aOQATV5z4bxg1rjwH4" }, "client_id": { "type": "string", "description": "OAuth app client id. Send it here or as the username half of HTTP Basic auth.", "example": "SU9F98qri" }, "client_secret": { "type": "string", "description": "OAuth app client secret. Send it here or as the password half of HTTP Basic auth." }, "refresh_token": { "type": "string", "nullable": false, "description": "Refresh token from a previous call to this endpoint. Required for grant_type=refresh_token." }, "grant_type": { "type": "string", "nullable": false, "description": "grant_type", "enum": [ "authorization_code", "refresh_token" ] }, "redirect_uri": { "type": "string", "nullable": false, "description": "Must match the redirect_uri the code was obtained with. Required for grant_type=authorization_code.", "example": "https://app.example.com/oauth/callback" } }, "required": [ "grant_type" ] }, "TokenResponse": { "type": "object", "properties": { "access_token": { "type": "string", "description": "Access Token" }, "token_type": { "type": "string", "description": "Token Type" }, "refresh_token": { "type": "string", "description": "Refresh token" }, "expires_in": { "type": "number", "description": "Expires in seconds" }, "scope": { "type": "string", "enum": [ "file", "label", "doc", "milestone", "message", "subtask", "project", "task_group", "task", "subteam", "member", "folder", "time_tracking" ], "description": "Scope" } }, "required": [ "access_token", "token_type", "refresh_token", "expires_in", "scope" ] }, "ChatMemberResponse": { "type": "object", "properties": { "id": { "type": "string" }, "is_owner": { "type": "boolean" }, "is_muted": { "type": "boolean" }, "joined": { "type": "boolean" } }, "required": [ "id", "is_owner", "is_muted", "joined" ] }, "ChatResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "team": { "type": "string" }, "project": { "type": "string" }, "is_self": { "type": "boolean" }, "members": { "$ref": "#/components/schemas/ChatMemberResponse" }, "created_at": { "format": "date-time", "type": "string" }, "last_message_at": { "format": "date-time", "type": "string" }, "zoom_id": { "type": "string" }, "zoom_password": { "type": "string" }, "zoom_join_url": { "type": "string" }, "webex_id": { "type": "string" }, "webex_password": { "type": "string" }, "webex_join_url": { "type": "string" }, "pinned_message": { "type": "string" }, "pinned_by": { "type": "string" }, "meeting_type": { "type": "string" } }, "required": [ "id", "name", "type", "description", "team", "project", "is_self", "members", "created_at", "last_message_at", "zoom_id", "zoom_password", "zoom_join_url", "webex_id", "webex_password", "webex_join_url", "pinned_message", "pinned_by", "meeting_type" ] }, "CreateDocument": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "parent_doc_id": { "type": "string", "description": "Parent Document ID" }, "project_id": { "type": "string", "description": "Project ID" }, "googleAccessToken": { "type": "string", "description": "Google Access Token" }, "type": { "type": "string", "description": "Type of Document" }, "subtype": { "type": "string", "description": "Subtype of the document" }, "private": { "type": "boolean", "description": "Private Flag" }, "access_type": { "type": "number", "enum": [ 0, 1, 2 ] }, "content": { "type": "object", "description": "Document Content. Native documents are always editor-v2, so this must be a plain string, or an array of editor-v2 nodes (each node either { text } or { type, children: [...] }); any other shape is rejected with a 400. Not supported on personal documents — a personal document is created empty and its body added in the app." }, "editor_version": { "type": "number", "enum": [ 2 ], "description": "Editor version. Native Nifty documents are always created as 2 (the modern collaborative editor) — omit this field, or pass 2. The legacy editor (1) can no longer be used to create documents and passing it returns a 400; documents that already use it are unaffected and stay editable in the Nifty app. Note: the body of an editor-v2 document is collaborative — after creation it is edited in the app (or via agent tooling), not by updating `content` through this API." }, "external_id": { "type": "string", "description": "External ID" }, "folder_id": { "type": "string", "description": "Folder ID" }, "folder_stack": { "description": "Folder stack", "type": "array", "items": { "type": "string" } }, "order": { "type": "number", "description": "Document Order" } } }, "CreateDocumentResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Operation message" }, "doc_id": { "type": "string", "description": "Document ID" }, "folder": { "type": "string", "description": "folde" } }, "required": [ "message", "doc_id", "folder" ] }, "DocumentMemberResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "permission": { "type": "string", "description": "" }, "is_author": { "type": "boolean", "description": "" }, "active": { "type": "boolean", "description": "" }, "last_seen": { "format": "date-time", "type": "string", "description": "" }, "last_edited": { "format": "date-time", "type": "string", "description": "" } }, "required": [ "id", "permission", "is_author", "active", "last_seen", "last_edited" ] }, "DocumentResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "name": { "type": "string", "description": "" }, "access_type": { "type": "string", "description": "" }, "type": { "type": "string", "description": "" }, "subtype": { "type": "string", "description": "" }, "external_id": { "type": "string", "description": "" }, "content": { "type": "object", "description": "" }, "author": { "type": "string", "description": "" }, "project_id": { "type": "string", "description": "" }, "tasks": { "description": "", "type": "array", "items": { "type": "string" } }, "archived": { "type": "boolean", "description": "" }, "members": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/DocumentMemberResponse" } }, "discussion_keys": { "description": "", "type": "array", "items": { "type": "string" } }, "public_token": { "type": "string", "description": "" }, "share_token": { "type": "string", "description": "" }, "created_at": { "format": "date-time", "type": "string", "description": "" }, "comments": { "type": "number", "description": "" }, "hasAccess": { "type": "boolean", "description": "" }, "labels": { "description": "", "type": "array", "items": { "type": "string" } }, "folder": { "type": "string", "description": "" }, "order": { "type": "number", "description": "" }, "multipage": { "type": "boolean", "description": "" }, "parent_doc_id": { "type": "string", "description": "" } }, "required": [ "id", "name", "access_type", "type", "subtype", "external_id", "content", "author", "project_id", "tasks", "archived", "members", "discussion_keys", "public_token", "share_token", "created_at", "comments", "hasAccess", "labels", "folder", "order", "multipage", "parent_doc_id" ] }, "GetDocumentsResponse": { "type": "object", "properties": { "items": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/DocumentResponse" } }, "hasMore": { "type": "boolean", "description": "True if there are more record else false", "default": false } }, "required": [ "items", "hasMore" ] }, "CreatePersonalDocumentResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Message" }, "doc_id": { "type": "string", "description": "Document ID" } }, "required": [ "message", "doc_id" ] }, "EditDocument": { "type": "object", "properties": { "name": { "type": "string", "description": "Document name" }, "archived": { "type": "boolean", "description": "Archived" }, "access_type": { "type": "number", "enum": [ 0, 1, 2 ] }, "force": { "type": "boolean", "description": "Force Flag" }, "content": { "type": "object" }, "folder_id": { "type": "string", "description": "Folder ID" }, "folder_stack": { "description": "Folder path stack", "type": "array", "items": { "type": "string" } }, "multipage": { "type": "boolean", "description": "Is Multiple page?" }, "order": { "type": "number", "description": "Document Order" } } }, "MoveDocument": { "type": "object", "properties": { "folder_id": { "type": "string", "description": "Folder ID" }, "folder_stack": { "type": "string", "description": "Folder stack of document path" }, "project_id": { "type": "string", "description": "Project ID associated with the document" } }, "required": [ "folder_id", "folder_stack", "project_id" ] }, "RemoveDocumentResponse": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "DocumentInvitee": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "permission": { "type": "number", "description": "Permission", "enum": [ 0, 1, 2 ] } }, "required": [ "id", "permission" ] }, "DocumentInvite": { "type": "object", "properties": { "members": { "description": "Document Invitee details", "type": "array", "items": { "$ref": "#/components/schemas/DocumentInvitee" } }, "folder_stack": { "description": "Folder stack", "type": "array", "items": { "type": "string" } } }, "required": [ "members" ] }, "AddMembersToDocumentResponse": { "type": "object", "properties": { "message": { "type": "string" }, "added_members": { "type": "array", "items": { "type": "string" } }, "updated_members": { "type": "array", "items": { "type": "string" } } }, "required": [ "message", "added_members", "updated_members" ] }, "DocumentMemberRemove": { "type": "object", "properties": { "members": { "description": "Document members", "type": "array", "items": { "type": "string" } } }, "required": [ "members" ] }, "RemoveMembersFromDocumentResponse": { "type": "object", "properties": { "message": { "type": "string" }, "members_id": { "type": "array", "items": { "type": "string" } } }, "required": [ "message", "members_id" ] }, "ChangeDocument": { "type": "object", "properties": { "changes": { "description": "Document content operations to apply, in order", "type": "array", "items": { "type": "object" } }, "changes_id": { "type": "string", "description": "Client-generated id used to correlate the change echo over the socket" } }, "required": [ "changes" ] }, "ProcessDocumentChangeResponse": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ] }, "UpdateLabels": { "type": "object", "properties": { "labels": { "description": "Labels", "type": "array", "items": { "type": "string" } } }, "required": [ "labels" ] }, "AddLabelsReponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Message" }, "labels": { "description": "List of labels", "type": "array", "items": { "type": "string" } } }, "required": [ "message", "labels" ] }, "RemoveLabelsResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Message" }, "labels": { "description": "List of labels", "type": "array", "items": { "type": "string" } } }, "required": [ "message", "labels" ] }, "CustomFieldOptionResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "value": { "type": "string", "description": "Value" }, "color": { "type": "string", "description": "Color" } }, "required": [ "id", "value", "color" ] }, "CustomFieldResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "type": { "type": "string", "description": "Type" }, "currency": { "type": "string", "description": "Currency" }, "tracking_type": { "type": "string", "description": "Tracking Type" }, "cost_per_hour": { "type": "number", "description": "Cost Per Hour" }, "associations": { "description": "List of associations", "type": "array", "items": { "type": "string" } }, "hidden": { "description": "List of hidden", "type": "array", "items": { "type": "string" } }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOptionResponse" } }, "projects": { "description": "List of Projects", "type": "array", "items": { "type": "string" } }, "in_library": { "type": "boolean", "description": "" } }, "required": [ "id", "name", "description", "type", "currency", "tracking_type", "cost_per_hour", "associations", "hidden", "options", "projects", "in_library" ] }, "FileFullResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "name": { "type": "string", "description": "" }, "size": { "type": "number", "description": "" }, "url": { "type": "string", "description": "" }, "download": { "type": "string", "description": "" }, "thumbnail": { "type": "string", "description": "" }, "uploader": { "type": "string", "description": "" }, "comments": { "type": "number", "description": "Number of comments" }, "created_at": { "format": "date-time", "type": "string", "description": "" }, "googleId": { "type": "string", "description": "" }, "googleType": { "type": "string", "description": "" }, "processed": { "type": "boolean", "description": "" }, "task": { "type": "string", "description": "Task" }, "project_id": { "type": "string", "description": "Project ID" }, "message": { "type": "string", "description": "Message" }, "labels": { "description": "List of labels", "type": "array", "items": { "type": "string" } }, "folder": { "type": "string", "description": "folder" }, "folder_stack": { "description": "Folder path stack", "type": "array", "items": { "type": "string" } }, "document": { "type": "string", "description": "Document" }, "annotations_task_id": { "type": "string", "description": "Annotation Task ID" } }, "required": [ "id", "name", "size", "url", "download", "thumbnail", "uploader", "comments", "created_at", "googleId", "googleType", "processed", "task", "project_id", "message", "labels", "folder", "folder_stack", "document", "annotations_task_id" ] }, "GetFilesResponseDto": { "type": "object", "properties": { "hasMore": { "type": "boolean", "description": "True if there are more record else false", "default": false }, "files": { "description": "List of Label records", "type": "array", "items": { "$ref": "#/components/schemas/FileFullResponse" } } }, "required": [ "files" ] }, "FilesUploadDto": { "type": "object", "properties": { "files": { "type": "array", "description": "It contains list of files path from local desktop to upload.", "items": { "type": "string", "format": "binary", "example": "" } } } }, "UploadFilesResponseDto": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" }, "files": { "description": "List of Label records", "type": "array", "items": { "$ref": "#/components/schemas/FileFullResponse" } } }, "required": [ "files" ] }, "GeneralFileResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" }, "id": { "type": "string", "description": "Created Label ID" } }, "required": [ "message", "id" ] }, "CopyFile": { "type": "object", "properties": { "task_id": { "type": "string", "description": "Task ID associated with the file" }, "message_id": { "type": "string", "description": "Message ID associated with the file" }, "project_id": { "type": "string", "description": "Project ID associated with the file" } }, "required": [ "task_id", "message_id", "project_id" ] }, "UpdateFile": { "type": "object", "properties": { "folder_id": { "type": "string", "description": "Folder ID" }, "folder_stack": { "description": "Folder stack", "type": "array", "items": { "type": "string" } }, "annotations_task_id": { "type": "string", "description": "Annotations Task ID" } } }, "UpdateFileResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Message" }, "file_id": { "type": "string", "description": "File ID" } }, "required": [ "message", "file_id" ] }, "InviteeUser": { "type": "object", "properties": { "id": { "type": "string", "description": "User ID" }, "name": { "type": "string", "description": "Name" }, "email": { "type": "string", "description": "Email address" }, "signedUp": { "type": "string", "description": "Signedup Flag" }, "signupDate": { "format": "date-time", "type": "string", "description": "Signedup date" } }, "required": [ "id", "name", "email", "signedUp", "signupDate" ] }, "InviteeRole": { "type": "object", "properties": { "id": { "type": "string", "description": "Role ID" }, "name": { "type": "string", "description": "Role Name" } }, "required": [ "id", "name" ] }, "InviteTeamMember": { "type": "object", "properties": { "id": { "type": "string", "description": "Team Member Id" }, "user": { "description": "User details", "allOf": [ { "$ref": "#/components/schemas/InviteeUser" } ] }, "role": { "description": "Role details", "allOf": [ { "$ref": "#/components/schemas/InviteeRole" } ] } }, "required": [ "id", "user", "role" ] }, "InviteTeamReponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Team ID" }, "name": { "type": "string", "description": "Team name" }, "url": { "type": "string", "description": "Team URL" }, "members": { "description": "Team member", "type": "array", "items": { "$ref": "#/components/schemas/InviteTeamMember" } } }, "required": [ "id", "name", "url", "members" ] }, "LabelResponse": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "type": { "type": "string" }, "created_by": { "type": "string" }, "team": { "type": "string" }, "default": { "type": "string" } }, "required": [ "id", "name", "color", "type", "created_by", "team", "default" ] }, "GetLabelsDto": { "type": "object", "properties": { "hasMore": { "type": "boolean", "description": "True if there are more record else false", "default": false }, "items": { "description": "List of Label records", "type": "array", "items": { "$ref": "#/components/schemas/LabelResponse" } } }, "required": [ "items" ] }, "LabelBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "color": { "type": "string", "description": "Color" }, "type": { "type": "number", "description": "Type", "enum": [ 0, 1 ] } }, "required": [ "name", "color" ] }, "GeneralLabelResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" }, "id": { "type": "string", "description": "Label Record Unique ID" } }, "required": [ "message", "id" ] }, "UpdateLabelBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "color": { "type": "string", "description": "Color" } }, "required": [ "name", "color" ] }, "MemberViewResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Id" }, "email": { "type": "string", "description": "Email address" }, "name": { "type": "string", "description": "Name" }, "initials": { "type": "string", "description": "Initials" }, "avatar": { "type": "string", "description": "Avtar" }, "pending": { "type": "boolean", "description": "Pending status" }, "removed": { "type": "boolean", "description": "Removed" }, "theme": { "type": "string", "description": "Theme" }, "team": { "type": "string", "description": "Team Id" }, "role": { "type": "string", "description": "Role" }, "total_story_points": { "type": "number", "description": "Total story point" }, "completed_story_points": { "type": "number", "description": "Completed story point" }, "tz": { "type": "number", "description": "Timezone" }, "tz_iana": { "type": "string", "description": "Timezone Code" }, "tz_offset": { "type": "string", "description": "Timezone Offset" }, "color": { "type": "string", "description": "Color" }, "secondary_color": { "type": "string", "description": "Secondary Color" }, "online": { "type": "boolean", "description": "Online status" }, "signedUp": { "type": "boolean", "description": "Signedup" }, "tours": { "description": "Tours", "type": "array", "items": { "type": "array" } }, "skipped_help": { "description": "Skipped Help", "type": "array", "items": { "type": "array" } }, "notificationSettings": { "description": "Notification Settings", "type": "array", "items": { "type": "array" } }, "user_id": { "type": "string", "description": "User ID" }, "labels": { "description": "Labels", "type": "array", "items": { "type": "array" } }, "sidebar_tabs": { "type": "boolean", "description": "Sidebar tabs" } }, "required": [ "id", "email", "name", "initials", "avatar", "pending", "removed", "theme", "team", "role", "total_story_points", "completed_story_points", "tz", "tz_iana", "tz_offset", "color", "secondary_color", "online", "signedUp", "tours", "skipped_help", "notificationSettings", "user_id", "labels", "sidebar_tabs" ] }, "GetMembersReponse": { "type": "object", "properties": { "items": { "description": "List of members", "type": "array", "items": { "$ref": "#/components/schemas/MemberViewResponse" } }, "hasMore": { "type": "boolean", "description": "True if there are more records else false" } }, "required": [ "items", "hasMore" ] }, "TaskReference": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of an existing task.", "example": "Kx8vQ2mT1" } }, "required": [ "id" ] }, "CreateMessageDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Message Type" }, "text": { "type": "string", "description": "Message Text" }, "url": { "type": "string", "description": "URL" }, "doc_attachment": { "type": "string", "description": "Document Attachment" }, "entity_key": { "type": "string", "description": "Entity Key" }, "chat_id": { "type": "string", "description": "Chat ID" }, "message_id": { "type": "string", "description": "Message ID" }, "task_id": { "type": "string", "description": "Task ID" }, "file_id": { "type": "string", "description": "File ID" }, "doc_id": { "type": "string", "description": "Document ID" }, "task": { "description": "Task the message is attached to, referenced by id. Alternative to task_id.", "allOf": [ { "$ref": "#/components/schemas/TaskReference" } ] }, "external_files": { "description": "List of External files", "type": "array", "items": { "type": "string" } }, "nifty_files": { "description": "List of Nifty Files", "type": "array", "items": { "type": "string" } }, "date": { "format": "date-time", "type": "string", "description": "Date" }, "bot_name": { "type": "string", "description": "BOT Name" }, "bot_avatar": { "type": "string", "description": "BOT Avtar" }, "hidden": { "description": "Hidden", "type": "array", "items": { "type": "string" } }, "emails": { "type": "string", "description": "Emails" }, "annotation_id": { "type": "string", "description": "Annotation ID" }, "context_text": { "type": "string", "description": "Context Text" }, "audio_duration": { "type": "string", "description": "Audion Duration" } }, "required": [ "type", "text", "url", "doc_attachment", "entity_key", "chat_id", "message_id", "task_id", "file_id", "doc_id" ] }, "CreateMessageResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "" }, "data": { "type": "object", "description": "" } }, "required": [ "message", "data" ] }, "FileChildResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "name": { "type": "string", "description": "" }, "size": { "type": "number", "description": "" }, "url": { "type": "string", "description": "" }, "download": { "type": "string", "description": "" }, "thumbnail": { "type": "string", "description": "" }, "uploader": { "type": "string", "description": "" }, "comments": { "type": "number", "description": "" }, "created_at": { "format": "date-time", "type": "string", "description": "" }, "googleId": { "type": "string", "description": "" }, "googleType": { "type": "string", "description": "" }, "processed": { "type": "boolean", "description": "" } }, "required": [ "id", "name", "size", "url", "download", "thumbnail", "uploader", "comments", "created_at", "googleId", "googleType", "processed" ] }, "MessageResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Message Id" }, "type": { "type": "string", "description": "Message Type" }, "hide_link_preview": { "type": "boolean", "description": "Hide Link Preview" }, "subtype": { "type": "string", "description": "Sub Type" }, "text": { "type": "string", "description": "Message text" }, "url": { "type": "string", "description": "URL" }, "chat": { "type": "string", "description": "Chat Id" }, "thread": { "type": "string", "description": "Thread " }, "task": { "type": "string", "description": "Task Id" }, "file": { "type": "string", "description": "File" }, "document": { "type": "string", "description": "Document Id" }, "entity_key": { "type": "string", "description": "Entity Key" }, "author": { "type": "string", "description": "Author Id" }, "replies": { "type": "number", "description": "No of Replies" }, "repliers": { "description": "List of Replier Id", "type": "array", "items": { "type": "string" } }, "tagged": { "description": "List of tagged", "type": "array", "items": { "type": "string" } }, "seen_by": { "description": "List of Seen by Id", "type": "array", "items": { "type": "string" } }, "hidden": { "description": "Hidden", "type": "array", "items": { "type": "string" } }, "doc_attachment": { "type": "string", "description": "Document Attachment" }, "attachments": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/FileChildResponse" } }, "is_edited": { "type": "boolean", "description": "Is Edited" }, "is_deleted": { "type": "boolean", "description": "Is Deleted" }, "created_at": { "format": "date-time", "type": "string", "description": "Created At" }, "updated_at": { "format": "date-time", "type": "string", "description": "Updated At" }, "annotation_id": { "type": "string", "description": "Annottion Id" }, "heardBy": { "description": "Heard By", "type": "array", "items": { "type": "string" } }, "audio_duration": { "type": "number", "description": "Audio duration" }, "heard": { "type": "boolean", "description": "Is Heard" } }, "required": [ "id", "type", "hide_link_preview", "subtype", "text", "url", "chat", "thread", "task", "file", "document", "entity_key", "author", "replies", "repliers", "tagged", "seen_by", "hidden", "doc_attachment", "attachments", "is_edited", "is_deleted", "created_at", "updated_at", "annotation_id", "heardBy", "audio_duration", "heard" ] }, "GetMessagesResponse": { "type": "object", "properties": { "messages": { "description": "List of messages", "type": "array", "items": { "$ref": "#/components/schemas/MessageResponse" } }, "has_more": { "type": "boolean", "description": "Has more row flag" } }, "required": [ "messages", "has_more" ] }, "EditMessageDto": { "type": "object", "properties": { "text": { "type": "string", "description": "Message Text" }, "external_files": { "description": "List of External Files", "type": "array", "items": { "type": "object" } }, "hide_link_preview": { "type": "boolean", "description": "Hide link preview" }, "nifty_files": { "description": "List of Nifty Files", "type": "array", "items": { "type": "string" } } } }, "DeleteMessageResponse": { "type": "object", "properties": { "message_id": { "type": "string", "description": "Message ID" }, "message": { "type": "string", "description": "Message" } }, "required": [ "message_id", "message" ] }, "SeeMessageResponse": { "type": "object", "properties": { "message_ids": { "description": "List of all message id", "type": "array", "items": { "type": "string" } }, "message": { "type": "string", "description": "Message" } }, "required": [ "message_ids", "message" ] }, "HearMessageResponse": { "type": "object", "properties": { "message_id": { "type": "string", "description": "Message ID" }, "message": { "type": "string", "description": "Message" } }, "required": [ "message_id", "message" ] }, "AttachedCustomFieldResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Id" }, "value": { "type": "string", "description": "Value" } }, "required": [ "id", "value" ] }, "TasksStatistic": { "type": "object", "properties": { "total": { "type": "number", "description": "Total" }, "completed": { "type": "number", "description": "Completed" }, "overdue": { "type": "number", "description": "Overdue" }, "total_story_points": { "type": "number", "description": "Total Story Point" }, "completed_story_points": { "type": "number", "description": "Completed Story Point" } }, "required": [ "total", "completed", "overdue", "total_story_points", "completed_story_points" ] }, "MilestoneShortView": { "type": "object", "properties": { "id": { "type": "string", "description": "Milestone ID" }, "name": { "type": "string", "description": "Milestone Name" }, "created_at": { "format": "date-time", "type": "string", "description": "Creation Date" }, "created_by": { "type": "string", "description": "Operation message" }, "description": { "type": "string", "description": "Description" }, "dependency": { "type": "string", "description": "Dependencies" }, "start": { "format": "date-time", "type": "string", "description": "Start Date" }, "end": { "format": "date-time", "type": "string", "description": "End Date" }, "archived": { "type": "string", "description": "achived" }, "project": { "type": "string", "description": "Project" }, "task_group": { "type": "string", "description": "Task Group" }, "rule": { "type": "string", "description": "Rules" }, "tasks": { "description": "List of Tasks", "type": "array", "items": { "type": "string" } }, "hidden": { "description": "hidden", "type": "array", "items": { "type": "string" } }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/AttachedCustomFieldResponse" } }, "statistic": { "$ref": "#/components/schemas/TasksStatistic" }, "order": { "type": "number", "description": "Order" }, "color": { "type": "string", "description": "Color" }, "is_list": { "type": "boolean", "description": "List Flag" }, "assignees": { "description": "Assignee to List", "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "created_at", "created_by", "description", "dependency", "start", "end", "archived", "project", "task_group", "rule", "tasks", "hidden", "fields", "statistic", "order", "color", "is_list", "assignees" ] }, "GetMilestonesReponse": { "type": "object", "properties": { "hasMore": { "type": "boolean", "description": "True if there are more record else false", "default": false }, "items": { "description": "List of Label records", "type": "array", "items": { "$ref": "#/components/schemas/MilestoneShortView" } } }, "required": [ "hasMore", "items" ] }, "CreateMilestone": { "type": "object", "properties": { "project_id": { "type": "string", "description": "Project ID" }, "task_group_id": { "type": "string", "description": "Task Group ID" }, "name": { "type": "string", "description": "Milestone name" }, "description": { "type": "string", "description": "Milestone Description" }, "dependency": { "type": "string", "description": "Milestone dependency" }, "start": { "type": "string", "description": "Milestone start date" }, "end": { "type": "string", "description": "Milestone end date" }, "rule_id": { "type": "string", "description": "Milestone rule id" }, "hidden": { "description": "Hidden", "type": "array", "items": { "type": "string" } }, "isTaskGroup": { "type": "boolean", "description": "Is Task Group?" }, "is_list": { "type": "boolean", "description": "List Flag" } }, "required": [ "project_id", "name", "description" ] }, "MilestoneReponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" }, "id": { "type": "string", "description": "Created Label ID" } }, "required": [ "message", "id" ] }, "UpdateMilestoneDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Milestone name" }, "description": { "type": "string", "description": "Milestone description" }, "dependency": { "type": "string", "description": "Milestone dependencies" }, "start": { "type": "string", "description": "Milestone start date" }, "end": { "type": "string", "description": "Milestone end date" }, "rollup": { "type": "string", "description": "Milestone rollup" }, "is_list": { "type": "boolean", "description": "List Flag" } } }, "UpdateMilestoneResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" } }, "required": [ "message" ] }, "MoveToProjectMilestoneDto": { "type": "object", "properties": { "project_id": { "type": "string", "description": "Project ID" } }, "required": [ "project_id" ] }, "UpdateTasks": { "type": "object", "properties": { "tasks": { "description": "List of Tasks ID", "type": "array", "items": { "type": "string" } } }, "required": [ "tasks" ] }, "MilestoneTasksResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" }, "tasks": { "description": "List of tasks", "type": "array", "items": { "type": "string" } } }, "required": [ "message", "tasks" ] }, "UpdateStatus": { "type": "object", "properties": { "archived": { "type": "boolean", "description": "Archived" }, "tasks": { "type": "boolean", "description": "Task Flag" } }, "required": [ "archived" ] }, "ProjectResponse": { "type": "object", "properties": { "id": { "type": "string" }, "nice_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "initials": { "type": "string" }, "logo": { "type": "string" }, "color": { "type": "string" }, "secondary_color": { "type": "string" }, "demo": { "type": "boolean" }, "archived": { "type": "boolean" }, "auto_milestones": { "type": "boolean" }, "default_tasks_view": { "type": "string" }, "access_type": { "type": "string" }, "owner": { "type": "string" }, "members": { "type": "array", "items": { "type": "string" } }, "general_discussion": { "type": "string" }, "subteam": { "type": "string" }, "progress": { "type": "number" }, "joined": { "type": "boolean" }, "general_discussion_muted": { "type": "boolean" }, "email": { "type": "string" }, "zoom_id": { "type": "string" }, "zoom_password": { "type": "string" }, "zoom_join_url": { "type": "string" }, "webex_id": { "type": "string" }, "webex_password": { "type": "string" }, "webex_join_url": { "type": "string" }, "enabled_modules": { "type": "array", "items": { "type": "string" } }, "disabled_modules": { "type": "array", "items": { "type": "string" } }, "disabled_widgets": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8 ] }, "hidden_taskboard_fields": { "type": "number", "enum": [ 0, 1, 2, 3, 4 ] }, "repo": { "type": "string" }, "total_story_points": { "type": "number" }, "completed_story_points": { "type": "number" }, "pinned_message": { "type": "string" }, "pinned_by": { "type": "string" }, "completion_groups": { "type": "array", "items": { "type": "string" } }, "doc_root_folder": { "type": "object" }, "file_root_folder": { "type": "object" }, "removed": { "type": "boolean" }, "rollups": { "type": "array", "items": { "type": "string" } }, "list_columns_order": { "type": "array", "items": { "type": "string" } }, "hidden_list_columns": { "type": "array", "items": { "type": "string" } }, "integrations": { "description": "Integration details", "type": "array", "items": { "type": "string" } } }, "required": [ "id", "nice_id", "name", "description", "initials", "logo", "color", "secondary_color", "demo", "archived", "auto_milestones", "default_tasks_view", "access_type", "owner", "members", "general_discussion", "subteam", "progress", "joined", "general_discussion_muted", "email", "zoom_id", "zoom_password", "zoom_join_url", "webex_id", "webex_password", "webex_join_url", "enabled_modules", "disabled_modules", "disabled_widgets", "hidden_taskboard_fields", "repo", "total_story_points", "completed_story_points", "pinned_message", "pinned_by", "completion_groups", "doc_root_folder", "file_root_folder", "removed", "rollups", "list_columns_order", "hidden_list_columns", "integrations" ] }, "ProjectListResponse": { "type": "object", "properties": { "projects": { "description": "List of Projects", "type": "array", "items": { "$ref": "#/components/schemas/ProjectResponse" } }, "hasMore": { "type": "boolean", "description": "True if there are more record else false", "default": false } }, "required": [ "projects", "hasMore" ] }, "CreateProjectDto": { "type": "object", "properties": { "subteam_id": { "type": "string", "description": "Subteam ID" }, "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "demo": { "type": "boolean", "description": "Demo" }, "template_id": { "type": "string", "description": "Template ID" }, "nice_id": { "type": "string", "description": "Nice ID" }, "access_type": { "type": "string", "description": "Access Type" }, "project_type": { "type": "string", "description": "Project Type" }, "default_tasks_view": { "type": "string", "description": "Default Task View" }, "disabled": { "description": "Disabled", "type": "array", "items": { "type": "string" } } }, "required": [ "name" ] }, "UpdateProjectDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "archived": { "type": "string", "description": "Archived" }, "auto_milestones": { "type": "string", "description": "Auto milestone" }, "subteam_id": { "type": "string", "description": "Subteam ID" }, "access_type": { "type": "string", "description": "Access Type" }, "default_tasks_view": { "type": "string", "description": "Default Task View" }, "disabled_widgets": { "type": "string", "description": "Disable Widgets" }, "hidden_taskboard_fields": { "type": "string", "description": "Hidden Taskboard Fields" }, "milestones_rollup": { "type": "string", "description": "Milestone Rollup" }, "color": { "type": "string", "description": "Color" }, "secondary_color": { "type": "string", "description": "Secondary Color" }, "nice_id": { "type": "string", "description": "Nice ID" }, "hidden_list_columns": { "type": "string", "description": "Hidden List Columns" }, "list_columns_order": { "type": "string", "description": "Columns Order List" }, "query_all_files": { "type": "string", "description": "Query All Fields" } } }, "GeneralProjectReponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" }, "id": { "type": "string", "description": "Created ID" } }, "required": [ "message", "id" ] }, "DeleteProjectReponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" } }, "required": [ "message" ] }, "InviteProjectMember": { "type": "object", "properties": { "email": { "type": "string", "description": "Email" }, "name": { "type": "string", "description": "Name" }, "role": { "type": "string", "description": "Role type any of the `owner`, `manager`, `regular`, `client`" } }, "required": [ "email", "role" ] }, "InviteProjectDto": { "type": "object", "properties": { "invitees": { "description": "Invitees", "type": "array", "items": { "$ref": "#/components/schemas/InviteProjectMember" } } }, "required": [ "invitees" ] }, "ProjectInviteResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Operation message" }, "invited": { "description": "Invited", "type": "array", "items": { "type": "object" } } }, "required": [ "message", "invited" ] }, "LeaveProjectReponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" }, "member_id": { "type": "string", "description": "Member ID" } }, "required": [ "message", "member_id" ] }, "CustomFieldOptions": { "type": "object", "properties": { "value": { "type": "string", "description": "Custom field option value" }, "color": { "type": "string", "description": "Custom field option color" } }, "required": [ "value", "color" ] }, "CreateCustomField": { "type": "object", "properties": { "field_id": { "type": "string", "description": "field_id" }, "name": { "type": "string", "description": "Custom field name" }, "description": { "type": "string", "description": "description" }, "type": { "type": "number", "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 ], "description": "Custom field type" }, "currency": { "type": "string", "description": "Currency" }, "tracking_type": { "type": "number", "description": "Tracking Type", "enum": [ 0, 1 ] }, "cost_per_hour": { "type": "number", "description": "Cost per hour" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldOptions" } }, "roles": { "description": "Roles", "type": "array", "items": { "type": "string" } }, "save": { "type": "boolean", "description": "Save" }, "association": { "type": "string", "description": "Association" }, "project_id": { "type": "string", "description": "Project ID" } }, "required": [ "name", "type", "options", "roles" ] }, "CreateSubteam": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" } }, "required": [ "name" ] }, "SubteamGeneralResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "" }, "id": { "type": "string", "description": "" } }, "required": [ "message", "id" ] }, "SubteamResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "name": { "type": "string", "description": "" }, "initials": { "type": "string", "description": "" }, "logo": { "type": "string", "description": "" }, "color": { "type": "string", "description": "" }, "secondary_color": { "type": "string", "description": "" }, "is_general": { "type": "boolean", "description": "" }, "owner": { "type": "string", "description": "" }, "members": { "description": "", "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "initials", "logo", "color", "secondary_color", "is_general", "owner", "members" ] }, "GetSubTeamsResponse": { "type": "object", "properties": { "subteams": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/SubteamResponse" } }, "items": { "type": "boolean", "description": "True if there are more record else false", "default": false }, "hasMore": { "type": "boolean", "description": "True if there are more record else false", "default": false } }, "required": [ "subteams", "items", "hasMore" ] }, "UpdateSubteam": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "order": { "type": "string", "description": "Sort position, sent as a numeric string", "example": "300" } } }, "SubteamMembersModify": { "type": "object", "properties": { "members_ids": { "description": "List of Members ID", "type": "array", "items": { "type": "string" } } }, "required": [ "members_ids" ] }, "RelatedPR": { "type": "object", "properties": { "number": { "type": "string", "description": "" }, "title": { "type": "string", "description": "" }, "url": { "type": "string", "description": "" }, "status": { "type": "string", "description": "" } }, "required": [ "number", "title", "url", "status" ] }, "TaskResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "nice_id": { "type": "string", "description": "Nice ID" }, "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "order": { "type": "number", "description": "Order" }, "created_at": { "format": "date-time", "type": "string", "description": "Created Date" }, "created_by": { "type": "string", "description": "Created By" }, "archived": { "type": "boolean", "description": "Archived Flag" }, "completed": { "type": "boolean", "description": "Completed Flag" }, "completed_on": { "format": "date-time", "type": "string", "description": "Completed Date" }, "completed_by": { "type": "string", "description": "Completed By" }, "due_date": { "format": "date-time", "type": "string", "description": "Due Date" }, "reminder": { "format": "date-time", "type": "string", "description": "Reminder Date" }, "task_group": { "type": "string", "description": "Task Group" }, "task": { "type": "string", "description": "Task" }, "project": { "type": "string", "description": "Project ID" }, "milestone": { "type": "string", "description": "Milestone" }, "assignees": { "description": "Assignees", "type": "array", "items": { "type": "string" } }, "linked_tasks": { "description": "Linked Tasks", "type": "array", "items": { "type": "string" } }, "subscribers": { "description": "Subscribers", "type": "array", "items": { "type": "string" } }, "labels": { "description": "Labels", "type": "array", "items": { "type": "string" } }, "fields": { "description": "Attached custom fields", "type": "array", "items": { "$ref": "#/components/schemas/AttachedCustomFieldResponse" } }, "total_subtasks": { "type": "number", "description": "Total Number of subtasks" }, "completed_subtasks": { "type": "number", "description": "Number of completed tasks" }, "comments": { "type": "number", "description": "Numbers of comments" }, "attachments": { "description": "Files", "type": "array", "items": { "$ref": "#/components/schemas/FileChildResponse" } }, "documents": { "description": "List of Documents", "type": "array", "items": { "type": "string" } }, "banner": { "type": "string", "description": "Banner" }, "hidden": { "description": "hidden", "type": "array", "items": { "type": "string" } }, "dependency": { "type": "string", "description": "Dependencies" }, "repeat_cron": { "type": "string", "description": "Repeat Cron" }, "repeat_trigger": { "type": "string", "description": "Repeat Trigger" }, "embed_url": { "type": "string", "description": "Embedded URL" }, "repeat_till": { "format": "date-time", "type": "string", "description": "Repeat Until" }, "rule": { "type": "string", "description": "Rule ID" }, "story_points": { "type": "number", "description": "Story Points" }, "related_commits": { "type": "array", "items": { "type": "string" } }, "related_prs": { "$ref": "#/components/schemas/RelatedPR" }, "archived_on": { "format": "date-time", "type": "string", "description": "Archived Date" }, "tracked_time": { "type": "number", "description": "Tracked Time" }, "start_date": { "format": "date-time", "type": "string", "description": "Start Date" }, "project_archived": { "type": "boolean", "description": "Project Archived" }, "meeting_ids": { "description": "Meeting IDs", "type": "array", "items": { "type": "string" } } }, "required": [ "id", "nice_id", "name", "description", "order", "created_at", "created_by", "archived", "completed", "completed_on", "completed_by", "due_date", "reminder", "task_group", "task", "project", "milestone", "assignees", "linked_tasks", "subscribers", "labels", "fields", "total_subtasks", "completed_subtasks", "comments", "attachments", "documents", "banner", "hidden", "dependency", "repeat_cron", "repeat_trigger", "embed_url", "repeat_till", "rule", "story_points", "related_commits", "related_prs", "archived_on", "tracked_time", "start_date", "project_archived", "meeting_ids" ] }, "GetTasksResponse": { "type": "object", "properties": { "tasks": { "description": "List of all tasks", "type": "array", "items": { "$ref": "#/components/schemas/TaskResponse" } }, "hasMore": { "type": "boolean", "description": "True when the page was full (`tasks.length === limit`); a full final page also reports true — request the next page to confirm.", "default": false } }, "required": [ "tasks", "hasMore" ] }, "CreateTaskFieldBody": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "value": { "type": "string", "description": "Value" } }, "required": [ "id", "value" ] }, "CreateTaskBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "description": { "type": "string", "description": "Description" }, "order": { "type": "number", "description": "Order" }, "task_group_id": { "type": "string", "description": "Task Group ID" }, "task_id": { "type": "string", "description": "Task Id. This field is mandatory only when we want to create this task as subtask of other task." }, "milestone_id": { "type": "string", "description": "Milestone ID" }, "rule_id": { "type": "string", "description": "Rule ID" }, "annotation_id": { "type": "string", "description": "Annotation ID" }, "due_date": { "type": "string", "description": "Due Date" }, "start_date": { "type": "string", "description": "Start Date" }, "assignees": { "description": "List of Assignees", "type": "array", "items": { "type": "string" } }, "labels": { "description": "List of labels", "type": "array", "items": { "type": "string" } }, "meeting_ids": { "description": "List of meeting ID", "type": "array", "items": { "type": "string" } }, "embed_url": { "type": "string", "description": "Embed URL" }, "banner": { "type": "string", "description": "Banner" }, "fields": { "description": "Task Field Body", "type": "array", "items": { "$ref": "#/components/schemas/CreateTaskFieldBody" } }, "story_points": { "type": "number", "description": "Story Points" }, "dependency": { "description": "Task this one is blocked by, referenced by id.", "allOf": [ { "$ref": "#/components/schemas/TaskReference" } ] } }, "required": [ "name", "task_group_id" ] }, "GetPersonalTasksDto": { "type": "object", "properties": { "limit": { "type": "string", "example": "25", "description": "No of records per page" }, "offset": { "type": "string", "example": "0", "description": "Record Offset" }, "meeting_id": { "type": "string", "description": "Meeting ID" }, "completed": { "type": "boolean", "description": "Completed?" } }, "required": [ "limit" ] }, "IdReference": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the referenced record.", "example": "i5vtiganU9y25V" } }, "required": [ "id" ] }, "PersonalTaskResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Task id.", "example": "PtQ7bK2wR" }, "niceId": { "type": "number", "description": "Per-creator sequence number for personal tasks; the highest existing value plus one.", "example": 12 }, "name": { "type": "string", "description": "Task name.", "example": "Draft Q4 board deck" }, "description": { "type": "string", "description": "Task description; Nifty Markdown.", "example": "Pull the revenue chart from the finance sheet first." }, "order": { "type": "number", "description": "Rank among the creator's personal tasks. Assigned as the midpoint between neighbours, or 100 for the first task.", "example": 100 }, "personal": { "type": "boolean", "description": "Always true on this endpoint — personal tasks belong to no project.", "example": true }, "startDate": { "format": "date-time", "type": "string", "description": "Start date, or null when none was sent (ISO 8601, UTC).", "example": "2026-09-07T09:00:00.000Z" }, "dueDate": { "format": "date-time", "type": "string", "description": "Due date, or null when none was sent (ISO 8601, UTC).", "example": "2026-09-11T17:00:00.000Z" }, "createdAt": { "format": "date-time", "type": "string", "description": "Creation timestamp (ISO 8601, UTC).", "example": "2026-09-04T11:48:02.317Z" }, "updatedAt": { "format": "date-time", "type": "string", "description": "Last modification timestamp (ISO 8601, UTC).", "example": "2026-09-04T11:48:02.317Z" }, "createdBy": { "description": "The team member who created the task.", "allOf": [ { "$ref": "#/components/schemas/IdReference" } ] }, "parentTask": { "nullable": true, "description": "Parent task when the request carried `task_id`, making this a subtask; null otherwise.", "allOf": [ { "$ref": "#/components/schemas/IdReference" } ] }, "rule": { "nullable": true, "description": "Recurring rule that produced the task when the request carried `rule_id`; null otherwise.", "allOf": [ { "$ref": "#/components/schemas/IdReference" } ] }, "assignees": { "description": "Always empty on the create response — assignees are cleared before the task is returned.", "example": [], "type": "array", "items": { "type": "string" } }, "hiddenFor": { "description": "Roles the task is hidden from. Always empty for a personal task.", "example": [], "type": "array", "items": { "type": "string" } }, "meeting_ids": { "description": "Meeting ids sent on the request, when any.", "example": [], "type": "array", "items": { "type": "string" } } }, "required": [ "id", "niceId", "name", "description", "order", "personal", "startDate", "dueDate", "createdAt", "updatedAt", "createdBy", "parentTask", "rule", "assignees", "hiddenFor", "meeting_ids" ] }, "UpdateTaskResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" } }, "required": [ "message" ] }, "RemoveTaskResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" } }, "required": [ "message" ] }, "UpdateTaskMilestoneReponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" } }, "required": [ "message" ] }, "CompletedTaskResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" } }, "required": [ "message" ] }, "MoveTarget": { "type": "object", "properties": { "type": { "type": "string", "description": "Type" }, "id": { "type": "string", "description": "ID" } }, "required": [ "type", "id" ] }, "MoveTaskNew": { "type": "object", "properties": { "to": { "description": "", "allOf": [ { "$ref": "#/components/schemas/MoveTarget" } ] }, "task_order": { "type": "string", "description": "Task Order" }, "next_task": { "type": "string", "description": "Next Task" }, "prev_task": { "type": "string", "description": "Previous Task" } }, "required": [ "to" ] }, "AssigneesBody": { "type": "object", "properties": { "assignees": { "description": "List of Assignees", "type": "array", "items": { "type": "string" } } }, "required": [ "assignees" ] }, "AddLabelsToTaskResponse": { "type": "object", "properties": { "message": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } } }, "required": [ "message", "labels" ] }, "RemoveTasks": { "type": "object", "properties": { "project_id": { "type": "string", "description": "Project ID" }, "task_ids": { "description": "List of Task ID", "type": "array", "items": { "type": "string" } } } }, "MoveTasks": { "type": "object", "properties": { "to": { "description": "", "allOf": [ { "$ref": "#/components/schemas/MoveTarget" } ] }, "task_ids": { "description": "List of Task ID", "type": "array", "items": { "type": "string" } } }, "required": [ "to", "task_ids" ] }, "TaskGroupResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "name": { "type": "string", "description": "" }, "order": { "type": "number", "description": "" }, "project_id": { "type": "string", "description": "" }, "color": { "type": "string", "description": "" }, "milestone": { "type": "string", "description": "" }, "is_completion_group": { "type": "boolean", "description": "" }, "assignees": { "description": "", "type": "array", "items": { "type": "string" } }, "hidden": { "description": "", "type": "array", "items": { "type": "string" } }, "rollup": { "type": "object", "description": "" } }, "required": [ "id", "name", "order", "project_id", "color", "milestone", "is_completion_group", "assignees", "hidden", "rollup" ] }, "GetTaskGroupsResponse": { "type": "object", "properties": { "items": { "description": "", "type": "array", "items": { "$ref": "#/components/schemas/TaskGroupResponse" } }, "hasMore": { "type": "boolean", "description": "True if there are more record else false", "default": false } }, "required": [ "items" ] }, "CreateTaskGroupBody": { "type": "object", "properties": { "name": { "type": "string", "description": "Name" }, "order": { "type": "number", "description": "Order" }, "color": { "type": "string", "description": "Color" }, "isCompletionGroup": { "type": "boolean", "description": "Is Completion Group" }, "project_id": { "type": "string", "description": "Project ID" } }, "required": [ "name", "project_id" ] }, "TaskGroupCompactResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "" }, "name": { "type": "string", "description": "" }, "created_by": { "type": "string", "description": "" }, "project": { "type": "string", "description": "" }, "color": { "type": "string", "description": "" }, "order": { "type": "number", "description": "" }, "assignees": { "description": "", "type": "array", "items": { "type": "string" } }, "rollup": { "type": "string", "description": "" } }, "required": [ "id", "name", "created_by", "project", "color", "order", "assignees", "rollup" ] }, "UpdateTaskGroupDto": { "type": "object", "properties": { "name": { "type": "string" }, "order": { "type": "number" }, "color": { "type": "string" }, "is_completion_group": { "type": "boolean", "description": "Is Completion Group" }, "archived": { "type": "boolean", "description": "Archived" }, "rollup": { "type": "string", "description": "Rollup" } } }, "TaskGroupGeneralResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Success message" } }, "required": [ "message" ] }, "MoveAllTasks": { "type": "object", "properties": { "target": { "type": "string", "description": "Target" } }, "required": [ "target" ] }, "InviteMember": { "type": "object", "properties": { "email": { "type": "string", "description": "Email" }, "name": { "type": "string", "description": "Name" }, "role": { "type": "string", "description": "Role" } }, "required": [ "email", "role" ] }, "InviteDto": { "type": "object", "properties": { "invitees": { "description": "List of members", "type": "array", "items": { "$ref": "#/components/schemas/InviteMember" } } }, "required": [ "invitees" ] }, "TemplateResponseDto": { "type": "object", "properties": { "ID": { "type": "string" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "Template Type": { "type": "string" }, "Public Token": { "type": "string" }, "Created Date": { "format": "date-time", "type": "string" }, "Updated Date": { "format": "date-time", "type": "string" }, "Created by Team member Id": { "type": "string" } }, "required": [ "ID", "Name", "Description", "Template Type", "Public Token", "Created Date", "Updated Date", "Created by Team member Id" ] }, "GetWebhooksDto": { "type": "object", "properties": { "limit": { "type": "number", "example": "25", "description": "No of records per page" }, "offset": { "type": "number", "example": "0", "description": "Record Offset" } }, "required": [ "limit", "offset" ] }, "WebhookResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Webhook id.", "example": "W1qZ8mKrT" }, "endpoint": { "type": "string", "description": "HTTPS endpoint Nifty POSTs each event to.", "example": "https://hooks.example.com/nifty" }, "registered_event": { "type": "array", "description": "Events this endpoint is subscribed to.", "example": [ "taskCreated", "taskUpdated" ], "items": { "type": "string", "enum": [ "projectCreated", "projectRemoved", "projectUpdated", "taskCreated", "taskRemoved", "taskUpdated", "portfolioCreated", "portfolioRemoved", "portfolioUpdated", "taskgroupCreated", "taskgroupRemoved", "taskgroupUpdated", "messageCreated", "messageRemoved", "messageUpdated", "milestoneCreated", "milestoneRemoved", "milestoneUpdated", "documentCreated", "documentUpdated", "documentRemoved", "fileCreated", "fileRemoved", "fileUpdated", "labelCreated", "labelRemoved", "labelUpdated", "subtaskCreated", "subtaskRemoved", "subtaskUpdated", "timeTrackingRecordCreated", "timeTrackingRecordUpdated", "timeTrackingRecordRemoved" ] } }, "createdAt": { "format": "date-time", "type": "string", "description": "When the webhook was registered (ISO 8601, UTC).", "example": "2026-08-14T09:21:07.412Z" }, "updatedAt": { "format": "date-time", "type": "string", "description": "When the webhook was last modified (ISO 8601, UTC).", "example": "2026-08-21T16:02:55.108Z" } }, "required": [ "id", "endpoint", "registered_event", "createdAt", "updatedAt" ] }, "GetWebhooksResponse": { "type": "object", "properties": { "webhooks": { "description": "Registered webhooks", "type": "array", "items": { "$ref": "#/components/schemas/WebhookResponse" } }, "hasMore": { "type": "boolean", "description": "True if there are more record else false", "default": false } }, "required": [ "webhooks", "hasMore" ] }, "CreateWebhookDto": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "Webhook Endpoint URL" }, "event": { "type": "array", "description": "Webhook events", "items": { "type": "string", "enum": [ "projectCreated", "projectRemoved", "projectUpdated", "taskCreated", "taskRemoved", "taskUpdated", "portfolioCreated", "portfolioRemoved", "portfolioUpdated", "taskgroupCreated", "taskgroupRemoved", "taskgroupUpdated", "messageCreated", "messageRemoved", "messageUpdated", "milestoneCreated", "milestoneRemoved", "milestoneUpdated", "documentCreated", "documentUpdated", "documentRemoved", "fileCreated", "fileRemoved", "fileUpdated", "labelCreated", "labelRemoved", "labelUpdated", "subtaskCreated", "subtaskRemoved", "subtaskUpdated", "timeTrackingRecordCreated", "timeTrackingRecordUpdated", "timeTrackingRecordRemoved" ] } }, "app_id": { "type": "string", "description": "Application id" } }, "required": [ "endpoint", "event", "app_id" ] }, "CreateWebhookReponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Operation message" }, "webhook": { "description": "The registered webhook", "allOf": [ { "$ref": "#/components/schemas/WebhookResponse" } ] } }, "required": [ "message", "webhook" ] }, "RemoveWebhookDto": { "type": "object", "properties": { "app_id": { "type": "string", "description": "Application ID" } }, "required": [ "app_id" ] }, "RemoveWebhookResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Operation message" }, "webhook_id": { "type": "string", "description": "Webhook ID" } }, "required": [ "message", "webhook_id" ] }, "UpdateWebhookDto": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "Webhook Endpoint URL" }, "event": { "type": "array", "description": "Webhook Event", "items": { "type": "string", "enum": [ "projectCreated", "projectRemoved", "projectUpdated", "taskCreated", "taskRemoved", "taskUpdated", "portfolioCreated", "portfolioRemoved", "portfolioUpdated", "taskgroupCreated", "taskgroupRemoved", "taskgroupUpdated", "messageCreated", "messageRemoved", "messageUpdated", "milestoneCreated", "milestoneRemoved", "milestoneUpdated", "documentCreated", "documentUpdated", "documentRemoved", "fileCreated", "fileRemoved", "fileUpdated", "labelCreated", "labelRemoved", "labelUpdated", "subtaskCreated", "subtaskRemoved", "subtaskUpdated", "timeTrackingRecordCreated", "timeTrackingRecordUpdated", "timeTrackingRecordRemoved" ] } }, "app_id": { "type": "string", "description": "Application ID" } }, "required": [ "endpoint", "event", "app_id" ] }, "UpdateWebhookResponse": { "type": "object", "properties": { "message": { "type": "string", "description": "Operation message" }, "webhook_id": { "type": "string", "description": "Updated webhook record id" } }, "required": [ "message", "webhook_id" ] } } } }