{"openapi":"3.0.1","info":{"title":"Wrike API","version":"4.0"},"servers":[{"url":"https://www.wrike.com/api/v4"},{"url":"https://app-eu.wrike.com/api/v4"},{"url":"https://app-us2.wrike.com/api/v4"}],"paths":{"/access_roles":{"get":{"tags":["Access Roles"],"summary":"Get Access Roles","description":"Access roles.\n\nScopes: amReadOnlyAccessRole","operationId":"GET:/access_roles/empty","responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AccessRole"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/account":{"get":{"tags":["Account"],"summary":"Query Accounts","description":"Returns current account.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/account/empty","parameters":[{"name":"metadata","in":"query","description":"Metadata filter, exact match for metadata key or key-value pair","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `metadata` - Account metadata\n* `customFields` - Account custom fields\n* `subscription` - Account subscription","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["metadata","customFields","subscription"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Account"],"summary":"Modify Account","description":"Update current account.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/account/empty","parameters":[{"name":"metadata","in":"query","description":"Metadata to be updated. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Metadata to be updated","items":{"$ref":"#/components/schemas/Metadata"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Account"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/approvals":{"get":{"tags":["Approvals"],"summary":"Get Approvals (Account)","description":"Reads approvals by filter. When no filter parameters passed returns all approvals shared with a user.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/approvals/empty","parameters":[{"name":"statuses","in":"query","description":"Get approvals for specified statuses\n* `Draft`\n* `Approved`\n* `Rejected`\n* `Cancelled`\n* `Pending`","required":false,"schema":{"$ref":"#/components/schemas/ApprovalStatus"}},{"name":"updatedDate","in":"query","description":"Last updated date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"approvers","in":"query","description":"Approvers filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Approvers filter, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"pendingApprovers","in":"query","description":"Pending approvers filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Pending approvers filter, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"type","in":"query","description":"Get approvals for specified types\n* `FilesOnly`\n* `Regular`","required":false,"schema":{"$ref":"#/components/schemas/ApprovalType"}},{"name":"dueDate","in":"query","description":"Due date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"limit","in":"query","description":"Limit on number of returned approvals","required":false,"schema":{"type":"number","description":"Limit on number of returned approvals"}},{"name":"pageSize","in":"query","description":"Page size","required":false,"schema":{"type":"number","description":"Page size"}},{"name":"nextPageToken","in":"query","description":"Next page token, overrides any other parameters in request","required":false,"schema":{"type":"string","description":"Next page token, overrides any other parameters in request"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Approval"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}/approvals":{"get":{"tags":["Approvals"],"summary":"Get Approvals (Folder)","description":"Reads all approvals on folder/project.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/single/approvals","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Approval"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Approvals"],"summary":"Create Approvals (Folder)","description":"Create an approval for folder/project. Creates approval in draft status when no approvers assigned. Otherwise creates in pending status. Approvals created via API will not be affected by workflow automation, e.g. task status will not be automatically transitioned when approval finishes.\n\nScopes: Default, wsReadWrite","operationId":"POST:/folders/single/approvals","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"description","in":"query","description":"Description","required":false,"schema":{"type":"string","description":"Description"}},{"name":"dueDate","in":"query","description":"Due date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Due date Format: yyyy-MM-dd"}},{"name":"approvers","in":"query","description":"Assign approvers","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assign approvers","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"attachments","in":"query","description":"List of origin version attachments to set in approval","required":false,"content":{"application/json":{"schema":{"type":"array","description":"List of origin version attachments to set in approval","items":{"$ref":"#/components/schemas/AttachmentId"}}}}},{"name":"autoFinishOnApprove","in":"query","description":"Is finish approval automatically when all approvers have approved. Set to true by default","required":false,"schema":{"type":"string","description":"Is finish approval automatically when all approvers have approved. Set to true by default"}},{"name":"autoFinishOnReject","in":"query","description":"Is finish approval automatically when some of approvers have rejected. Set to true by default","required":false,"schema":{"type":"string","description":"Is finish approval automatically when some of approvers have rejected. Set to true by default"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Approval"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/tasks/{taskId}/approvals":{"get":{"tags":["Approvals"],"summary":"Get Approvals (Task)","description":"Reads all approvals on task.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/tasks/single/approvals","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Approval"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Approvals"],"summary":"Create Approvals (Task)","description":"Create an approval for task. Creates approval in draft status when no approvers assigned. Otherwise creates in pending status. Approvals created via API will not be affected by workflow automation, e.g. task status will not be automatically transitioned when approval finishes.\n\nScopes: Default, wsReadWrite","operationId":"POST:/tasks/single/approvals","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"description","in":"query","description":"Description","required":false,"schema":{"type":"string","description":"Description"}},{"name":"dueDate","in":"query","description":"Due date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Due date Format: yyyy-MM-dd"}},{"name":"approvers","in":"query","description":"Assign approvers","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assign approvers","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"attachments","in":"query","description":"List of origin version attachments to set in approval","required":false,"content":{"application/json":{"schema":{"type":"array","description":"List of origin version attachments to set in approval","items":{"$ref":"#/components/schemas/AttachmentId"}}}}},{"name":"autoFinishOnApprove","in":"query","description":"Is finish approval automatically when all approvers have approved. Set to true by default","required":false,"schema":{"type":"string","description":"Is finish approval automatically when all approvers have approved. Set to true by default"}},{"name":"autoFinishOnReject","in":"query","description":"Is finish approval automatically when some of approvers have rejected. Set to true by default","required":false,"schema":{"type":"string","description":"Is finish approval automatically when some of approvers have rejected. Set to true by default"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Approval"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/approvals/{approvalIds}":{"get":{"tags":["Approvals"],"summary":"Get Approvals By ID","description":"Reads approvals by ids.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/approvals/multi","parameters":[{"name":"approvalIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/ApprovalId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Approval"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/approvals/{approvalId}":{"put":{"tags":["Approvals"],"summary":"Update approval","description":"Update approval.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/approvals/single","parameters":[{"name":"approvalId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ApprovalId"}},{"name":"description","in":"query","description":"description","required":false,"schema":{"type":"string","description":"description"}},{"name":"dueDate","in":"query","description":"due date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"due date Format: yyyy-MM-dd"}},{"name":"addApprovers","in":"query","description":"Assign approvers","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assign approvers","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"removeApprovers","in":"query","description":"Remove approvers","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove approvers","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"addAttachments","in":"query","description":"Add origin version attachments to approval","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add origin version attachments to approval","items":{"$ref":"#/components/schemas/AttachmentId"}}}}},{"name":"removeAttachments","in":"query","description":"Remove origin version attachments from approval","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove origin version attachments from approval","items":{"$ref":"#/components/schemas/AttachmentId"}}}}},{"name":"autoFinishOnApprove","in":"query","description":"Is finish approval automatically when all approvers have approved","required":false,"schema":{"type":"string","description":"Is finish approval automatically when all approvers have approved"}},{"name":"autoFinishOnReject","in":"query","description":"Is finish approval automatically when some of approvers have rejected","required":false,"schema":{"type":"string","description":"Is finish approval automatically when some of approvers have rejected"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Approval"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Approvals"],"summary":"Cancel approval","description":"Cancel approval.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/approvals/single","parameters":[{"name":"approvalId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ApprovalId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Approval"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/assets":{"post":{"tags":["Assets"],"summary":"Create Equipment","description":"Create asset in account.\n\nScopes: amReadWriteUser","operationId":"POST:/assets/empty","parameters":[{"name":"name","in":"query","description":"Name of asset, required","required":true,"schema":{"type":"string","description":"Name of asset, required"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Equipment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/assets/{assetId}":{"put":{"tags":["Assets"],"summary":"Update Equipment","description":"Update asset.\n\nScopes: amReadWriteUser","operationId":"PUT:/assets/single","parameters":[{"name":"assetId","in":"path","required":true,"schema":{"oneOf":[{"$ref":"#/components/schemas/UserId"},{"$ref":"#/components/schemas/InvitationId"}]}},{"name":"name","in":"query","description":"Name of asset, required","required":true,"schema":{"type":"string","description":"Name of asset, required"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Equipment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Assets"],"summary":"Delete Equipment","description":"Delete asset.\n\nScopes: amReadWriteUser","operationId":"DELETE:/assets/single","parameters":[{"name":"assetId","in":"path","required":true,"schema":{"oneOf":[{"$ref":"#/components/schemas/UserId"},{"$ref":"#/components/schemas/InvitationId"}]}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Equipment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/async_job/{asyncJobId}":{"get":{"tags":["Async job"],"summary":"Get async job","description":"Get Async job specified by id.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/async_job/single","parameters":[{"name":"asyncJobId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AsyncJobId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AsyncJob"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/attachments":{"get":{"tags":["Attachments"],"summary":"Get Attachments (Account)","description":"Return all Attachments of account tasks and folders.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/attachments/empty","parameters":[{"name":"versions","in":"query","description":"Get attachments with previous versions","required":false,"schema":{"type":"boolean","description":"Get attachments with previous versions"}},{"name":"createdDate","in":"query","description":"Created date filter. Required to request attachments in account. Time range duration should be less than 31 day","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"withUrls","in":"query","description":"Get attachment URLs. The link for attachment from Wrike is valid for 24 hours from when you make the request","required":false,"schema":{"type":"boolean","description":"Get attachment URLs. The link for attachment from Wrike is valid for 24 hours from when you make the request"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}/attachments":{"get":{"tags":["Attachments"],"summary":"Get Attachments (Folder)","description":"Returns all Attachments of a folder.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/single/attachments","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"versions","in":"query","description":"Get attachments with previous versions","required":false,"schema":{"type":"boolean","description":"Get attachments with previous versions"}},{"name":"createdDate","in":"query","description":"Created date filter. Required to request attachments in account. Time range duration should be less than 31 day","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"withUrls","in":"query","description":"Get attachment URLs. The link for attachment from Wrike is valid for 24 hours from when you make the request","required":false,"schema":{"type":"boolean","description":"Get attachment URLs. The link for attachment from Wrike is valid for 24 hours from when you make the request"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Attachments"],"summary":"Create Attachment (Folder)","description":"Add an attachment to a folder.\n\nScopes: Default, wsReadWrite","operationId":"POST:/folders/single/attachments","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/tasks/{taskId}/attachments":{"get":{"tags":["Attachments"],"summary":"Get Attachments (Task)","description":"Returns all Attachments of a task.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/tasks/single/attachments","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"versions","in":"query","description":"Get attachments with previous versions","required":false,"schema":{"type":"boolean","description":"Get attachments with previous versions"}},{"name":"createdDate","in":"query","description":"Created date filter. Required to request attachments in account. Time range duration should be less than 31 day","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"withUrls","in":"query","description":"Get attachment URLs. The link for attachment from Wrike is valid for 24 hours from when you make the request","required":false,"schema":{"type":"boolean","description":"Get attachment URLs. The link for attachment from Wrike is valid for 24 hours from when you make the request"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Attachments"],"summary":"Create Attachment (Task)","description":"Add an attachment to a task.\n\nScopes: Default, wsReadWrite","operationId":"POST:/tasks/single/attachments","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/attachments/{attachmentIds}":{"get":{"tags":["Attachments"],"summary":"Get Attachments By ID","description":"Returns complete information about multiple attachments.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/attachments/multi","parameters":[{"name":"attachmentIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/AttachmentId"}}}}},{"name":"versions","in":"query","description":"Get attachments with previous versions","required":false,"schema":{"type":"boolean","description":"Get attachments with previous versions"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/attachments/{attachmentId}/download":{"get":{"tags":["Attachments"],"summary":"Download Attachment","description":"Returns attachment content. It can be accessed via /attachments/id/download/name.ext URL. In this case, 'name.ext' will be returned as the file name.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/attachments/single/download","parameters":[{"name":"attachmentId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AttachmentId"}}],"responses":{"2XX":{"description":"success response","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/attachments/{attachmentId}/preview":{"get":{"tags":["Attachments"],"summary":"Preview Attachment","description":"Returns Preview for the attachment. The preview can be accessed via /attachments/id/preview/name.ext URL. In this case, 'name.ext' will be returned as the file name.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/attachments/single/preview","parameters":[{"name":"attachmentId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AttachmentId"}},{"name":"size","in":"query","description":"Preview dimensions\n* `w44` - Width = 44, height = auto\n* `w300` - Width = 300, height = auto\n* `w400` - Width = 400, height = auto\n* `w100` - Width = 100, height = auto\n* `h400` - Width = auto, height = 400\n* `w200` - Width = 200, height = auto","required":false,"schema":{"type":"string","enum":["w44","w300","w400","w100","h400","w200"]}}],"responses":{"2XX":{"description":"success response","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/attachments/{attachmentId}/url":{"get":{"tags":["Attachments"],"summary":"Get Attachment URL","description":"Public URL to an attachment from Wrike or an external service. The link for attachment from Wrike is valid for 24 hours from when you make the request.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/attachments/single/url","parameters":[{"name":"attachmentId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AttachmentId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentUrl"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/attachments/{attachmentId}":{"put":{"tags":["Attachments"],"summary":"Update Attachment","description":"Update previously uploaded Attachment with new version.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/attachments/single","parameters":[{"name":"attachmentId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AttachmentId"}},{"name":"url","in":"query","description":"Download attachment by url","required":false,"schema":{"type":"string","description":"Download attachment by url"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Attachments"],"summary":"Delete Attachment","description":"Delete Attachment by ID.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/attachments/single","parameters":[{"name":"attachmentId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/AttachmentId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"type":"string"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/audit_log":{"get":{"tags":["Audit Log"],"summary":"Get Audit Log","description":"Get Audit Log Reports, that contains audit trail for actions in the account. Available to Enterprise admins with \"Create user activity reports\" right.\n\nScopes: amReadOnlyAuditLog","operationId":"GET:/audit_log/empty","parameters":[{"name":"eventDate","in":"query","description":"Event date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"operations","in":"query","description":"Operations filter\n* `SecondFactorEnabled`\n* `CustomFieldRemoved`\n* `CalendarExternalLinksActivated`\n* `TaskDuplication`\n* `GanttSnapshotDeleted`\n* `CalendarExternalLinkDeleted`\n* `TaskRestored`\n* `CalendarExternalLinksDeactivated`\n* `PowerBIPublicLinkDeleted`\n* `ApprovalCanceled`\n* `RequestFormCreated`\n* `SamlClearPasswordForSamlUsers`\n* `OneTimePasswordUsed`\n* `AnalyzeWidgetPublicLinkCreated`\n* `TaskErased`\n* `InvitationPolicyChanged`\n* `CalendarExternalLinkCreated`\n* `UserTaskGroupRolesChanged`\n* `UserJoinedSpace`\n* `SamlSSOSettingsChanged`\n* `UserFailLogin`\n* `SamlSSODisabled`\n* `AdminMailSettingsChanged`\n* `CustomFieldRemovedFromFolder`\n* `UserLoggedIn`\n* `UserRoleChanged`\n* `CustomFieldAddedToFolder`\n* `UserTypeModified`\n* `AccessCodeAccepted`\n* `PublicLinkExpirationChanged`\n* `UserLogout`\n* `PowerBIPublicLinkCreated`\n* `GuestReviewerRevoked`\n* `ApprovedIpRangesOrSubnetsChanged`\n* `TaskScheduleChanged`\n* `CustomFieldRestored`\n* `AccountDeleted`\n* `UserAdminPermissionsChanged`\n* `AttachDeleted`\n* `SpaceDeleted`\n* `AuditReportCreated`\n* `UserTypeCreated`\n* `ExcelExportCreated`\n* `AdminLoggedInAsUser`\n* `WorkflowCreated`\n* `TaskUnsharedFromAuthor`\n* `AccessAuditReportCsvExport`\n* `AttachMarkAsFinal`\n* `OneTimePasswordStatusSwitched`\n* `ApproverAdded`\n* `UserLeftSpace`\n* `TaskUnarchived`\n* `ApprovalDescriptionChanged`\n* `GroupParentRemoved`\n* `GuestReviewAccountSettingsChanged`\n* `WorkflowDeleted`\n* `PasswordPolicyModified`\n* `GroupInviteeAdded`\n* `UserRestored`\n* `WorkflowArchived`\n* `ApprovalDueDateChanged`\n* `AnalyzeWidgetPublicLinkDeleted`\n* `SpaceArchivedUnarchived`\n* `TaskStatusChanged`\n* `TaskCommentChanged`\n* `AccessRoleDeleted`\n* `TaskUnassigned`\n* `AnalyzePublicLinkCreated`\n* `GuestReviewRejected`\n* `TaskUnshared`\n* `PasswordChanged`\n* `RequestFormDeleted`\n* `AttemptDownloadInfectedAttach`\n* `InvitationSend`\n* `AccessRoleModified`\n* `SpaceCreated`\n* `ApprovedDomainsChanged`\n* `TimesheetStatusChanged`\n* `TimelogLocked`\n* `UserRevokeAdmin`\n* `RecycleBinErased`\n* `ApproverRemoved`\n* `UserDeleted`\n* `GanttSnapshotCreated`\n* `GroupMemberRemoved`\n* `UserProfileUpdated`\n* `SecondFactorUsageReportCreated`\n* `SecondFactorDisabled`\n* `WhiteboardCreated`\n* `AttachViewed`\n* `AccessRoleCreated`\n* `GroupMemberAdded`\n* `AccountDataExportRequested`\n* `SamlSSOMetadataChanged`\n* `GroupRenamed`\n* `PublicLinkCreated`\n* `TaskShared`\n* `AccountModified`\n* `PublicLinkPasswordRequested`\n* `WorkflowModified`\n* `PublicLinkDeleted`\n* `AccessCodeDeclined`\n* `AnalyzeWidgetPublicLinkAccessed`\n* `ApprovalCreated`\n* `Oauth2AccessRevoked`\n* `TaskParentRemoved`\n* `AntivirusDeletedInfectedAttach`\n* `RequestFormModified`\n* `GroupInviteeRemoved`\n* `GuestReviewerInvited`\n* `TaskArchived`\n* `AccountBackupCreated`\n* `FeedCreated`\n* `AccessCodeGenerated`\n* `UserDeactivated`\n* `AttachCopied`\n* `GroupParentAdded`\n* `GuestReviewerChanged`\n* `TimelogUnlocked`\n* `TaskCreated`\n* `WhiteboardRemoved`\n* `OneTimePasswordRevoked`\n* `ApprovalFinished`\n* `TaskAssigned`\n* `OneTimePasswordCreated`\n* `GroupCreated`\n* `TimesheetCreated`\n* `UsersAndGroupsExported`\n* `AttachMoved`\n* `CustomFieldCreated`\n* `AutomatedIntegrationsExecution`\n* `PowerBIPublicLinkAccessed`\n* `AttachUnmarkAsFinal`\n* `AnalyzePublicLinkAccessed`\n* `TimesheetTimeframeSettingsModified`\n* `GroupDeleted`\n* `CustomFieldModified`\n* `TaskCommentDeleted`\n* `AnalyzePublicLinkDeleted`\n* `UserTypeDeleted`\n* `TimesheetTimeframeSettingsCreated`\n* `Oauth2AccessGranted`\n* `UserGrantAdmin`\n* `PublicLinksAccountSettingsChanged`\n* `WorkflowUnarchived`\n* `TaskDeleted`\n* `InvitationAccepted`\n* `AccountDataExportGenerated`\n* `SamlSSOEnabled`\n* `PublicLinkPasswordChanged`\n* `TaskParentAdded`\n* `ApprovalDecisionMade`\n* `GuestReviewAccepted`\n* `UserCustomFieldValueChanged`\n* `UserActivated`\n* `AttachUploaded`\n* `AttachDownloaded`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Operations filter","items":{"$ref":"#/components/schemas/AuditLogOperation"}}}}},{"name":"pageSize","in":"query","description":"Page size","required":false,"schema":{"type":"number","description":"Page size"}},{"name":"nextPageToken","in":"query","description":"Next page token, overrides any other parameters in request","required":false,"schema":{"type":"string","description":"Next page token, overrides any other parameters in request"}},{"name":"objectType","in":"query","description":"Filter by object type. Requires both eventDate and operations to be specified.\n* `Account`\n* `Group`\n* `AnalyzeReportWidget`\n* `Task`\n* `User`\n* `WorkspaceSnapshot`\n* `TimesheetTimeframeSettings`\n* `CalendarExternalLink`\n* `Attachment`\n* `Folder`\n* `DataExport`\n* `PowerBIEntity`\n* `Whiteboard`\n* `Space`\n* `Comment`\n* `RequestForm`\n* `AccessRole`\n* `Timesheet`\n* `Invitation`\n* `Workflow`\n* `AnalyzeReport`\n* `Oauth2Client`\n* `Project`\n* `PublicLink`\n* `UserRole`\n* `CustomField`\n* `UserType`","required":false,"schema":{"$ref":"#/components/schemas/AuditLogObjectType"}},{"name":"objectIds","in":"query","description":"Filter by object ids. Requires objectType to be specified. Accepts up to 10 ids.","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Filter by object ids. Requires objectType to be specified. Accepts up to 10 ids.","items":{"type":"string"}}}}},{"name":"users","in":"query","description":"Filter by users ids. Accepts up to 10 ids.","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Filter by users ids. Accepts up to 10 ids.","items":{"$ref":"#/components/schemas/UserId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLog"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/batch":{"post":{"tags":["Batch operations"],"summary":"Create Batch Operation","description":"
Overview
The Batch API lets you execute multiple operations asynchronously in a single request to reduce API calls and rate-limit pressure.
Supports up to 100 operations per batch
Operations are executed asynchronously and independently (not transactional)
A batch may contain heterogeneous operation types
Execution & Results
POST /batch schedules an asynchronous job and returns an asyncJobId
Use the Async Job API to track progress and retrieve per-operation results
Partial success is possible; each operation returns its own status
Quota
Batch operations consume a per-account operation quota that replenishes as operations complete
Requests may be rejected if insufficient quota is available
.\n\nScopes: Default, wsReadWrite","operationId":"POST:/batch/empty","parameters":[{"name":"operations","in":"query","description":"Array of operations to execute. Limit : `100`","required":true,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Array of operations to execute","items":{"$ref":"#/components/schemas/BatchOperation"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AsyncJob"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/bookings/{bookingIds}":{"get":{"tags":["Bookings"],"summary":"Get Bookings By ID","description":"Get bookings list.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/bookings/multi","parameters":[{"name":"bookingIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/BookingId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Booking"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/bookings":{"get":{"tags":["Bookings"],"summary":"Get Bookings (Account)","description":"Returns list of all bookings in account.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/bookings/empty","parameters":[{"name":"startDate","in":"query","description":"Start date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Start date Format: yyyy-MM-dd"}},{"name":"finishDate","in":"query","description":"Finish date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Finish date Format: yyyy-MM-dd"}},{"name":"responsibleIds","in":"query","description":"IDs of responsible users. Limit : `15000`","required":false,"content":{"application/json":{"schema":{"maxItems":15000,"type":"array","description":"IDs of responsible users","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"responsiblePlaceholderIds","in":"query","description":"IDs of responsible placeholders. Limit : `15000`","required":false,"content":{"application/json":{"schema":{"maxItems":15000,"type":"array","description":"IDs of responsible placeholders","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}},{"name":"showDescendants","in":"query","description":"If true return bookings from descendant folders","required":false,"schema":{"type":"string","description":"If true return bookings from descendant folders","default":"false"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Booking"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}/bookings":{"get":{"tags":["Bookings"],"summary":"Get Bookings (Folder)","description":"Get bookings from folder.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/single/bookings","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"startDate","in":"query","description":"Start date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Start date Format: yyyy-MM-dd"}},{"name":"finishDate","in":"query","description":"Finish date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Finish date Format: yyyy-MM-dd"}},{"name":"responsibleIds","in":"query","description":"IDs of responsible users. Limit : `15000`","required":false,"content":{"application/json":{"schema":{"maxItems":15000,"type":"array","description":"IDs of responsible users","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"responsiblePlaceholderIds","in":"query","description":"IDs of responsible placeholders. Limit : `15000`","required":false,"content":{"application/json":{"schema":{"maxItems":15000,"type":"array","description":"IDs of responsible placeholders","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}},{"name":"showDescendants","in":"query","description":"If true return bookings from descendant folders","required":false,"schema":{"type":"string","description":"If true return bookings from descendant folders","default":"false"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Booking"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Bookings"],"summary":"Create Booking","description":"Create Booking.\n\nScopes: Default, wsReadWrite","operationId":"POST:/folders/single/bookings","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"bookingDates","in":"query","description":"Booking dates","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingDates"}}}},{"name":"responsibleId","in":"query","description":"ID of responsible","required":false,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"responsiblePlaceholderId","in":"query","description":"ID of responsible placeholder","required":false,"schema":{"$ref":"#/components/schemas/PlaceholderId"}},{"name":"effortAllocation","in":"query","description":"Effort allocation","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingEffort"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Booking"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/bookings/{bookingId}":{"put":{"tags":["Bookings"],"summary":"Update Booking","description":"Update Booking.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/bookings/single","parameters":[{"name":"bookingId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/BookingId"}},{"name":"bookingDates","in":"query","description":"Booking dates","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingDates"}}}},{"name":"responsibleId","in":"query","description":"ID of responsible","required":false,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"responsiblePlaceholderId","in":"query","description":"ID of responsible placeholder","required":false,"schema":{"$ref":"#/components/schemas/PlaceholderId"}},{"name":"effortAllocation","in":"query","description":"Effort allocation","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BookingEffort"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Booking"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Bookings"],"summary":"Delete Booking","description":"Delete booking by Id.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/bookings/single","parameters":[{"name":"bookingId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/BookingId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Booking"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/colors":{"get":{"tags":["Colors"],"summary":"Query Colors","description":"Get color name - code mapping.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/colors/empty","responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ColorsInfo"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/comments":{"get":{"tags":["Comments"],"summary":"Get Comments (Account)","description":"Get all comments in current account.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/comments/empty","parameters":[{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"types","in":"query","description":"Comment type filter\n* `Email`\n* `Regular`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Comment type filter","items":{"$ref":"#/components/schemas/CommentType"},"default":"[Regular]"}}}},{"name":"updatedDate","in":"query","description":"Deprecated because this parameter filters by created date instead of updated date. Please use the createdDate parameter instead","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"createdDate","in":"query","description":"Use the createdDate parameter to get all comments created within a specific date range. The date range must be 7 days or shorter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"limit","in":"query","description":"Maximum number of returned comments","required":false,"schema":{"type":"number","description":"Maximum number of returned comments","default":"1000"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `type` - Comment type","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["type"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}/comments":{"get":{"tags":["Comments"],"summary":"Get Comments (Folder)","description":"Get folder comments.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/single/comments","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"types","in":"query","description":"Comment type filter\n* `Email`\n* `Regular`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Comment type filter","items":{"$ref":"#/components/schemas/CommentType"},"default":"[Regular]"}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `type` - Comment type","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["type"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Comments"],"summary":"Create Comment (Folder)","description":"Create a comment in the folder. The virtual Root and Recycle Bin folders cannot have comments.\n\nScopes: Default, wsReadWrite","operationId":"POST:/folders/single/comments","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"text","in":"query","description":"Comment text, can not be empty. Supported HTML tags can be found in Special syntax","required":true,"schema":{"type":"string","description":"Comment text, can not be empty. Supported HTML tags can be found in Special syntax"}},{"name":"plainText","in":"query","description":"Treat comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Treat comment text as plain text, HTML otherwise","default":"false"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/tasks/{taskId}/comments":{"get":{"tags":["Comments"],"summary":"Get Comments (Task)","description":"Get task comments.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/tasks/single/comments","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"types","in":"query","description":"Comment type filter\n* `Email`\n* `Regular`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Comment type filter","items":{"$ref":"#/components/schemas/CommentType"},"default":"[Regular]"}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `type` - Comment type","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["type"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Comments"],"summary":"Create Comment (Task)","description":"Create comment in task.\n\nScopes: Default, wsReadWrite","operationId":"POST:/tasks/single/comments","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"text","in":"query","description":"Comment text, can not be empty. Supported HTML tags can be found in Special syntax","required":true,"schema":{"type":"string","description":"Comment text, can not be empty. Supported HTML tags can be found in Special syntax"}},{"name":"plainText","in":"query","description":"Treat comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Treat comment text as plain text, HTML otherwise","default":"false"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/comments/{commentIds}":{"get":{"tags":["Comments"],"summary":"Get Comments By ID","description":"Get single or multiple comments by their IDs.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/comments/multi","parameters":[{"name":"commentIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/CommentId"}}}}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"types","in":"query","description":"Comment type filter\n* `Email`\n* `Regular`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Comment type filter","items":{"$ref":"#/components/schemas/CommentType"},"default":"[Regular]"}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `type` - Comment type","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["type"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/comments/{commentId}":{"put":{"tags":["Comments"],"summary":"Update Comment","description":"Update Comment by ID. A comment is available for updates only during the 5 minutes after creation.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/comments/single","parameters":[{"name":"commentId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CommentId"}},{"name":"text","in":"query","description":"Comment text, can not be empty. Supported HTML tags can be found in Special syntax","required":true,"schema":{"type":"string","description":"Comment text, can not be empty. Supported HTML tags can be found in Special syntax"}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Comments"],"summary":"Delete Comment","description":"Delete comment by ID.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/comments/single","parameters":[{"name":"commentId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CommentId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"type":"string"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/contacts":{"get":{"tags":["Contacts"],"summary":"Query Contacts","description":"List contacts of all users and user groups in current account.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/contacts/empty","parameters":[{"name":"me","in":"query","description":"If present - only contact info of requesting user is returned","required":false,"schema":{"type":"boolean","description":"If present - only contact info of requesting user is returned"}},{"name":"metadata","in":"query","description":"Metadata filter, exact match for metadata key or key-value pair","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},{"name":"deleted","in":"query","description":"Deleted flag filter","required":false,"schema":{"type":"boolean","description":"Deleted flag filter"}},{"name":"customFields","in":"query","description":"Custom field filter","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom field filter","items":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}}},{"name":"emails","in":"query","description":"Email contacts filter. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Email contacts filter","items":{"type":"string"}}}}},{"name":"active","in":"query","description":"Active status filter","required":false,"schema":{"type":"boolean","description":"Active status filter"}},{"name":"name","in":"query","description":"Contact name filter","required":false,"schema":{"type":"string","description":"Contact name filter"}},{"name":"types","in":"query","description":"Contact type filter\n* `Group` - Group of users. Group userId can be used in folder/task sharing requests only. It has no effect in other operations\n* `Asset` - Asset\n* `Person` - Person\n* `Robot` - Robot user for automated operations","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Contact type filter","items":{"type":"string","enum":["Group","Asset","Person","Robot"]}}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `metadata` - Contact metadata\n* `currentCostRate` - Current user's cost rate\n* `customFields` - User's custom fields\n* `currentBillRate` - Current user's bill rate\n* `jobRoleId` - Current user's jobRoleId\n* `workScheduleId` - Contact work schedule id","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["metadata","currentCostRate","customFields","currentBillRate","jobRoleId","workScheduleId"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/contacts/{contactIds}":{"get":{"tags":["Contacts"],"summary":"Query Contacts","description":"List contacts of specified users and user groups.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/contacts/multi","parameters":[{"name":"contactIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/UserId"},{"$ref":"#/components/schemas/InvitationId"}]}}}}},{"name":"metadata","in":"query","description":"Metadata filter, exact match for metadata key or key-value pair","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},{"name":"types","in":"query","description":"Contact type filter\n* `Group` - Group of users. Group userId can be used in folder/task sharing requests only. It has no effect in other operations\n* `Asset` - Asset\n* `Person` - Person\n* `Robot` - Robot user for automated operations","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Contact type filter","items":{"type":"string","enum":["Group","Asset","Person","Robot"]}}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `metadata` - Contact metadata\n* `currentCostRate` - Current user's cost rate\n* `customFields` - User's custom fields\n* `currentBillRate` - Current user's bill rate\n* `jobRoleId` - Current user's jobRoleId\n* `workScheduleId` - Contact work schedule id","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["metadata","currentCostRate","customFields","currentBillRate","jobRoleId","workScheduleId"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/contacts/{contactIds}/contacts_history":{"get":{"tags":["Contacts"],"summary":"Query Contacts fields history","description":"Query Contacts fields history.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/contacts/multi/contacts_history","parameters":[{"name":"contactIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/UserId"},{"$ref":"#/components/schemas/InvitationId"}]}}}}},{"name":"updatedDate","in":"query","description":"Update date filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `billRate` - User's bill rate\n* `costRate` - User's cost rate","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["billRate","costRate"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactChangeHistory"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/contacts/{contactId}":{"put":{"tags":["Contacts"],"summary":"Modify Contact","description":"Update contact of requesting user by ID (use 'Modify User' method to update other users). Account Admins may use this method to update group info by group ID. .\n\nScopes: Default, wsReadWrite","operationId":"PUT:/contacts/single","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"oneOf":[{"$ref":"#/components/schemas/UserId"},{"$ref":"#/components/schemas/InvitationId"}]}},{"name":"metadata","in":"query","description":"Metadata to be updated. Requesting user has read/write access to his own metadata, other entries are read-only. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Metadata to be updated. Requesting user has read/write access to his own metadata, other entries are read-only","items":{"$ref":"#/components/schemas/Metadata"}}}}},{"name":"currentBillRate","in":"query","description":"Update current user's bill rate","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRate"}}}},{"name":"currentCostRate","in":"query","description":"Update current user's cost rate","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BudgetRate"}}}},{"name":"jobRoleId","in":"query","description":"Update current user's job role id","required":false,"schema":{"$ref":"#/components/schemas/JobRoleId"}},{"name":"customFields","in":"query","description":"Custom fields to be updated or deleted (null value removes field). Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Custom fields to be updated or deleted (null value removes field)","items":{"$ref":"#/components/schemas/CustomField"}}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `currentCostRate` - Current user's cost rate\n* `customFields` - User's custom fields\n* `currentBillRate` - Current user's bill rate\n* `jobRoleId` - Current user's job role id","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["currentCostRate","customFields","currentBillRate","jobRoleId"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/workschedules/{workscheduleId}/duplicate":{"post":{"tags":["Copy Work Schedule"],"summary":"Copy Work Schedule","description":"Duplicate work schedule in account.\n\nScopes: amReadWriteWorkSchedule","operationId":"POST:/workschedules/single/duplicate","parameters":[{"name":"workscheduleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"title","in":"query","description":"Name of work schedule","required":true,"schema":{"type":"string","description":"Name of work schedule"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkSchedule"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/customfields":{"get":{"tags":["Custom Fields"],"summary":"Get Custom Fields (Account)","description":"Returns a list of custom fields in current account.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/customfields/empty","parameters":[{"name":"applicableEntityTypes","in":"query","description":"Applicable entity types\n* `User`\n* `WorkItem`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Applicable entity types","items":{"$ref":"#/components/schemas/CustomFieldApplicableEntityType"},"default":"WorkItem"}}}},{"name":"types","in":"query","description":"Custom field types\n* `Multiple` - Collection field\n* `Percentage` - Comparable field\n* `Text` - String field, Comparable field\n* `Duration` - Comparable field\n* `CalculatedNumeric` - Calculated comparable field\n* `Date` - Comparable field\n* `CalculatedDate` - Calculated comparable field\n* `Numeric` - Comparable field\n* `Contacts` - Collection field\n* `Checkbox` - Boolean field\n* `Currency` - Comparable field\n* `DropDown` - String field, Comparable field\n* `LinkToDatabase` - Link to database field","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom field types","items":{"$ref":"#/components/schemas/CustomFieldType"}}}}},{"name":"inheritanceTypes","in":"query","description":"Custom field inheritance types\n* `All`\n* `Tasks`\n* `Projects`\n* `Folders`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom field inheritance types","items":{"$ref":"#/components/schemas/CustomFieldInheritanceType"}}}}},{"name":"title","in":"query","description":"Custom field title","required":false,"schema":{"type":"string","description":"Custom field title"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `dataUsageStatistics` - Return collection of data usage statistics","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["dataUsageStatistics"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldDescription"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Custom Fields"],"summary":"Create Custom Field (Account)","description":"Create custom field in specified account.\n\nScopes: Default, wsReadWrite","operationId":"POST:/customfields/empty","parameters":[{"name":"title","in":"query","description":"Custom field title","required":true,"schema":{"type":"string","description":"Custom field title"}},{"name":"type","in":"query","description":"Custom field type\n* `Multiple` - Collection field\n* `Percentage` - Comparable field\n* `Text` - String field, Comparable field\n* `Duration` - Comparable field\n* `CalculatedNumeric` - Calculated comparable field\n* `Date` - Comparable field\n* `CalculatedDate` - Calculated comparable field\n* `Numeric` - Comparable field\n* `Contacts` - Collection field\n* `Checkbox` - Boolean field\n* `Currency` - Comparable field\n* `DropDown` - String field, Comparable field\n* `LinkToDatabase` - Link to database field","required":true,"schema":{"$ref":"#/components/schemas/CustomFieldType"}},{"name":"spaceId","in":"query","description":"Custom field space ID","required":false,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"sharing","in":"query","description":"Custom field access settings","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldSharing"}}}},{"name":"shareds","in":"query","description":"Users to share custom field with. Parameter is obsolete, use 'sharing' instead","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Users to share custom field with. Parameter is obsolete, use 'sharing' instead","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"settings","in":"query","description":"Custom field settings","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldSettingsParam"}}}},{"name":"description","in":"query","description":"Custom field description","required":false,"schema":{"type":"string","description":"Custom field description"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldDescription"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/customfields/{customfieldIds}":{"get":{"tags":["Custom Fields"],"summary":"Get Custom Fields By ID","description":"Returns complete information about specified custom fields.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/customfields/multi","parameters":[{"name":"customfieldIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/CustomFieldId"}}}}},{"name":"applicableEntityTypes","in":"query","description":"Applicable entity types\n* `User`\n* `WorkItem`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Applicable entity types","items":{"$ref":"#/components/schemas/CustomFieldApplicableEntityType"},"default":"WorkItem"}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `dataUsageStatistics` - Return collection of data usage statistics","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["dataUsageStatistics"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldDescription"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/spaces/{spaceId}/customfields":{"get":{"tags":["Custom Fields"],"summary":"Get Custom Fields (Space)","description":"Returns a list of custom fields for a specific space in the current account.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/spaces/single/customfields","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"applicableEntityTypes","in":"query","description":"Applicable entity types\n* `User`\n* `WorkItem`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Applicable entity types","items":{"$ref":"#/components/schemas/CustomFieldApplicableEntityType"},"default":"WorkItem"}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `dataUsageStatistics` - Return collection of data usage statistics","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["dataUsageStatistics"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldDescription"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/customfields/{customfieldId}":{"put":{"tags":["Custom Fields"],"summary":"Modify Custom Field","description":"Modify custom field.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/customfields/single","parameters":[{"name":"customfieldId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CustomFieldId"}},{"name":"title","in":"query","description":"Custom field title","required":false,"schema":{"type":"string","description":"Custom field title"}},{"name":"type","in":"query","description":"Custom field type. Conversion from any type of field to LinkToDatabase is not supported\n* `Multiple` - Collection field\n* `Percentage` - Comparable field\n* `Text` - String field, Comparable field\n* `Duration` - Comparable field\n* `CalculatedNumeric` - Calculated comparable field\n* `Date` - Comparable field\n* `CalculatedDate` - Calculated comparable field\n* `Numeric` - Comparable field\n* `Contacts` - Collection field\n* `Checkbox` - Boolean field\n* `Currency` - Comparable field\n* `DropDown` - String field, Comparable field\n* `LinkToDatabase` - Link to database field","required":false,"schema":{"$ref":"#/components/schemas/CustomFieldType"}},{"name":"changeScope","in":"query","description":"Custom field scope\n* `Space` - Use it with valid 'spaceId' parameter to move custom field to space level\n* `Account` - Use it with null 'spaceId' parameter to move custom field to account level","required":false,"schema":{"$ref":"#/components/schemas/CustomFieldScope"}},{"name":"spaceId","in":"query","description":"Custom field space ID","required":false,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"sharing","in":"query","description":"Custom field access settings","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldSharing"}}}},{"name":"addShareds","in":"query","description":"Share custom field with specified users. Parameter is obsolete, use 'sharing' instead","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Share custom field with specified users. Parameter is obsolete, use 'sharing' instead","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"removeShareds","in":"query","description":"Unshare custom field from specified users. Parameter is obsolete, use 'sharing' instead","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Unshare custom field from specified users. Parameter is obsolete, use 'sharing' instead","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"settings","in":"query","description":"Custom field type settings","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldSettingsParam"}}}},{"name":"addMirrors","in":"query","description":"Add mirror fields to LinkToDatabase field","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add mirror fields to LinkToDatabase field","items":{"$ref":"#/components/schemas/CustomFieldLinkToDatabaseMirrorFieldParam"}}}}},{"name":"removeMirrors","in":"query","description":"Remove mirror fields from to LinkToDatabase field","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove mirror fields from to LinkToDatabase field","items":{"$ref":"#/components/schemas/CustomFieldId"}}}}},{"name":"description","in":"query","description":"Custom field description","required":false,"schema":{"type":"string","description":"Custom field description"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldDescription"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/custom_item_types":{"get":{"tags":["Custom Item Types"],"summary":"Query All Custom Item Types","description":"Returns all custom item types that belong to the whole account.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/custom_item_types/empty","parameters":[{"name":"title","in":"query","description":"Filter search results by title","required":false,"schema":{"type":"string","description":"Filter search results by title"}},{"name":"limit","in":"query","description":"Result entries limit","required":false,"schema":{"type":"number","description":"Result entries limit","default":"10000"}},{"name":"withDeleted","in":"query","description":"Include deleted custom item types in the result","required":false,"schema":{"type":"boolean","description":"Include deleted custom item types in the result","default":"false"}},{"name":"type","in":"query","description":"Related type of returned custom item types\n* `Project` - Project based\n* `Task` - Task based","required":false,"schema":{"type":"string","enum":["Project","Task"]}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `dataUsageStatistics` - Return collection of data usage statistics","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["dataUsageStatistics"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomItemType"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/spaces/{spaceId}/custom_item_types":{"get":{"tags":["Custom Item Types"],"summary":"Query All Custom Item Types","description":"Returns all custom item types that belong to the specific space.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/spaces/single/custom_item_types","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"title","in":"query","description":"Filter search results by title","required":false,"schema":{"type":"string","description":"Filter search results by title"}},{"name":"limit","in":"query","description":"Result entries limit","required":false,"schema":{"type":"number","description":"Result entries limit","default":"10000"}},{"name":"withDeleted","in":"query","description":"Include deleted custom item types in the result","required":false,"schema":{"type":"boolean","description":"Include deleted custom item types in the result","default":"false"}},{"name":"type","in":"query","description":"Related type of returned custom item types\n* `Project` - Project based\n* `Task` - Task based","required":false,"schema":{"type":"string","enum":["Project","Task"]}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `dataUsageStatistics` - Return collection of data usage statistics","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["dataUsageStatistics"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomItemType"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/custom_item_types/{customItemTypeIds}":{"get":{"tags":["Custom Item Types"],"summary":"Query Specific Custom Item Type by ID","description":"Returns custom item type(s) for specified type ID(s).\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/custom_item_types/multi","parameters":[{"name":"customItemTypeIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/EntityTypeId"}}}}},{"name":"withDeleted","in":"query","description":"Include deleted custom item types in the result","required":false,"schema":{"type":"boolean","description":"Include deleted custom item types in the result","default":"false"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `dataUsageStatistics` - Return collection of data usage statistics","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["dataUsageStatistics"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomItemType"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/custom_item_types/{customItemTypeId}/instantiate":{"post":{"tags":["Custom Item Types"],"summary":"Create Work from Custom Item Type","description":"Create work using the specific custom item type.\n\nScopes: Default, wsReadWrite","operationId":"POST:/custom_item_types/single/instantiate","parameters":[{"name":"customItemTypeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EntityTypeId"}},{"name":"superTaskId","in":"query","description":"ID of parent task. Set this to add work from the task-based custom item type as a subtask. Either this parameter or parentId is required. parentId and superTaskId cannot be set simultaneously.","required":false,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"parentId","in":"query","description":"ID of parent folder or project. Set this to put work from the custom item type to the specific folder or project. Either this parameter or superTaskId is required. parentId and superTaskId cannot be set simultaneously","required":false,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"title","in":"query","description":"Title","required":true,"schema":{"type":"string","description":"Title"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkItemMetadata"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/data_export":{"get":{"tags":["Data Export"],"summary":"Get Data Export","description":"Get last completed Data Export.\n\nScopes: dataExportFull","operationId":"GET:/data_export/empty","responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DataExportOperation"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Data Export"],"summary":"Refresh Data Export","description":"Forces new data export generation (if it is not in progress already). 202 code is returned in case new export generation is started. Data export can be requested no sooner than 1 hour after last successful data export. If there is fresh data export already, 200 code and latest export in format similar to [GET] /data_export is returned.\n\nScopes: dataExportFull","operationId":"POST:/data_export/empty","responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DataExportOperation"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/data_export/{dataExportId}":{"get":{"tags":["Data Export"],"summary":"Get Data Export","description":"Get Data Export specified by id.\n\nScopes: dataExportFull","operationId":"GET:/data_export/single","parameters":[{"name":"dataExportId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/DataExportId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DataExportOperation"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/data_export_schema":{"get":{"tags":["Data export schema"],"summary":"Get Data Export Schema","description":"Get data export schema specified by version.\n\nScopes: dataExportFull","operationId":"GET:/data_export_schema/empty","parameters":[{"name":"version","in":"query","description":"Version\n* `V0`\n* `V1`\n* `V2`\n* `V3`","required":false,"schema":{"$ref":"#/components/schemas/DataExportVersion"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DataExportTableSchema"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/tasks/{taskId}/dependencies":{"get":{"tags":["Dependencies"],"summary":"Get Dependencies (Task)","description":"Get task dependencies.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/tasks/single/dependencies","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Dependency"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Dependencies"],"summary":"Create Dependency","description":"Add dependency between tasks. If a dependency already exists, attempting to recreate will result in an error.\n\nScopes: Default, wsReadWrite","operationId":"POST:/tasks/single/dependencies","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"predecessorId","in":"query","description":"Add predecessor task, only one of predecessorId/successorId fields can be specified","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"successorId","in":"query","description":"Add successor task, only one of predecessorId/successorId fields can be specified","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"relationType","in":"query","description":"Relation between Predecessor and Successor\n* `FinishToFinish` - Finish to finish. Allowed only when predecessor and successor are Planned or Milestone tasks\n* `StartToStart` - Start to start. Allowed only when both predecessor and successor are Planned tasks\n* `StartToFinish` - Start to finish. Allowed only when predecessor is Planned, and successor is Planned or Milestone task\n* `FinishToStart` - Finish to start. Allowed only when predecessor is Planned or Milestone, and successor is Planned task","required":true,"schema":{"$ref":"#/components/schemas/DependencyRelationType"}},{"name":"lagTime","in":"query","description":"Always in minutes, positive numbers are lag time and negative numbers are lead time","required":false,"schema":{"type":"number","description":"Always in minutes, positive numbers are lag time and negative numbers are lead time","default":"0"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Dependency"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/dependencies/{dependencyIds}":{"get":{"tags":["Dependencies"],"summary":"Get Dependencies By ID","description":"Returns complete information about single or multiple dependencies.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/dependencies/multi","parameters":[{"name":"dependencyIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/DependencyId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Dependency"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/dependencies/{dependencyId}":{"put":{"tags":["Dependencies"],"summary":"Modify Dependency","description":"Change relationType of task dependency.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/dependencies/single","parameters":[{"name":"dependencyId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/DependencyId"}},{"name":"relationType","in":"query","description":"Relation between Predecessor and Successor\n* `FinishToFinish` - Finish to finish. Allowed only when predecessor and successor are Planned or Milestone tasks\n* `StartToStart` - Start to start. Allowed only when both predecessor and successor are Planned tasks\n* `StartToFinish` - Start to finish. Allowed only when predecessor is Planned, and successor is Planned or Milestone task\n* `FinishToStart` - Finish to start. Allowed only when predecessor is Planned or Milestone, and successor is Planned task","required":true,"schema":{"$ref":"#/components/schemas/DependencyRelationType"}},{"name":"lagTime","in":"query","description":"Always in minutes, positive numbers are lag time and negative numbers are lead time","required":false,"schema":{"type":"number","description":"Always in minutes, positive numbers are lag time and negative numbers are lead time"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Dependency"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Dependencies"],"summary":"Delete Dependency","description":"Delete dependency between tasks.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/dependencies/single","parameters":[{"name":"dependencyId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/DependencyId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Dependency"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/ediscovery_search":{"post":{"tags":["EDiscovery"],"summary":"eDiscovery Search","description":"Search entities for eDiscovery report.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"POST:/ediscovery_search/empty","parameters":[{"name":"scopes","in":"query","description":"Scopes to limit the result. Limit : `1000`\n* `task`\n* `folder`\n* `attachment`\n* `project`\n* `space`","required":true,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Scopes to limit the result","items":{"$ref":"#/components/schemas/EDiscoveryScope"}}}}},{"name":"terms","in":"query","description":"Terms to search","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Terms to search","items":{"type":"string"}}}}},{"name":"targetUserId","in":"query","description":"User id to limit the result","required":false,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"timeout","in":"query","description":"Maximum approximate duration to handle requests","required":false,"schema":{"type":"string","description":"Maximum approximate duration to handle requests"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"type":"string"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folder_blueprints":{"get":{"tags":["Folder Blueprints"],"summary":"Get Folder Blueprints (Account)","description":"Account-level Folder Blueprints tree.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folder_blueprints/empty","parameters":[{"name":"permalink","in":"query","description":"Folder permalink, exact match","required":false,"schema":{"type":"string","description":"Folder permalink, exact match"}},{"name":"title","in":"query","description":"Title search","required":false,"schema":{"type":"string","description":"Title search"}},{"name":"customFields","in":"query","description":"Custom field filters, exact match. Limit : `25`","required":false,"content":{"application/json":{"schema":{"maxItems":25,"type":"array","description":"Custom field filters, exact match","items":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `customFields` - Custom Fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["customFields"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FolderBlueprint"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/spaces/{spaceId}/folder_blueprints":{"get":{"tags":["Folder Blueprints"],"summary":"Get Folder Blueprints (Space)","description":"Space-level Folder Blueprints tree.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/spaces/single/folder_blueprints","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"permalink","in":"query","description":"Folder permalink, exact match","required":false,"schema":{"type":"string","description":"Folder permalink, exact match"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `customFields` - Custom Fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["customFields"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FolderBlueprint"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folder_blueprints/{folderBlueprintId}/launch_async":{"post":{"tags":["Folder Blueprints"],"summary":"Async Work Creation","description":"Folder Blueprint Launch, returns async job.\n\nScopes: Default, wsReadWrite","operationId":"POST:/folder_blueprints/single/launch_async","parameters":[{"name":"folderBlueprintId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderBlueprintId"}},{"name":"parent","in":"query","description":"ID of parent folder","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"title","in":"query","description":"Title (required)","required":true,"schema":{"type":"string","description":"Title (required)"}},{"name":"titlePrefix","in":"query","description":"Title prefix for all copied tasks","required":false,"schema":{"type":"string","description":"Title prefix for all copied tasks"}},{"name":"copyDescriptions","in":"query","description":"Copy descriptions or leave empty","required":false,"schema":{"type":"boolean","description":"Copy descriptions or leave empty","default":"true"}},{"name":"notifyResponsibles","in":"query","description":"Notify those responsible","required":false,"schema":{"type":"boolean","description":"Notify those responsible","default":"true"}},{"name":"copyResponsibles","in":"query","description":"Copy those responsible","required":false,"schema":{"type":"boolean","description":"Copy those responsible","default":"true"}},{"name":"copyCustomFields","in":"query","description":"Copy custom fields","required":false,"schema":{"type":"boolean","description":"Copy custom fields","default":"true"}},{"name":"copyAttachments","in":"query","description":"Copy attachments","required":false,"schema":{"type":"boolean","description":"Copy attachments","default":"false"}},{"name":"rescheduleDate","in":"query","description":"Date to use in task rescheduling. Note: Only active tasks can be rescheduled. Format: yyyy-MM-dd\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Date to use in task rescheduling. Note: Only active tasks can be rescheduled. Format: yyyy-MM-dd Format: yyyy-MM-dd"}},{"name":"rescheduleMode","in":"query","description":"Mode to be used for rescheduling (based on first or last date). Used only if reschedule date is specified.\n* `Start` - Tasks in scope are rescheduled starting from reschedule date\n* `End` - Tasks in scope are rescheduled ending with reschedule date","required":false,"schema":{"$ref":"#/components/schemas/RescheduleMode"}},{"name":"entryLimit","in":"query","description":"Maximum number of tasks/folders in tree for copy. The operation will fail if limit is exceeded. This should be 1..250","required":false,"schema":{"type":"number","description":"Maximum number of tasks/folders in tree for copy. The operation will fail if limit is exceeded. This should be 1..250","default":"250"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AsyncJob"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders":{"get":{"tags":["Folders & Projects"],"summary":"Get Folders (Account)","description":"Returns a list of folders for the current account. \nThe method operates in two modes: \n
\n
Folder Tree Mode: Activated if no filter parameters are provided. This mode returns the account's\nfolders (spaces), their descendant folders, the root folder, and the recycle bin folder\n(note that \"deleted\" parameter can affect the result, see below).\nFiltering can be requested in this mode using the descendants=true parameter along with filter parameters.\n\n
Folders Mode: Activated if the parameter descendant=false is specified or if there is at least\none filter parameter, e.g., project=true. This mode returns only the account's folders filtered by the\nspecified parameters.\n
\n\nThe chosen mode can be identified by the \"kind\" key in the result JSON body, with \"kind\": \"folderTree\"\nfor Folder Tree Mode and \"kind\": \"folders\" for Folders Mode.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/empty","parameters":[{"name":"permalink","in":"query","description":"Folder permalink, exact match","required":false,"schema":{"type":"string","description":"Folder permalink, exact match"}},{"name":"descendants","in":"query","description":"Adds all descendant folders to search scope","required":false,"schema":{"type":"boolean","description":"Adds all descendant folders to search scope","default":"true"}},{"name":"metadata","in":"query","description":"Folders metadata filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},{"name":"customField","in":"query","description":"[Deprecated] It is recommended to use 'customFields' parameter. Custom field filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}},{"name":"customFields","in":"query","description":"Custom field filters, exact match. Limit : `25`","required":false,"content":{"application/json":{"schema":{"maxItems":25,"type":"array","description":"Custom field filters, exact match","items":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}}},{"name":"updatedDate","in":"query","description":"Updated date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"withInvitations","in":"query","description":"Include invitations in sharedIds list","required":false,"schema":{"type":"boolean","description":"Include invitations in sharedIds list"}},{"name":"project","in":"query","description":"Filter only projects (true) / only folders (false)","required":false,"schema":{"type":"boolean","description":"Filter only projects (true) / only folders (false)"}},{"name":"deleted","in":"query","description":"Get folders from Root (false) / Recycle Bin (true). This parameter does not affect method's mode.","required":false,"schema":{"type":"boolean","description":"Get folders from Root (false) / Recycle Bin (true). This parameter does not affect method's mode."}},{"name":"contractTypes","in":"query","description":"Contract type filter\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Contract type filter","items":{"$ref":"#/components/schemas/ContractType"}}}}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"customItemTypes","in":"query","description":"Custom item types filter. Standard types (project, folder) IDs are not allowed. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Custom item types filter. Standard types (project, folder) IDs are not allowed.","items":{"$ref":"#/components/schemas/EntityTypeId"}}}}},{"name":"pageSize","in":"query","description":"The number of folders to return (max 1000 items per page). Only 'folders' kind is supported","required":false,"schema":{"type":"number","description":"The number of folders to return (max 1000 items per page). Only 'folders' kind is supported"}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call. Only 'folders' kind is supported","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call. Only 'folders' kind is supported"}},{"name":"customStatuses","in":"query","description":"Custom statuses filter","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom statuses filter","items":{"$ref":"#/components/schemas/CustomStatusId"}}}}},{"name":"authors","in":"query","description":"Authors filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Authors filter, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"owners","in":"query","description":"Assignees filter with specified users, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assignees filter with specified users, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"startDate","in":"query","description":"Start date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"endDate","in":"query","description":"End date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"completedDate","in":"query","description":"Completed date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"title","in":"query","description":"Title filter, contains match and accepts non-blank values only","required":false,"schema":{"type":"string","description":"Title filter, contains match and accepts non-blank values only"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `superParentIds` - List of super parent folder IDs (applicable to 'Selective Sharing' labs feature)\n* `metadata` - Folder metadata entries\n* `customItemTypeId` - Work Item custom item type Id\n* `customFields` - Custom fields\n* `customColumnIds` - Associated custom field IDs\n* `contractType` - Contract type\n* `description` - Description\n* `attachmentCount` - Attachment count\n* `hasAttachments` - Has attachments\n* `briefDescription` - Brief description\n* `space` - Is folder a space","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["superParentIds","metadata","customItemTypeId","customFields","customColumnIds","contractType","description","attachmentCount","hasAttachments","briefDescription","space"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Folder"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}/folders":{"get":{"tags":["Folders & Projects"],"summary":"Get Folders (Folder)","description":"Returns the list of folders from a specific folder in the current account. If the root or recycle bin\nfolder id is specified, the method returns the list of folders of the root and recycle bin respectively. \nThe method operates in two modes:\n
\n
Folder Tree Mode: Activated if no filter parameters are provided. This mode returns the requested\nfolders (spaces), their descendant folders, the root folder, and the recycle bin folder.\n\n
Folders Mode: Activated if the parameter descendant=false is specified or if there is at least\none filter parameter, e.g., project=true. This mode returns only the account's folders filtered by the\nspecified parameters.\n
\n\nThe chosen mode can be identified by the \"kind\" key in the result JSON body, with \"kind\": \"folderTree\"\nfor Folder Tree Mode and \"kind\": \"folders\" for Folders Mode.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/single/folders","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"permalink","in":"query","description":"Folder permalink, exact match","required":false,"schema":{"type":"string","description":"Folder permalink, exact match"}},{"name":"descendants","in":"query","description":"Adds all descendant folders to search scope","required":false,"schema":{"type":"boolean","description":"Adds all descendant folders to search scope","default":"true"}},{"name":"metadata","in":"query","description":"Folders metadata filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},{"name":"customField","in":"query","description":"[Deprecated] It is recommended to use 'customFields' parameter. Custom field filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}},{"name":"customFields","in":"query","description":"Custom field filters, exact match. Limit : `25`","required":false,"content":{"application/json":{"schema":{"maxItems":25,"type":"array","description":"Custom field filters, exact match","items":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}}},{"name":"updatedDate","in":"query","description":"Updated date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"withInvitations","in":"query","description":"Include invitations in sharedIds list","required":false,"schema":{"type":"boolean","description":"Include invitations in sharedIds list"}},{"name":"project","in":"query","description":"Filter only projects (true) / only folders (false)","required":false,"schema":{"type":"boolean","description":"Filter only projects (true) / only folders (false)"}},{"name":"contractTypes","in":"query","description":"Contract type filter\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Contract type filter","items":{"$ref":"#/components/schemas/ContractType"}}}}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"customItemTypes","in":"query","description":"Custom item types filter. Standard types (project, folder) IDs are not allowed. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Custom item types filter. Standard types (project, folder) IDs are not allowed.","items":{"$ref":"#/components/schemas/EntityTypeId"}}}}},{"name":"pageSize","in":"query","description":"The number of folders to return (max 1000 items per page). Only 'folders' kind is supported","required":false,"schema":{"type":"number","description":"The number of folders to return (max 1000 items per page). Only 'folders' kind is supported"}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call. Only 'folders' kind is supported","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call. Only 'folders' kind is supported"}},{"name":"customStatuses","in":"query","description":"Custom statuses filter","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom statuses filter","items":{"$ref":"#/components/schemas/CustomStatusId"}}}}},{"name":"authors","in":"query","description":"Authors filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Authors filter, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"owners","in":"query","description":"Assignees filter with specified users, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assignees filter with specified users, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"startDate","in":"query","description":"Start date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"endDate","in":"query","description":"End date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"completedDate","in":"query","description":"Completed date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"title","in":"query","description":"Title filter, contains match and accepts non-blank values only","required":false,"schema":{"type":"string","description":"Title filter, contains match and accepts non-blank values only"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `superParentIds` - List of super parent folder IDs (applicable to 'Selective Sharing' labs feature)\n* `metadata` - Folder metadata entries\n* `customItemTypeId` - Work Item custom item type Id\n* `customFields` - Custom fields\n* `customColumnIds` - Associated custom field IDs\n* `contractType` - Contract type\n* `description` - Description\n* `attachmentCount` - Attachment count\n* `hasAttachments` - Has attachments\n* `briefDescription` - Brief description\n* `space` - Is folder a space\n* `finance` - Project Finance fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["superParentIds","metadata","customItemTypeId","customFields","customColumnIds","contractType","description","attachmentCount","hasAttachments","briefDescription","space","finance"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Folder"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Folders & Projects"],"summary":"Create Folder","description":"Create a folder within a folder. Specify virtual rootFolderId in order to create a folder in the account root.\n\nScopes: Default, wsReadWrite","operationId":"POST:/folders/single/folders","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"title","in":"query","description":"Title, cannot be empty","required":true,"schema":{"type":"string","description":"Title, cannot be empty"}},{"name":"description","in":"query","description":"Folder description. If not specified, will be left blank","required":false,"schema":{"type":"string","description":"Folder description. If not specified, will be left blank"}},{"name":"shareds","in":"query","description":"Users or invited users to share folder with. Folder is always shared with creator","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Users or invited users to share folder with. Folder is always shared with creator","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"metadata","in":"query","description":"Metadata to be added to newly created folder. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Metadata to be added to newly created folder","items":{"$ref":"#/components/schemas/Metadata"}}}}},{"name":"customFields","in":"query","description":"List of custom fields to be set upon task creation. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"List of custom fields to be set upon task creation","items":{"$ref":"#/components/schemas/CustomField"}}}}},{"name":"customColumns","in":"query","description":"List of custom fields associated with folder","required":false,"content":{"application/json":{"schema":{"type":"array","description":"List of custom fields associated with folder","items":{"$ref":"#/components/schemas/CustomFieldId"}}}}},{"name":"project","in":"query","description":"Project settings in order to create project","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderProjectCreateParam"}}}},{"name":"userAccessRoles","in":"query","description":"Access Roles assigned to users with which folder will be shared","required":false,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"withInvitations","in":"query","description":"Include invitations in ownerIds & sharedIds list","required":false,"schema":{"type":"boolean","description":"Include invitations in ownerIds & sharedIds list"}},{"name":"customItemTypeId","in":"query","description":"Custom Item Type ID to create a project from","required":false,"schema":{"$ref":"#/components/schemas/EntityTypeId"}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `customItemTypeId` - Custom Item Type ID\n* `contractType` - Contract type","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["customItemTypeId","contractType"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Folder"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/spaces/{spaceId}/folders":{"get":{"tags":["Folders & Projects"],"summary":"Get Folders (Space)","description":"Returns the list of folders from a specific space in the current account. \nThe method operates in two modes: \n
\n
Folder Tree Mode: Activated if no filter parameters are provided. This mode returns the required\nspace, it's descendant folders, the root folder, and the recycle bin folder (note that \"deleted\" parameter\ncan affect the result, see below).\nFiltering can be requested in this mode using the descendants=true parameter along with filter parameters.\n\n
Folders Mode: Activated if the parameter descendant=false is specified or if there is at least\none filter parameter, e.g., project=true. This mode returns only required space's folders filtered by the\nspecified parameters.\n
\nThe chosen mode can be identified by the \"kind\" key in the result JSON body, with \"kind\": \"folderTree\"\nfor Folder Tree Mode and \"kind\": \"folders\" for Folders Mode.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/spaces/single/folders","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"permalink","in":"query","description":"Folder permalink, exact match","required":false,"schema":{"type":"string","description":"Folder permalink, exact match"}},{"name":"descendants","in":"query","description":"Adds all descendant folders to search scope","required":false,"schema":{"type":"boolean","description":"Adds all descendant folders to search scope","default":"true"}},{"name":"metadata","in":"query","description":"Folders metadata filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},{"name":"customField","in":"query","description":"[Deprecated] It is recommended to use 'customFields' parameter. Custom field filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}},{"name":"customFields","in":"query","description":"Custom field filters, exact match. Limit : `25`","required":false,"content":{"application/json":{"schema":{"maxItems":25,"type":"array","description":"Custom field filters, exact match","items":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}}},{"name":"updatedDate","in":"query","description":"Updated date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"withInvitations","in":"query","description":"Include invitations in sharedIds list","required":false,"schema":{"type":"boolean","description":"Include invitations in sharedIds list"}},{"name":"project","in":"query","description":"Filter only projects (true) / only folders (false)","required":false,"schema":{"type":"boolean","description":"Filter only projects (true) / only folders (false)"}},{"name":"deleted","in":"query","description":"Get folders from Root (false) / Recycle Bin (true). This parameter does not affect method's mode.","required":false,"schema":{"type":"boolean","description":"Get folders from Root (false) / Recycle Bin (true). This parameter does not affect method's mode."}},{"name":"contractTypes","in":"query","description":"Contract type filter\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Contract type filter","items":{"$ref":"#/components/schemas/ContractType"}}}}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"customItemTypes","in":"query","description":"Custom item types filter. Standard types (project, folder) IDs are not allowed. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Custom item types filter. Standard types (project, folder) IDs are not allowed.","items":{"$ref":"#/components/schemas/EntityTypeId"}}}}},{"name":"pageSize","in":"query","description":"The number of folders to return (max 1000 items per page). Only 'folders' kind is supported","required":false,"schema":{"type":"number","description":"The number of folders to return (max 1000 items per page). Only 'folders' kind is supported"}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call. Only 'folders' kind is supported","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call. Only 'folders' kind is supported"}},{"name":"customStatuses","in":"query","description":"Custom statuses filter","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom statuses filter","items":{"$ref":"#/components/schemas/CustomStatusId"}}}}},{"name":"authors","in":"query","description":"Authors filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Authors filter, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"owners","in":"query","description":"Assignees filter with specified users, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assignees filter with specified users, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"startDate","in":"query","description":"Start date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"endDate","in":"query","description":"End date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"completedDate","in":"query","description":"Completed date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"title","in":"query","description":"Title filter, contains match and accepts non-blank values only","required":false,"schema":{"type":"string","description":"Title filter, contains match and accepts non-blank values only"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `superParentIds` - List of super parent folder IDs (applicable to 'Selective Sharing' labs feature)\n* `metadata` - Folder metadata entries\n* `customItemTypeId` - Work Item custom item type Id\n* `customFields` - Custom fields\n* `customColumnIds` - Associated custom field IDs\n* `contractType` - Contract type\n* `description` - Description\n* `attachmentCount` - Attachment count\n* `hasAttachments` - Has attachments\n* `briefDescription` - Brief description\n* `space` - Is folder a space","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["superParentIds","metadata","customItemTypeId","customFields","customColumnIds","contractType","description","attachmentCount","hasAttachments","briefDescription","space"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Folder"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderIds}/folders_history":{"get":{"tags":["Folders & Projects"],"summary":"Query Folders fields history","description":"Query Folders fields history.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/multi/folders_history","parameters":[{"name":"folderIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/FolderId"}}}}},{"name":"updatedDate","in":"query","description":"Update date filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `plannedCost` - Planned cost change history\n* `plannedFees` - Planned fees change history\n* `actualFees` - Actual fees change history\n* `actualCost` - Actual cost change history\n* `budget` - Budget change history","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["plannedCost","plannedFees","actualFees","actualCost","budget"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FolderChangeHistory"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderIds}":{"get":{"tags":["Folders & Projects"],"summary":"Get Folder By ID","description":"Returns complete information about specified folders.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/multi","parameters":[{"name":"folderIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/FolderId"}}}}},{"name":"withInvitations","in":"query","description":"Include invitations in sharedIds list","required":false,"schema":{"type":"boolean","description":"Include invitations in sharedIds list"}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `accessRoles` - Folder Access Roles\n* `customItemTypeId` - Work Item custom item type Id\n* `customColumnIds` - Associated custom field IDs\n* `contractType` - Contract type\n* `attachmentCount` - Attachment count\n* `briefDescription` - Get brief description\n* `finance` - Project Finance fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["accessRoles","customItemTypeId","customColumnIds","contractType","attachmentCount","briefDescription","finance"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Folder"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Folders & Projects"],"summary":"Update Folders (Bulk)","description":"Update folders.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/folders/multi","parameters":[{"name":"folderIds","in":"path","description":"Comma-separated list of ids. Limit : 100","required":true,"content":{"text/csv":{"schema":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/FolderId"}}}}},{"name":"customFields","in":"query","description":"Custom fields to be updated or deleted (null value removes field). Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Custom fields to be updated or deleted (null value removes field)","items":{"$ref":"#/components/schemas/CustomField"}}}}},{"name":"convertToCustomItemType","in":"query","description":"Custom Item Type id","required":false,"schema":{"$ref":"#/components/schemas/EntityTypeId"}},{"name":"project","in":"query","description":"Project settings (update project or convert folder to project). Use null value to convert project to folder","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderProjectUpdateParam"}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `contractType` - Contract type","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["contractType"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Folder"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/copy_folder/{folderId}":{"post":{"tags":["Folders & Projects"],"summary":"Copy Folder","description":"Copy folder subtree, returns parent folder subtree.\n\nScopes: Default, wsReadWrite","operationId":"POST:/copy_folder/single","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"parent","in":"query","description":"ID of parent folder","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"title","in":"query","description":"Title, cannot be empty","required":true,"schema":{"type":"string","description":"Title, cannot be empty"}},{"name":"titlePrefix","in":"query","description":"Title prefix for all copied tasks","required":false,"schema":{"type":"string","description":"Title prefix for all copied tasks"}},{"name":"copyDescriptions","in":"query","description":"Copy descriptions or leave empty","required":false,"schema":{"type":"boolean","description":"Copy descriptions or leave empty","default":"true"}},{"name":"copyResponsibles","in":"query","description":"Copy responsibles","required":false,"schema":{"type":"boolean","description":"Copy responsibles","default":"true"}},{"name":"addResponsibles","in":"query","description":"Add specified users to task responsible list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add specified users to task responsible list","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"removeResponsibles","in":"query","description":"Remove specified users from task responsible list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove specified users from task responsible list","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"copyCustomFields","in":"query","description":"Copy custom fields","required":false,"schema":{"type":"boolean","description":"Copy custom fields","default":"true"}},{"name":"copyCustomStatuses","in":"query","description":"Copy custom statuses or set according to workflow otherwise","required":false,"schema":{"type":"boolean","description":"Copy custom statuses or set according to workflow otherwise","default":"true"}},{"name":"copyStatuses","in":"query","description":"Copy task statuses or set to Active otherwise","required":false,"schema":{"type":"boolean","description":"Copy task statuses or set to Active otherwise","default":"true"}},{"name":"copyParents","in":"query","description":"Preserve parent folders","required":false,"schema":{"type":"boolean","description":"Preserve parent folders","default":"false"}},{"name":"rescheduleDate","in":"query","description":"Date to use in task rescheduling. Note that only active tasks can be rescheduled. To activate and reschedule all tasks, use 'rescheduleDate' in combination with copyStatuses = false\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Date to use in task rescheduling. Note that only active tasks can be rescheduled. To activate and reschedule all tasks, use 'rescheduleDate' in combination with copyStatuses = false Format: yyyy-MM-dd"}},{"name":"rescheduleMode","in":"query","description":"Mode to be used for rescheduling (based on first or last date), has effect only if reschedule date is specified.\n* `Start` - Tasks in scope are rescheduled starting from reschedule date\n* `End` - Tasks in scope are rescheduled ending with reschedule date","required":false,"schema":{"$ref":"#/components/schemas/RescheduleMode"}},{"name":"entryLimit","in":"query","description":"Limit maximum allowed number for tasks/folders in tree for copy, operation will fail if limit is exceeded, should be 1..250","required":false,"schema":{"type":"number","description":"Limit maximum allowed number for tasks/folders in tree for copy, operation will fail if limit is exceeded, should be 1..250","default":"250"}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Folder"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/copy_folder_async/{folderId}":{"post":{"tags":["Folders & Projects"],"summary":"Copy Folder async","description":"Copy folder subtree, returns async job.\n\nScopes: Default, wsReadWrite","operationId":"POST:/copy_folder_async/single","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"parent","in":"query","description":"ID of parent folder","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"title","in":"query","description":"Title, cannot be empty","required":true,"schema":{"type":"string","description":"Title, cannot be empty"}},{"name":"titlePrefix","in":"query","description":"Title prefix for all copied tasks","required":false,"schema":{"type":"string","description":"Title prefix for all copied tasks"}},{"name":"copyDescriptions","in":"query","description":"Copy descriptions or leave empty","required":false,"schema":{"type":"boolean","description":"Copy descriptions or leave empty","default":"true"}},{"name":"copyResponsibles","in":"query","description":"Copy responsibles","required":false,"schema":{"type":"boolean","description":"Copy responsibles","default":"true"}},{"name":"addResponsibles","in":"query","description":"Add specified users to task responsible list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add specified users to task responsible list","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"removeResponsibles","in":"query","description":"Remove specified users from task responsible list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove specified users from task responsible list","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"copyCustomFields","in":"query","description":"Copy custom fields","required":false,"schema":{"type":"boolean","description":"Copy custom fields","default":"true"}},{"name":"copyCustomStatuses","in":"query","description":"Copy custom statuses or set according to workflow otherwise","required":false,"schema":{"type":"boolean","description":"Copy custom statuses or set according to workflow otherwise","default":"true"}},{"name":"copyStatuses","in":"query","description":"Copy task statuses or set to Active otherwise","required":false,"schema":{"type":"boolean","description":"Copy task statuses or set to Active otherwise","default":"true"}},{"name":"copyParents","in":"query","description":"Preserve parent folders","required":false,"schema":{"type":"boolean","description":"Preserve parent folders","default":"false"}},{"name":"rescheduleDate","in":"query","description":"Date to use in task rescheduling. Note that only active tasks can be rescheduled. To activate and reschedule all tasks, use 'rescheduleDate' in combination with copyStatuses = false\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Date to use in task rescheduling. Note that only active tasks can be rescheduled. To activate and reschedule all tasks, use 'rescheduleDate' in combination with copyStatuses = false Format: yyyy-MM-dd"}},{"name":"rescheduleMode","in":"query","description":"Mode to be used for rescheduling (based on first or last date), has effect only if reschedule date is specified.\n* `Start` - Tasks in scope are rescheduled starting from reschedule date\n* `End` - Tasks in scope are rescheduled ending with reschedule date","required":false,"schema":{"$ref":"#/components/schemas/RescheduleMode"}},{"name":"entryLimit","in":"query","description":"Limit maximum allowed number for tasks/folders in tree for copy, operation will fail if limit is exceeded, should be 1..250","required":false,"schema":{"type":"number","description":"Limit maximum allowed number for tasks/folders in tree for copy, operation will fail if limit is exceeded, should be 1..250","default":"250"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AsyncJob"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}":{"put":{"tags":["Folders & Projects"],"summary":"Update Folder","description":"Update folder.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/folders/single","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"title","in":"query","description":"Title","required":false,"schema":{"type":"string","description":"Title"}},{"name":"description","in":"query","description":"Folder description","required":false,"schema":{"type":"string","description":"Folder description"}},{"name":"addParents","in":"query","description":"Parent folders from same account to add, cannot contain rootFolderId and recycleBinId","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Parent folders from same account to add, cannot contain rootFolderId and recycleBinId","items":{"$ref":"#/components/schemas/FolderId"}}}}},{"name":"removeParents","in":"query","description":"Parent folders from same account to remove, cannot contain rootFolderId and recycleBinId","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Parent folders from same account to remove, cannot contain rootFolderId and recycleBinId","items":{"$ref":"#/components/schemas/FolderId"}}}}},{"name":"addShareds","in":"query","description":"Share folder with specified users or invitations","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Share folder with specified users or invitations","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"removeShareds","in":"query","description":"Unshare folder from specified users or invitations","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Unshare folder from specified users or invitations","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"metadata","in":"query","description":"Metadata to be updated. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Metadata to be updated","items":{"$ref":"#/components/schemas/Metadata"}}}}},{"name":"restore","in":"query","description":"Restore folder from Recycled Bin","required":false,"schema":{"type":"boolean","description":"Restore folder from Recycled Bin"}},{"name":"customFields","in":"query","description":"Custom fields to be updated or deleted (null value removes field). Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Custom fields to be updated or deleted (null value removes field)","items":{"$ref":"#/components/schemas/CustomField"}}}}},{"name":"customColumns","in":"query","description":"List of custom fields associated with folder","required":false,"content":{"application/json":{"schema":{"type":"array","description":"List of custom fields associated with folder","items":{"$ref":"#/components/schemas/CustomFieldId"}}}}},{"name":"clearCustomColumns","in":"query","description":"Remove all custom fields associated with folder","required":false,"schema":{"type":"boolean","description":"Remove all custom fields associated with folder"}},{"name":"project","in":"query","description":"Project settings (update project or convert folder to project). Use null value to convert project to folder","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderProjectUpdateParam"}}}},{"name":"addAccessRoles","in":"query","description":"Specifies users with Access Roles for folder","required":false,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"removeAccessRoles","in":"query","description":"Specifies users whose Access Roles should be removed","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Specifies users whose Access Roles should be removed","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"withInvitations","in":"query","description":"Include invitations in ownerIds & sharedIds list","required":true,"schema":{"type":"boolean","description":"Include invitations in ownerIds & sharedIds list"}},{"name":"convertToCustomItemType","in":"query","description":"Custom Item Type id","required":false,"schema":{"$ref":"#/components/schemas/EntityTypeId"}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `contractType` - Contract type","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["contractType"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Folder"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Folders & Projects"],"summary":"Delete Folder","description":"Move folder and all descendant folders and tasks to Recycle Bin unless they have parents outside of deletion scope.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/folders/single","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Folder"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/groups/{groupId}":{"get":{"tags":["Groups"],"summary":"Query Groups","description":"Returns complete information about single group.\n\nScopes: amReadOnlyGroup, amReadWriteGroup","operationId":"GET:/groups/single","parameters":[{"name":"groupId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `metadata` - Group metadata entries","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["metadata"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Groups"],"summary":"Modify Groups","description":"Update group by id.\n\nScopes: amReadWriteGroup","operationId":"PUT:/groups/single","parameters":[{"name":"groupId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"title","in":"query","description":"Title of group","required":false,"schema":{"type":"string","description":"Title of group"}},{"name":"addMembers","in":"query","description":"Add specified users to group","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add specified users to group","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"removeMembers","in":"query","description":"Remove specified users from group","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove specified users from group","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"addInvitations","in":"query","description":"Add specified invitations to group","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add specified invitations to group","items":{"$ref":"#/components/schemas/InvitationId"}}}}},{"name":"removeInvitations","in":"query","description":"Remove specified invitations from group","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove specified invitations from group","items":{"$ref":"#/components/schemas/InvitationId"}}}}},{"name":"parent","in":"query","description":"Parent group","required":false,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"avatar","in":"query","description":"Info for group avatar creation","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvatarParam"}}}},{"name":"metadata","in":"query","description":"Metadata to be updated. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Metadata to be updated","items":{"$ref":"#/components/schemas/Metadata"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Groups"],"summary":"Delete Groups","description":"Delete group by Id.\n\nScopes: amReadWriteGroup","operationId":"DELETE:/groups/single","parameters":[{"name":"groupId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"test","in":"query","description":"Check that group can be removed","required":false,"schema":{"type":"boolean","description":"Check that group can be removed"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/groups":{"get":{"tags":["Groups"],"summary":"Query Groups","description":"Returns all groups in the account.\n\nScopes: amReadOnlyGroup, amReadWriteGroup","operationId":"GET:/groups/empty","parameters":[{"name":"metadata","in":"query","description":"Metadata filter, exact match for metadata key or key-value pair","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},{"name":"pageSize","in":"query","description":"Page size","required":false,"schema":{"type":"number","description":"Page size"}},{"name":"pageToken","in":"query","description":"Page token, overrides any other parameters in request","required":false,"schema":{"type":"string","description":"Page token, overrides any other parameters in request"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `metadata` - Group metadata","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["metadata"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Groups"],"summary":"Create Groups","description":"Create group in account.\n\nScopes: amReadWriteGroup","operationId":"POST:/groups/empty","parameters":[{"name":"title","in":"query","description":"Title of group, required","required":true,"schema":{"type":"string","description":"Title of group, required"}},{"name":"members","in":"query","description":"Group users","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Group users","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"parent","in":"query","description":"Parent group","required":false,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"avatar","in":"query","description":"Info for group avatar creation","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvatarParam"}}}},{"name":"metadata","in":"query","description":"Metadata to be added to newly created group. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Metadata to be added to newly created group","items":{"$ref":"#/components/schemas/Metadata"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/groups_bulk":{"put":{"tags":["Groups"],"summary":"Bulk modify groups","description":"Update groups.\n\nScopes: amReadWriteGroup","operationId":"PUT:/groups_bulk/empty","parameters":[{"name":"members","in":"query","description":"Update group members. Limit 20. Limit : `20`","required":true,"content":{"application/json":{"schema":{"maxItems":20,"type":"array","description":"Update group members. Limit 20","items":{"$ref":"#/components/schemas/GroupModifyParam"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/contacts/{contactIds}/hourly_rates":{"get":{"tags":["Hourly rates"],"summary":"Get Budget Rates (Contacts)","description":"Load budget rates for specified contacts.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/contacts/multi/hourly_rates","parameters":[{"name":"contactIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/UserId"},{"$ref":"#/components/schemas/InvitationId"}]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BudgetRatesAggregated"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}/hourly_rates":{"get":{"tags":["Hourly rates"],"summary":"Get Budget Rates (Folder)","description":"Return project hourly rates.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/single/hourly_rates","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BudgetRatesAggregated"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Hourly rates"],"summary":"Update Budget Rates (Folder)","description":"Provision hourly rates to subject (user, placeholder) in specific project. Max 100 items per request.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/folders/single/hourly_rates","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"rates","in":"query","description":"Provision hourly rates to users. Max 100 users per request. Limit : `100`","required":true,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Provision hourly rates to users. Max 100 users per request","items":{"$ref":"#/components/schemas/BudgetRateParam"}}}}},{"name":"enableCalculations","in":"query","description":"Trigger rates recalculation","required":false,"schema":{"type":"boolean","description":"Trigger rates recalculation"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BudgetRatesAggregated"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/placeholders/{placeholderIds}/hourly_rates":{"get":{"tags":["Hourly rates"],"summary":"Get Budget Rates (Placeholders)","description":"Load budget rates for specified placeholders.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/placeholders/multi/hourly_rates","parameters":[{"name":"placeholderIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BudgetRatesAggregated"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/hourly_rates":{"put":{"tags":["Hourly rates"],"summary":"Update Budget Rates (Account)","description":"Provision hourly rates to users and placeholders. Max 100 items per request.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/hourly_rates/empty","parameters":[{"name":"rates","in":"query","description":"Provision hourly rates to users. Max 100 users per request. Limit : `100`","required":true,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Provision hourly rates to users. Max 100 users per request","items":{"$ref":"#/components/schemas/BudgetRateParam"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BudgetRatesAggregated"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}/project_team_members":{"delete":{"tags":["Hourly rates"],"summary":"Exclude team members","description":"Exclude team member from the project. Max 100 items per request.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/folders/single/project_team_members","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"rateSubjects","in":"query","description":"Project team members to remove. Max 100 per request. Limit : `100`","required":true,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Project team members to remove. Max 100 per request","items":{"$ref":"#/components/schemas/UserId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"type":"string"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/contacts/{contactIds}/hourly_rates_provision":{"put":{"tags":["Hourly rates provision"],"summary":"Provision","description":"Provision hourly rates to users. Max 100 users per request.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/contacts/multi/hourly_rates_provision","parameters":[{"name":"contactIds","in":"path","description":"Comma-separated list of ids. Limit : 100","required":true,"content":{"text/csv":{"schema":{"maxItems":100,"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/UserId"},{"$ref":"#/components/schemas/InvitationId"}]}}}}},{"name":"userRates","in":"query","description":"Provision hourly rates to users. Max 100 users per request. Limit : `100`","required":true,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Provision hourly rates to users. Max 100 users per request","items":{"$ref":"#/components/schemas/BudgetRateProvision"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Rates"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/ids":{"get":{"tags":["IDs"],"summary":"Legacy API v2 IDs converter","description":"Convert APIv2 legacy IDs to APIv4 format for specific entity type.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/ids/empty","parameters":[{"name":"type","in":"query","description":"Entity type\n* `ApiV2Task` - API v2 task\n* `ApiV2Attachment` - API v2 attachment\n* `ApiV2Comment` - API v2 comment\n* `ApiV2Folder` - API v2 folder\n* `ApiV2Timelog` - API v2 timelog entry\n* `ApiV2User` - API v2 user or group\n* `ApiV2Account` - API v2 account\n* `ApiV2RequestForm` - API v2 request form","required":true,"schema":{"$ref":"#/components/schemas/IdsType"}},{"name":"ids","in":"query","description":"List of APIv2 legacy IDs. Limit : `1000`","required":true,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"List of APIv2 legacy IDs","items":{"type":"string"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Apiv3Apiv2Id"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/invitations":{"get":{"tags":["Invitations"],"summary":"Query Invitations","description":"Get all invitations for current account.\n\nScopes: amReadOnlyInvitation, amReadWriteInvitation","operationId":"GET:/invitations/empty","responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Invitation"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Invitations"],"summary":"Create Invitation","description":"Create an invitation into the current account.\n\nScopes: amReadWriteInvitation","operationId":"POST:/invitations/empty","parameters":[{"name":"email","in":"query","description":"Create an invitation for current email","required":true,"schema":{"type":"string","description":"Create an invitation for current email"}},{"name":"firstName","in":"query","description":"First name of invited user","required":false,"schema":{"type":"string","description":"First name of invited user"}},{"name":"lastName","in":"query","description":"Last name of invited user","required":false,"schema":{"type":"string","description":"Last name of invited user"}},{"name":"role","in":"query","description":"[Deprecated] It is recommended to use 'userTypeId' parameter instead. Set user role in account. Mutually exclusive with userTypeId param\n* `User`\n* `Collaborator`","required":false,"schema":{"$ref":"#/components/schemas/UserRole"}},{"name":"external","in":"query","description":"[Deprecated] It is recommended to use 'userTypeId' parameter instead. Set external flag for invited user. Flag 'External' can be applied only to the role 'User'. Mutually exclusive with userTypeId param","required":false,"schema":{"type":"boolean","description":"[Deprecated] It is recommended to use 'userTypeId' parameter instead. Set external flag for invited user. Flag 'External' can be applied only to the role 'User'. Mutually exclusive with userTypeId param","default":"false"}},{"name":"subject","in":"query","description":"Custom message subject. Not available for free accounts","required":false,"schema":{"type":"string","description":"Custom message subject. Not available for free accounts"}},{"name":"message","in":"query","description":"Custom message body. Not available for free accounts","required":false,"schema":{"type":"string","description":"Custom message body. Not available for free accounts"}},{"name":"userTypeId","in":"query","description":"Set user type in account. Mutually exclusive with role and external params","required":false,"schema":{"type":"string","description":"Set user type in account. Mutually exclusive with role and external params"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Invitation"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/invitations/{invitationId}":{"put":{"tags":["Invitations"],"summary":"Update Invitation","description":"Update invitation by ID and/or resend invitation.\n\nScopes: amReadWriteInvitation","operationId":"PUT:/invitations/single","parameters":[{"name":"invitationId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/InvitationId"}},{"name":"resend","in":"query","description":"Resend invitation","required":false,"schema":{"type":"boolean","description":"Resend invitation"}},{"name":"role","in":"query","description":"[Deprecated] It is recommended to use 'userTypeId' parameter instead. Change role of user in account for pending invitation. Mutually exclusive with userTypeId param. \n* `User`\n* `Collaborator`","required":false,"schema":{"$ref":"#/components/schemas/UserRole"}},{"name":"external","in":"query","description":"[Deprecated] It is recommended to use 'userTypeId' parameter instead. Change external flag for pending invitation. Flag 'External' can be applied only to the role 'User'. Mutually exclusive with userTypeId param","required":false,"schema":{"type":"boolean","description":"[Deprecated] It is recommended to use 'userTypeId' parameter instead. Change external flag for pending invitation. Flag 'External' can be applied only to the role 'User'. Mutually exclusive with userTypeId param"}},{"name":"userTypeId","in":"query","description":"Change user type of user in account for pending invitation. Mutually exclusive with role and external params","required":false,"schema":{"type":"string","description":"Change user type of user in account for pending invitation. Mutually exclusive with role and external params"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Invitation"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Invitations"],"summary":"Delete Invitation","description":"Delete invitation by ID.\n\nScopes: amReadWriteInvitation","operationId":"DELETE:/invitations/single","parameters":[{"name":"invitationId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/InvitationId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Invitation"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/jobroles":{"get":{"tags":["Job Roles"],"summary":"Get Job Roles (Account)","description":"Returns list of all job roles in account.\n\nScopes: amReadOnlyUser, amReadWriteUser","operationId":"GET:/jobroles/empty","responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/JobRole"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Job Roles"],"summary":"Create Job Role","description":"Create Job Role.\n\nScopes: amReadWriteUser","operationId":"POST:/jobroles/empty","parameters":[{"name":"title","in":"query","description":"Name of Job Role","required":true,"schema":{"type":"string","description":"Name of Job Role"}},{"name":"shortTitle","in":"query","description":"Short name of Job Role","required":false,"schema":{"type":"string","description":"Short name of Job Role"}},{"name":"avatarColor","in":"query","description":"Job Role Avatar color\n* `Purple1` - #BA68C8\n* `Purple2` - #8E24AA\n* `Blue1` - #64B5F6\n* `Pink1` - #F06292\n* `Pink2` - #D81B60\n* `Red1` - #E57373\n* `Red2` - #E53935\n* `Turquoise1` - #4DD0E1\n* `Turquoise2` - #00ACC1\n* `Blue2` - #1E88E5\n* `DarkBlue1` - #7986CB\n* `Green2` - #43A047\n* `DarkBlue2` - #3949AB\n* `Green1` - #81C784\n* `Yellow1` - #FBC02D\n* `Yellow2` - #F9A825\n* `Orange2` - #F57C00\n* `DarkCyan2` - #00897B\n* `Orange1` - #FF9800\n* `DarkCyan1` - #4DB6AC\n* `YellowGreen2` - #AFB42B\n* `YellowGreen1` - #C0CA33","required":false,"schema":{"$ref":"#/components/schemas/UserAvatarColor"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/JobRole"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/jobroles/{jobroleIds}":{"get":{"tags":["Job Roles"],"summary":"Get Job Roles By ID","description":"Get job roles list.\n\nScopes: amReadOnlyUser, amReadWriteUser","operationId":"GET:/jobroles/multi","parameters":[{"name":"jobroleIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/JobRoleId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/JobRole"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/jobroles/{jobroleId}":{"put":{"tags":["Job Roles"],"summary":"Update Job Role","description":"Create Job Role.\n\nScopes: amReadWriteUser","operationId":"PUT:/jobroles/single","parameters":[{"name":"jobroleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/JobRoleId"}},{"name":"title","in":"query","description":"Name of Job Role","required":false,"schema":{"type":"string","description":"Name of Job Role"}},{"name":"shortTitle","in":"query","description":"Short name of Job Role","required":false,"schema":{"type":"string","description":"Short name of Job Role"}},{"name":"avatarColor","in":"query","description":"Job Role Avatar color","required":false,"schema":{"type":"string","description":"Job Role Avatar color"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/JobRole"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Job Roles"],"summary":"Delete Job Role","description":"Delete job role by Id.\n\nScopes: amReadWriteUser","operationId":"DELETE:/jobroles/single","parameters":[{"name":"jobroleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/JobRoleId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/JobRole"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/placeholders":{"get":{"tags":["Placeholders"],"summary":"Get Placeholders (Account)","description":"Returns list of all placeholders in account.\n\nScopes: amReadOnlyUser, amReadWriteUser","operationId":"GET:/placeholders/empty","responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Placeholder"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/placeholders/{placeholderIds}":{"get":{"tags":["Placeholders"],"summary":"Get Placeholders By ID","description":"Get placeholders list.\n\nScopes: amReadOnlyUser, amReadWriteUser","operationId":"GET:/placeholders/multi","parameters":[{"name":"placeholderIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Placeholder"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/request_forms/{requestFormId}/prefill_url":{"post":{"tags":["Request Forms Prefill"],"summary":"Generate prefilled Request Form URL","description":"Generate prefilled request form URL.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"POST:/request_forms/single/prefill_url","parameters":[{"name":"requestFormId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FormId"}},{"name":"formFields","in":"query","description":"Form fields","required":true,"content":{"application/json":{"schema":{"type":"array","description":"Form fields","items":{"$ref":"#/components/schemas/RequestParam"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PrefilledRequestFormUrl"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/request_forms/{requestFormId}/submit":{"post":{"tags":["Request Forms Submit"],"summary":"Submit Request Form","description":"Submit request form.\n\nScopes: Default, wsReadWrite","operationId":"POST:/request_forms/single/submit","parameters":[{"name":"requestFormId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FormId"}},{"name":"formFields","in":"query","description":"Form fields. Mandatory fields must be included.","required":true,"content":{"application/json":{"schema":{"type":"array","description":"Form fields. Mandatory fields must be included.","items":{"$ref":"#/components/schemas/RequestParam"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RequestFormSubmit"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/request_forms":{"get":{"tags":["Request forms"],"summary":"Query Request Forms","description":"Query request forms in account.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/request_forms/empty","parameters":[{"name":"plainTextDescription","in":"query","description":"Get form description as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get form description as plain text, HTML otherwise","default":"false"}},{"name":"limit","in":"query","description":"Limit on number of returned forms","required":false,"schema":{"type":"number","description":"Limit on number of returned forms"}},{"name":"pageSize","in":"query","description":"The number of forms to return (max 100 items per page)","required":false,"schema":{"type":"number","description":"The number of forms to return (max 100 items per page)"}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page.\nThe returned value should be used as an input parameter in the next request.\nParameter pageSize can be omitted in this case.\n","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page.\nThe returned value should be used as an input parameter in the next request.\nParameter pageSize can be omitted in this case.\n"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `dataUsageStatistics` - Return collection of data usage statistics","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["dataUsageStatistics"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RequestForm"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/spaces/{spaceId}/request_forms":{"get":{"tags":["Request forms"],"summary":"Query Request Forms","description":"Query request forms in space.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/spaces/single/request_forms","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"plainTextDescription","in":"query","description":"Get form description as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get form description as plain text, HTML otherwise","default":"false"}},{"name":"limit","in":"query","description":"Limit on number of returned forms","required":false,"schema":{"type":"number","description":"Limit on number of returned forms"}},{"name":"pageSize","in":"query","description":"The number of forms to return (max 100 items per page)","required":false,"schema":{"type":"number","description":"The number of forms to return (max 100 items per page)"}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page.\nThe returned value should be used as an input parameter in the next request.\nParameter pageSize can be omitted in this case.\n","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page.\nThe returned value should be used as an input parameter in the next request.\nParameter pageSize can be omitted in this case.\n"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `dataUsageStatistics` - Return collection of data usage statistics","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["dataUsageStatistics"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RequestForm"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/request_forms/{requestFormId}":{"get":{"tags":["Request forms"],"summary":"Get Request Form by ID","description":"Get request form by ID.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/request_forms/single","parameters":[{"name":"requestFormId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FormId"}},{"name":"plainTextDescription","in":"query","description":"When true, returns description as plain text (line breaks stripped). When false (default), description is plain text with tags for line breaks.","required":false,"schema":{"type":"boolean","description":"When true, returns description as plain text (line breaks stripped). When false (default), description is plain text with tags for line breaks.","default":"false"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `dataUsageStatistics` - Return collection of data usage statistics","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["dataUsageStatistics"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RequestForm"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}/rollups":{"get":{"tags":["Rollups"],"summary":"Get Rollup Settings (Folder)","description":"Get rollup settings for folders. Use descendants=false (default) to query only the specified folders, or descendants=true to include descendant folders.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/single/rollups","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"descendants","in":"query","description":"Adds all descendant folders to search scope","required":false,"schema":{"type":"boolean","description":"Adds all descendant folders to search scope","default":"false"}},{"name":"filter","in":"query","description":"Filter rollup results by field configurations","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollupFilter"}}}},{"name":"pageSize","in":"query","description":"The number of rollup settings to return (max 100 items per page)","required":false,"schema":{"type":"number","description":"The number of rollup settings to return (max 100 items per page)"}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call.","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call."}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RollupSettings"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Rollups"],"summary":"Update Rollup Settings (Folder)","description":"Update folder rollup state.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/folders/single/rollups","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"rollups","in":"query","description":"Rollup settings updates. Limit : `20`","required":true,"content":{"application/json":{"schema":{"maxItems":20,"type":"array","description":"Rollup settings updates","items":{"$ref":"#/components/schemas/ModifyFieldRollupSettings"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RollupSettings"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/tasks/{taskId}/rollups":{"get":{"tags":["Rollups"],"summary":"Get Rollup Settings (Task)","description":"Get rollup settings for tasks.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/tasks/single/rollups","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"filter","in":"query","description":"Filter rollup results by field configurations","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollupFilter"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RollupSettings"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Rollups"],"summary":"Update Rollup Settings (Task)","description":"Update task rollup state.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/tasks/single/rollups","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"rollups","in":"query","description":"Rollup settings updates. Limit : `20`","required":true,"content":{"application/json":{"schema":{"maxItems":20,"type":"array","description":"Rollup settings updates","items":{"$ref":"#/components/schemas/ModifyFieldRollupSettings"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RollupSettings"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/spaces":{"get":{"tags":["Spaces"],"summary":"Get Spaces (Account)","description":"Returns a list of spaces.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/spaces/empty","parameters":[{"name":"withArchived","in":"query","description":"Include archived spaces","required":false,"schema":{"type":"boolean","description":"Include archived spaces","default":"false"}},{"name":"userIsMember","in":"query","description":"Include only spaces where user is member","required":false,"schema":{"type":"boolean","description":"Include only spaces where user is member"}},{"name":"withInvitations","in":"query","description":"Include invitations in space members list","required":false,"schema":{"type":"boolean","description":"Include invitations in space members list","default":"false"}},{"name":"title","in":"query","description":"Title filter, contains match and accepts non-blank values only","required":false,"schema":{"type":"string","description":"Title filter, contains match and accepts non-blank values only"}},{"name":"accessTypes","in":"query","description":"Access type filter\n* `Locked`\n* `Personal`\n* `Private`\n* `Public`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Access type filter","items":{"$ref":"#/components/schemas/SpaceAccessType"}}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `members` - Space members\n* `workScheduleId` - Id of work schedule assigned to space","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["members","workScheduleId"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Space"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Spaces"],"summary":"Create Space","description":"Create a space. Available for all plans except Team.\n\nScopes: Default, wsReadWrite","operationId":"POST:/spaces/empty","parameters":[{"name":"accessType","in":"query","description":"Type of the space\n* `Locked`\n* `Private`\n* `Public`","required":true,"schema":{"type":"string","enum":["Locked","Private","Public"]}},{"name":"title","in":"query","description":"Title of the space","required":true,"schema":{"type":"string","description":"Title of the space"}},{"name":"description","in":"query","description":"Description of the space","required":false,"schema":{"type":"string","description":"Description of the space"}},{"name":"members","in":"query","description":"Space members. More than 1 member with the same ID is not allowed. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Space members. More than 1 member with the same ID is not allowed","items":{"$ref":"#/components/schemas/SpaceMember"}}}}},{"name":"guestRoleId","in":"query","description":"Space guest role. Available only for a public space","required":false,"schema":{"$ref":"#/components/schemas/AccessRoleId"}},{"name":"defaultProjectWorkflowId","in":"query","description":"Set default project workflow for a space","required":false,"schema":{"$ref":"#/components/schemas/WorkflowId"}},{"name":"suggestedProjectWorkflows","in":"query","description":"Suggested project workflows for a space. A workflow can only be included in a request once. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Suggested project workflows for a space. A workflow can only be included in a request once","items":{"$ref":"#/components/schemas/WorkflowId"}}}}},{"name":"defaultTaskWorkflowId","in":"query","description":"Set default task workflow for a space","required":false,"schema":{"$ref":"#/components/schemas/WorkflowId"}},{"name":"suggestedTaskWorkflows","in":"query","description":"Suggested task workflows for a space. A workflow can only be included in a request once","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Suggested task workflows for a space. A workflow can only be included in a request once","items":{"$ref":"#/components/schemas/WorkflowId"}}}}},{"name":"withInvitations","in":"query","description":"Include invitations in space members list","required":false,"schema":{"type":"boolean","description":"Include invitations in space members list","default":"false"}},{"name":"workScheduleId","in":"query","description":"Id of work schedule to assign to space","required":false,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `suggestedTaskWorkflows` - Suggested task workflows for a space\n* `suggestedProjectWorkflows` - Suggested project workflows for a space\n* `members` - Space members\n* `workScheduleId` - Id of work schedule assigned to space","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["suggestedTaskWorkflows","suggestedProjectWorkflows","members","workScheduleId"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Space"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/spaces/{spaceId}":{"get":{"tags":["Spaces"],"summary":"Get Space By ID","description":"Returns info about a space.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/spaces/single","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"withInvitations","in":"query","description":"Include invitations in space members list","required":false,"schema":{"type":"boolean","description":"Include invitations in space members list","default":"false"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `suggestedTaskWorkflows` - Suggested task workflows for a space\n* `suggestedProjectWorkflows` - Suggested project workflows for a space\n* `members` - Space members\n* `workScheduleId` - Id of work schedule assigned to space","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["suggestedTaskWorkflows","suggestedProjectWorkflows","members","workScheduleId"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Space"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Spaces"],"summary":"Update Space","description":"Update a space.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/spaces/single","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"accessType","in":"query","description":"Type of the space\n* `Private`\n* `Public`","required":false,"schema":{"type":"string","enum":["Private","Public"]}},{"name":"title","in":"query","description":"Title of the space","required":false,"schema":{"type":"string","description":"Title of the space"}},{"name":"description","in":"query","description":"Description of the space","required":false,"schema":{"type":"string","description":"Description of the space"}},{"name":"membersAdd","in":"query","description":"Space members to add. A member should be passed only once in request. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Space members to add. A member should be passed only once in request","items":{"$ref":"#/components/schemas/SpaceMember"}}}}},{"name":"membersUpdate","in":"query","description":"Space members to update. A member should be passed only once in request","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Space members to update. A member should be passed only once in request","items":{"$ref":"#/components/schemas/SpaceMember"}}}}},{"name":"membersRemove","in":"query","description":"Space members to remove. A member should be passed only once in request. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Space members to remove. A member should be passed only once in request","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"guestRoleId","in":"query","description":"Space guest role. Available only for a public space","required":false,"schema":{"$ref":"#/components/schemas/AccessRoleId"}},{"name":"defaultProjectWorkflowId","in":"query","description":"Set default project workflow for a space","required":false,"schema":{"$ref":"#/components/schemas/WorkflowId"}},{"name":"suggestedProjectWorkflowsAdd","in":"query","description":"Add workflows to Suggested project workflows. A workflow can only be included in a request once. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Add workflows to Suggested project workflows. A workflow can only be included in a request once","items":{"$ref":"#/components/schemas/WorkflowId"}}}}},{"name":"suggestedProjectWorkflowsRemove","in":"query","description":"Remove workflows from Suggested project workflows. A workflow can only be included in a request once","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove workflows from Suggested project workflows. A workflow can only be included in a request once","items":{"$ref":"#/components/schemas/WorkflowId"}}}}},{"name":"defaultTaskWorkflowId","in":"query","description":"Set default task workflow for a space","required":false,"schema":{"$ref":"#/components/schemas/WorkflowId"}},{"name":"suggestedTaskWorkflowsAdd","in":"query","description":"Add workflows to Suggested task workflows. A workflow can only be included in a request once","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add workflows to Suggested task workflows. A workflow can only be included in a request once","items":{"$ref":"#/components/schemas/WorkflowId"}}}}},{"name":"suggestedTaskWorkflowsRemove","in":"query","description":"Remove workflows from Suggested task workflows. A workflow can only be included in a request once","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove workflows from Suggested task workflows. A workflow can only be included in a request once","items":{"$ref":"#/components/schemas/WorkflowId"}}}}},{"name":"withInvitations","in":"query","description":"Include invitations in space members list","required":false,"schema":{"type":"boolean","description":"Include invitations in space members list","default":"false"}},{"name":"workScheduleId","in":"query","description":"Id of work schedule to assign to space","required":false,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `suggestedTaskWorkflows` - Space task suggested workflows\n* `suggestedProjectWorkflows` - Space project suggested workflows\n* `members` - Space members\n* `workScheduleId` - Id of work schedule assigned to space","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["suggestedTaskWorkflows","suggestedProjectWorkflows","members","workScheduleId"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Space"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Spaces"],"summary":"Delete Space","description":"Delete a space.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/spaces/single","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"type":"string"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/task_blueprints":{"get":{"tags":["Task Blueprints"],"summary":"Get Task Blueprints (Account)","description":"Account-level Task Blueprints.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/task_blueprints/empty","parameters":[{"name":"permalink","in":"query","description":"Task permalink, exact match","required":false,"schema":{"type":"string","description":"Task permalink, exact match"}},{"name":"title","in":"query","description":"Title search","required":false,"schema":{"type":"string","description":"Title search"}},{"name":"limit","in":"query","description":"Limit on number of returned task blueprints. It is ignored if pagination is requested","required":false,"schema":{"type":"number","description":"Limit on number of returned task blueprints. It is ignored if pagination is requested","default":"1000"}},{"name":"pageSize","in":"query","description":"Page size","required":false,"schema":{"type":"number","description":"Page size"}},{"name":"nextPageToken","in":"query","description":"Next page token","required":false,"schema":{"type":"string","description":"Next page token"}},{"name":"customFields","in":"query","description":"Custom field filters, exact match. Limit : `25`","required":false,"content":{"application/json":{"schema":{"maxItems":25,"type":"array","description":"Custom field filters, exact match","items":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `customFields` - Custom Fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["customFields"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskBlueprint"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/spaces/{spaceId}/task_blueprints":{"get":{"tags":["Task Blueprints"],"summary":"Get Task Blueprints (Space)","description":"Space-level Task Blueprints.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/spaces/single/task_blueprints","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"permalink","in":"query","description":"Task permalink, exact match","required":false,"schema":{"type":"string","description":"Task permalink, exact match"}},{"name":"limit","in":"query","description":"Limit on number of returned task blueprints. It is ignored if pagination is requested","required":false,"schema":{"type":"number","description":"Limit on number of returned task blueprints. It is ignored if pagination is requested","default":"1000"}},{"name":"pageSize","in":"query","description":"Page size","required":false,"schema":{"type":"number","description":"Page size"}},{"name":"nextPageToken","in":"query","description":"Next page token","required":false,"schema":{"type":"string","description":"Next page token"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `customFields` - Custom Fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["customFields"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskBlueprint"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/task_blueprints/{taskBlueprintId}/launch_async":{"post":{"tags":["Task Blueprints"],"summary":"Async Work Creation","description":"Task Blueprint Launch, returns async job.\n\nScopes: Default, wsReadWrite","operationId":"POST:/task_blueprints/single/launch_async","parameters":[{"name":"taskBlueprintId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskBlueprintId"}},{"name":"superTaskId","in":"query","description":"ID of parent task. Set this to add work from the task-based template as a subtask. Either this parameter or parentId is required. parentId and superTaskId cannot be set simultaneously.","required":false,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"parentId","in":"query","description":"ID of parent folder or project. Set this to put work from the template to the specific folder or project. Either this parameter or superTaskId is required. parentId and superTaskId cannot be set simultaneously","required":false,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"title","in":"query","description":"Title (required)","required":true,"schema":{"type":"string","description":"Title (required)"}},{"name":"titlePrefix","in":"query","description":"Title prefix for all copied tasks","required":false,"schema":{"type":"string","description":"Title prefix for all copied tasks"}},{"name":"copyDescriptions","in":"query","description":"Copy descriptions or leave empty","required":false,"schema":{"type":"boolean","description":"Copy descriptions or leave empty","default":"true"}},{"name":"notifyResponsibles","in":"query","description":"Notify those responsible","required":false,"schema":{"type":"boolean","description":"Notify those responsible","default":"true"}},{"name":"copyResponsibles","in":"query","description":"Copy those responsible","required":false,"schema":{"type":"boolean","description":"Copy those responsible","default":"true"}},{"name":"copyCustomFields","in":"query","description":"Copy custom fields","required":false,"schema":{"type":"boolean","description":"Copy custom fields","default":"true"}},{"name":"copyAttachments","in":"query","description":"Copy attachments","required":false,"schema":{"type":"boolean","description":"Copy attachments","default":"false"}},{"name":"rescheduleDate","in":"query","description":"Date to use in task rescheduling. Note: Only active tasks can be rescheduled. Format: yyyy-MM-dd\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Date to use in task rescheduling. Note: Only active tasks can be rescheduled. Format: yyyy-MM-dd Format: yyyy-MM-dd"}},{"name":"rescheduleMode","in":"query","description":"Mode to be used for rescheduling (based on first or last date). Used only if reschedule date is specified.\n* `Start` - Tasks in scope are rescheduled starting from reschedule date\n* `End` - Tasks in scope are rescheduled ending with reschedule date","required":false,"schema":{"$ref":"#/components/schemas/RescheduleMode"}},{"name":"entryLimit","in":"query","description":"Maximum number of tasks/folders in tree for copy. The operation will fail if limit is exceeded. This should be 1..250","required":false,"schema":{"type":"number","description":"Maximum number of tasks/folders in tree for copy. The operation will fail if limit is exceeded. This should be 1..250","default":"250"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AsyncJob"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/tasks":{"get":{"tags":["Tasks"],"summary":"Get Tasks (Account)","description":"Search among all tasks in current account.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/tasks/empty","parameters":[{"name":"descendants","in":"query","description":"Adds all descendant folders to search scope. Applicable only for GET/folders/{folderId}/tasks and GET/spaces/{spaceId}/tasks endpoints","required":false,"schema":{"type":"boolean","description":"Adds all descendant folders to search scope. Applicable only for GET/folders/{folderId}/tasks and GET/spaces/{spaceId}/tasks endpoints"}},{"name":"title","in":"query","description":"Title filter, contains match","required":false,"schema":{"type":"string","description":"Title filter, contains match"}},{"name":"status","in":"query","description":"Status filter, match with any of specified constants\n* `Active` - Active\n* `Deferred` - Deferred\n* `Completed` - Completed\n* `Cancelled` - Cancelled","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Status filter, match with any of specified constants","items":{"$ref":"#/components/schemas/TaskStatus"}}}}},{"name":"importance","in":"query","description":"Importance filter, exact match\n* `High`\n* `Low`\n* `Normal`","required":false,"schema":{"$ref":"#/components/schemas/TaskImportance"}},{"name":"startDate","in":"query","description":"Start date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"dueDate","in":"query","description":"Due date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"scheduledDate","in":"query","description":"Scheduled date filter. Both dates should be set in ranged version.\nReturns all tasks that have schedule intersecting with specified interval, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"createdDate","in":"query","description":"Created date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"updatedDate","in":"query","description":"Updated date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"completedDate","in":"query","description":"Completed date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"authors","in":"query","description":"Authors filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Authors filter, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"responsibles","in":"query","description":"Assignees filter with specified users or invitations, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assignees filter with specified users or invitations, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"responsiblePlaceholders","in":"query","description":"Assignee Placeholders filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assignee Placeholders filter, match of any","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}},{"name":"permalink","in":"query","description":"Task permalink, exact match","required":false,"schema":{"type":"string","description":"Task permalink, exact match"}},{"name":"type","in":"query","description":"Task type\n* `Milestone`\n* `Backlog`\n* `Planned`","required":false,"schema":{"$ref":"#/components/schemas/TaskDatesType"}},{"name":"limit","in":"query","description":"Limit on number of returned tasks","required":false,"schema":{"type":"number","description":"Limit on number of returned tasks"}},{"name":"sortField","in":"query","description":"Sort field\n* `Status` - Sort by status\n* `Importance` - Sort by importance\n* `UpdatedDate` - Sort by updated date\n* `CreatedDate` - Sort by created date\n* `Title` - Lexicographic sorting by title\n* `StartFinishInterval` - Sort by start-finish interval\n* `DueDate` - Sort by due date\n* `LastAccessDate` - Sort by last access date\n* `CompletedDate` - Sort by completed date","required":false,"schema":{"type":"string","enum":["Status","Importance","UpdatedDate","CreatedDate","Title","StartFinishInterval","DueDate","LastAccessDate","CompletedDate"]}},{"name":"sortOrder","in":"query","description":"Sort order\n* `Asc` - Ascending sort order\n* `Desc` - Descending sort order","required":false,"schema":{"$ref":"#/components/schemas/SortOrder"}},{"name":"subTasks","in":"query","description":"Adds subtasks to search scope","required":false,"schema":{"type":"boolean","description":"Adds subtasks to search scope"}},{"name":"pageSize","in":"query","description":"The number of tasks to return (max 1000 items per page)","required":false,"schema":{"type":"number","description":"The number of tasks to return (max 1000 items per page)"}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call"}},{"name":"metadata","in":"query","description":"Task metadata filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},{"name":"customField","in":"query","description":"[Deprecated] It is recommended to use 'customFields' parameter. Custom field filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}},{"name":"customFields","in":"query","description":"Custom field filters, exact match","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom field filters, exact match","items":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}}},{"name":"customStatuses","in":"query","description":"Custom statuses filter","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom statuses filter","items":{"$ref":"#/components/schemas/CustomStatusId"}}}}},{"name":"withInvitations","in":"query","description":"Include invitations in sharedIds & responsibleIds lists","required":false,"schema":{"type":"boolean","description":"Include invitations in sharedIds & responsibleIds lists"}},{"name":"billingTypes","in":"query","description":"Timelog billing types filter\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Timelog billing types filter","items":{"$ref":"#/components/schemas/BillingType"}}}}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"customItemTypes","in":"query","description":"Custom item types filter. Standard type (task) ID is not allowed. Filtering by deleted custom item types is not supported. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Custom item types filter. Standard type (task) ID is not allowed. Filtering by deleted custom item types is not supported.","items":{"$ref":"#/components/schemas/EntityTypeId"}}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `metadata` - Task metadata entries\n* `responsibleIds` - List of assignee user IDs\n* `customItemTypeId` - Work Item custom item type Id\n* `customFields` - Custom fields\n* `followerIds` - List of user IDs, who follows task, and the additional flag \"followedByMe\", that indicates if a task is followed by user\n* `parentIds` - List of task parent folder\n* `sharedIds` - List of user IDs, who have task share\n* `description` - Description\n* `superTaskIds` - List of supertask IDs\n* `responsiblePlaceholderIds` - List of placeholder assignee IDs\n* `superParentIds` - List of folder IDs inherited from parent task\n* `dependencyIds` - Dependency IDs\n* `billingType` - Billing type\n* `attachmentCount` - Attachment count\n* `workScheduleId` - Id of work schedule assigned to task\n* `effortAllocation` - Effort Allocation\n* `hasAttachments` - Has attachments\n* `subTaskIds` - List of subtask IDs\n* `recurrent` - Is a task recurrent\n* `authorIds` - Author IDs\n* `briefDescription` - Brief description","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["metadata","responsibleIds","customItemTypeId","customFields","followerIds","parentIds","sharedIds","description","superTaskIds","responsiblePlaceholderIds","superParentIds","dependencyIds","billingType","attachmentCount","workScheduleId","effortAllocation","hasAttachments","subTaskIds","recurrent","authorIds","briefDescription"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}/tasks":{"get":{"tags":["Tasks"],"summary":"Get Tasks (Folder)","description":"Search among tasks in the folder.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/single/tasks","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"descendants","in":"query","description":"Adds all descendant folders to search scope. Applicable only for GET/folders/{folderId}/tasks and GET/spaces/{spaceId}/tasks endpoints","required":false,"schema":{"type":"boolean","description":"Adds all descendant folders to search scope. Applicable only for GET/folders/{folderId}/tasks and GET/spaces/{spaceId}/tasks endpoints"}},{"name":"title","in":"query","description":"Title filter, contains match","required":false,"schema":{"type":"string","description":"Title filter, contains match"}},{"name":"status","in":"query","description":"Status filter, match with any of specified constants\n* `Active` - Active\n* `Deferred` - Deferred\n* `Completed` - Completed\n* `Cancelled` - Cancelled","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Status filter, match with any of specified constants","items":{"$ref":"#/components/schemas/TaskStatus"}}}}},{"name":"importance","in":"query","description":"Importance filter, exact match\n* `High`\n* `Low`\n* `Normal`","required":false,"schema":{"$ref":"#/components/schemas/TaskImportance"}},{"name":"startDate","in":"query","description":"Start date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"dueDate","in":"query","description":"Due date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"scheduledDate","in":"query","description":"Scheduled date filter. Both dates should be set in ranged version.\nReturns all tasks that have schedule intersecting with specified interval, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"createdDate","in":"query","description":"Created date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"updatedDate","in":"query","description":"Updated date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"completedDate","in":"query","description":"Completed date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"authors","in":"query","description":"Authors filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Authors filter, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"responsibles","in":"query","description":"Assignees filter with specified users or invitations, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assignees filter with specified users or invitations, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"responsiblePlaceholders","in":"query","description":"Assignee Placeholders filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assignee Placeholders filter, match of any","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}},{"name":"permalink","in":"query","description":"Task permalink, exact match","required":false,"schema":{"type":"string","description":"Task permalink, exact match"}},{"name":"type","in":"query","description":"Task type\n* `Milestone`\n* `Backlog`\n* `Planned`","required":false,"schema":{"$ref":"#/components/schemas/TaskDatesType"}},{"name":"limit","in":"query","description":"Limit on number of returned tasks","required":false,"schema":{"type":"number","description":"Limit on number of returned tasks"}},{"name":"sortField","in":"query","description":"Sort field\n* `Status` - Sort by status\n* `Importance` - Sort by importance\n* `UpdatedDate` - Sort by updated date\n* `CreatedDate` - Sort by created date\n* `Title` - Lexicographic sorting by title\n* `StartFinishInterval` - Sort by start-finish interval\n* `DueDate` - Sort by due date\n* `LastAccessDate` - Sort by last access date\n* `CompletedDate` - Sort by completed date","required":false,"schema":{"type":"string","enum":["Status","Importance","UpdatedDate","CreatedDate","Title","StartFinishInterval","DueDate","LastAccessDate","CompletedDate"]}},{"name":"sortOrder","in":"query","description":"Sort order\n* `Asc` - Ascending sort order\n* `Desc` - Descending sort order","required":false,"schema":{"$ref":"#/components/schemas/SortOrder"}},{"name":"subTasks","in":"query","description":"Adds subtasks to search scope","required":false,"schema":{"type":"boolean","description":"Adds subtasks to search scope"}},{"name":"pageSize","in":"query","description":"The number of tasks to return (max 1000 items per page)","required":false,"schema":{"type":"number","description":"The number of tasks to return (max 1000 items per page)"}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call"}},{"name":"metadata","in":"query","description":"Task metadata filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},{"name":"customField","in":"query","description":"[Deprecated] It is recommended to use 'customFields' parameter. Custom field filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}},{"name":"customFields","in":"query","description":"Custom field filters, exact match","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom field filters, exact match","items":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}}},{"name":"customStatuses","in":"query","description":"Custom statuses filter","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom statuses filter","items":{"$ref":"#/components/schemas/CustomStatusId"}}}}},{"name":"withInvitations","in":"query","description":"Include invitations in sharedIds & responsibleIds lists","required":false,"schema":{"type":"boolean","description":"Include invitations in sharedIds & responsibleIds lists"}},{"name":"billingTypes","in":"query","description":"Timelog billing types filter\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Timelog billing types filter","items":{"$ref":"#/components/schemas/BillingType"}}}}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"customItemTypes","in":"query","description":"Custom item types filter. Standard type (task) ID is not allowed. Filtering by deleted custom item types is not supported. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Custom item types filter. Standard type (task) ID is not allowed. Filtering by deleted custom item types is not supported.","items":{"$ref":"#/components/schemas/EntityTypeId"}}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `metadata` - Task metadata entries\n* `responsibleIds` - List of assignee user IDs\n* `customItemTypeId` - Work Item custom item type Id\n* `customFields` - Custom fields\n* `followerIds` - List of user IDs, who follows task, and the additional flag \"followedByMe\", that indicates if a task is followed by user\n* `parentIds` - List of task parent folder\n* `sharedIds` - List of user IDs, who have task share\n* `description` - Description\n* `superTaskIds` - List of supertask IDs\n* `responsiblePlaceholderIds` - List of placeholder assignee IDs\n* `superParentIds` - List of folder IDs inherited from parent task\n* `dependencyIds` - Dependency IDs\n* `billingType` - Billing type\n* `attachmentCount` - Attachment count\n* `workScheduleId` - Id of work schedule assigned to task\n* `effortAllocation` - Effort Allocation\n* `hasAttachments` - Has attachments\n* `subTaskIds` - List of subtask IDs\n* `recurrent` - Is a task recurrent\n* `authorIds` - Author IDs\n* `briefDescription` - Brief description\n* `finance` - Task Finance fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["metadata","responsibleIds","customItemTypeId","customFields","followerIds","parentIds","sharedIds","description","superTaskIds","responsiblePlaceholderIds","superParentIds","dependencyIds","billingType","attachmentCount","workScheduleId","effortAllocation","hasAttachments","subTaskIds","recurrent","authorIds","briefDescription","finance"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Tasks"],"summary":"Create Task (Folder)","description":"Create a task in a folder. The folder specified by {folderId} will become the 'parent' folder for the new task. To create a task in the account root, use the Root Folder API ID. When creating a subtask, use the Root API ID as {folderId} and specify the parent task in the 'superTasks' parameter.\n\nScopes: Default, wsReadWrite","operationId":"POST:/folders/single/tasks","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"title","in":"query","description":"Title of task, required","required":true,"schema":{"type":"string","description":"Title of task, required"}},{"name":"description","in":"query","description":"Description of task, will be left blank, if not set","required":false,"schema":{"type":"string","description":"Description of task, will be left blank, if not set"}},{"name":"status","in":"query","description":"Status of task. Not available for the Team plan\n* `Active` - Active\n* `Deferred` - Deferred\n* `Completed` - Completed\n* `Cancelled` - Cancelled","required":false,"schema":{"$ref":"#/components/schemas/TaskStatus"}},{"name":"importance","in":"query","description":"Importance of task\n* `High`\n* `Low`\n* `Normal`","required":false,"schema":{"$ref":"#/components/schemas/TaskImportance"}},{"name":"dates","in":"query","description":"Task dates. If not specified, a backlogged task is created","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDates"}}}},{"name":"shareds","in":"query","description":"Shares task with specified users or invitations. The task is always shared with the author.","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Shares task with specified users or invitations. The task is always shared with the author.","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"parents","in":"query","description":"Parent folders for newly created task. Can not contain recycleBinId","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Parent folders for newly created task. Can not contain recycleBinId","items":{"$ref":"#/components/schemas/FolderId"}}}}},{"name":"responsibles","in":"query","description":"Makes specified users or invitations assignee for the task","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Makes specified users or invitations assignee for the task","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"responsiblePlaceholders","in":"query","description":"Makes specified placeholders assignee for the task","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Makes specified placeholders assignee for the task","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}},{"name":"followers","in":"query","description":"Add specified users to task followers","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add specified users to task followers","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"follow","in":"query","description":"Follow task","required":false,"schema":{"type":"boolean","description":"Follow task"}},{"name":"priorityBefore","in":"query","description":"Put newly created task before specified task in task list","required":false,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"priorityAfter","in":"query","description":"Put newly created task after specified task in task list","required":false,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"superTasks","in":"query","description":"Add the task as subtask to specified tasks","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add the task as subtask to specified tasks","items":{"$ref":"#/components/schemas/TaskId"}}}}},{"name":"metadata","in":"query","description":"Metadata to be added to newly created task. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Metadata to be added to newly created task","items":{"$ref":"#/components/schemas/Metadata"}}}}},{"name":"customFields","in":"query","description":"List of custom fields to set in newly created task. Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"List of custom fields to set in newly created task","items":{"$ref":"#/components/schemas/CustomField"}}}}},{"name":"customStatus","in":"query","description":"Custom status ID","required":false,"schema":{"$ref":"#/components/schemas/CustomStatusId"}},{"name":"effortAllocation","in":"query","description":"Set Task Effort fields: mode, total Effort","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskEffort"}}}},{"name":"billingType","in":"query","description":"Task's timelogs billing type\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"schema":{"$ref":"#/components/schemas/BillingType"}},{"name":"withInvitations","in":"query","description":"Include invitations in sharedIds & responsibleIds lists","required":false,"schema":{"type":"boolean","description":"Include invitations in sharedIds & responsibleIds lists"}},{"name":"customItemTypeId","in":"query","description":"Custom Item Type ID to create a task from","required":false,"schema":{"type":"string","description":"Custom Item Type ID to create a task from"}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"workScheduleId","in":"query","description":"Id of work schedule to assign to task","required":false,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `customItemTypeId` - Custom Item Type ID\n* `billingType` - Billing type\n* `workScheduleId` - Id of work schedule assigned to task\n* `effortAllocation` - Effort Allocation\n* `responsiblePlaceholderIds` - List of placeholder assignee IDs","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["customItemTypeId","billingType","workScheduleId","effortAllocation","responsiblePlaceholderIds"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/spaces/{spaceId}/tasks":{"get":{"tags":["Tasks"],"summary":"Get Tasks (Space)","description":"Search among tasks in space.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/spaces/single/tasks","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"descendants","in":"query","description":"Adds all descendant folders to search scope. Applicable only for GET/folders/{folderId}/tasks and GET/spaces/{spaceId}/tasks endpoints","required":false,"schema":{"type":"boolean","description":"Adds all descendant folders to search scope. Applicable only for GET/folders/{folderId}/tasks and GET/spaces/{spaceId}/tasks endpoints"}},{"name":"title","in":"query","description":"Title filter, contains match","required":false,"schema":{"type":"string","description":"Title filter, contains match"}},{"name":"status","in":"query","description":"Status filter, match with any of specified constants\n* `Active` - Active\n* `Deferred` - Deferred\n* `Completed` - Completed\n* `Cancelled` - Cancelled","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Status filter, match with any of specified constants","items":{"$ref":"#/components/schemas/TaskStatus"}}}}},{"name":"importance","in":"query","description":"Importance filter, exact match\n* `High`\n* `Low`\n* `Normal`","required":false,"schema":{"$ref":"#/components/schemas/TaskImportance"}},{"name":"startDate","in":"query","description":"Start date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"dueDate","in":"query","description":"Due date filter, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"scheduledDate","in":"query","description":"Scheduled date filter. Both dates should be set in ranged version.\nReturns all tasks that have schedule intersecting with specified interval, date match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"createdDate","in":"query","description":"Created date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"updatedDate","in":"query","description":"Updated date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"completedDate","in":"query","description":"Completed date filter, range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"authors","in":"query","description":"Authors filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Authors filter, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"responsibles","in":"query","description":"Assignees filter with specified users or invitations, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assignees filter with specified users or invitations, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"responsiblePlaceholders","in":"query","description":"Assignee Placeholders filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Assignee Placeholders filter, match of any","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}},{"name":"permalink","in":"query","description":"Task permalink, exact match","required":false,"schema":{"type":"string","description":"Task permalink, exact match"}},{"name":"type","in":"query","description":"Task type\n* `Milestone`\n* `Backlog`\n* `Planned`","required":false,"schema":{"$ref":"#/components/schemas/TaskDatesType"}},{"name":"limit","in":"query","description":"Limit on number of returned tasks","required":false,"schema":{"type":"number","description":"Limit on number of returned tasks"}},{"name":"sortField","in":"query","description":"Sort field\n* `Status` - Sort by status\n* `Importance` - Sort by importance\n* `UpdatedDate` - Sort by updated date\n* `CreatedDate` - Sort by created date\n* `Title` - Lexicographic sorting by title\n* `StartFinishInterval` - Sort by start-finish interval\n* `DueDate` - Sort by due date\n* `LastAccessDate` - Sort by last access date\n* `CompletedDate` - Sort by completed date","required":false,"schema":{"type":"string","enum":["Status","Importance","UpdatedDate","CreatedDate","Title","StartFinishInterval","DueDate","LastAccessDate","CompletedDate"]}},{"name":"sortOrder","in":"query","description":"Sort order\n* `Asc` - Ascending sort order\n* `Desc` - Descending sort order","required":false,"schema":{"$ref":"#/components/schemas/SortOrder"}},{"name":"subTasks","in":"query","description":"Adds subtasks to search scope","required":false,"schema":{"type":"boolean","description":"Adds subtasks to search scope"}},{"name":"pageSize","in":"query","description":"The number of tasks to return (max 1000 items per page)","required":false,"schema":{"type":"number","description":"The number of tasks to return (max 1000 items per page)"}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call"}},{"name":"metadata","in":"query","description":"Task metadata filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Metadata"}}}},{"name":"customField","in":"query","description":"[Deprecated] It is recommended to use 'customFields' parameter. Custom field filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}},{"name":"customFields","in":"query","description":"Custom field filters, exact match","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom field filters, exact match","items":{"$ref":"#/components/schemas/CustomFieldFilterParam"}}}}},{"name":"customStatuses","in":"query","description":"Custom statuses filter","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Custom statuses filter","items":{"$ref":"#/components/schemas/CustomStatusId"}}}}},{"name":"withInvitations","in":"query","description":"Include invitations in sharedIds & responsibleIds lists","required":false,"schema":{"type":"boolean","description":"Include invitations in sharedIds & responsibleIds lists"}},{"name":"billingTypes","in":"query","description":"Timelog billing types filter\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Timelog billing types filter","items":{"$ref":"#/components/schemas/BillingType"}}}}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"customItemTypes","in":"query","description":"Custom item types filter. Standard type (task) ID is not allowed. Filtering by deleted custom item types is not supported. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Custom item types filter. Standard type (task) ID is not allowed. Filtering by deleted custom item types is not supported.","items":{"$ref":"#/components/schemas/EntityTypeId"}}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `metadata` - Task metadata entries\n* `responsibleIds` - List of assignee user IDs\n* `customItemTypeId` - Work Item custom item type Id\n* `customFields` - Custom fields\n* `followerIds` - List of user IDs, who follows task, and the additional flag \"followedByMe\", that indicates if a task is followed by user\n* `parentIds` - List of task parent folder\n* `sharedIds` - List of user IDs, who have task share\n* `description` - Description\n* `superTaskIds` - List of supertask IDs\n* `responsiblePlaceholderIds` - List of placeholder assignee IDs\n* `superParentIds` - List of folder IDs inherited from parent task\n* `dependencyIds` - Dependency IDs\n* `billingType` - Billing type\n* `attachmentCount` - Attachment count\n* `workScheduleId` - Id of work schedule assigned to task\n* `effortAllocation` - Effort Allocation\n* `hasAttachments` - Has attachments\n* `subTaskIds` - List of subtask IDs\n* `recurrent` - Is a task recurrent\n* `authorIds` - Author IDs\n* `briefDescription` - Brief description","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["metadata","responsibleIds","customItemTypeId","customFields","followerIds","parentIds","sharedIds","description","superTaskIds","responsiblePlaceholderIds","superParentIds","dependencyIds","billingType","attachmentCount","workScheduleId","effortAllocation","hasAttachments","subTaskIds","recurrent","authorIds","briefDescription"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/tasks/{taskIds}":{"get":{"tags":["Tasks"],"summary":"Get Tasks By IDs","description":"Returns complete information about single or multiple tasks.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/tasks/multi","parameters":[{"name":"taskIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/TaskId"}}}}},{"name":"withInvitations","in":"query","description":"Include invitations in sharedIds & responsibleIds lists","required":false,"schema":{"type":"boolean","description":"Include invitations in sharedIds & responsibleIds lists"}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `customItemTypeId` - Work Item custom item type Id\n* `billingType` - Billing type\n* `attachmentCount` - Attachment count\n* `workScheduleId` - Id of work schedule assigned to task\n* `responsiblePlaceholderIds` - List of placeholder responsible IDs\n* `effortAllocation` - Effort Allocation\n* `recurrent` - Add field to indicate if task is recurrent\n* `finance` - Task Finance fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["customItemTypeId","billingType","attachmentCount","workScheduleId","responsiblePlaceholderIds","effortAllocation","recurrent","finance"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Tasks"],"summary":"Update Tasks (Bulk)","description":"Update tasks.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/tasks/multi","parameters":[{"name":"taskIds","in":"path","description":"Comma-separated list of ids. Limit : 100","required":true,"content":{"text/csv":{"schema":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/TaskId"}}}}},{"name":"customFields","in":"query","description":"Custom fields to be updated or deleted (null value removes field). Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Custom fields to be updated or deleted (null value removes field)","items":{"$ref":"#/components/schemas/CustomField"}}}}},{"name":"effortAllocation","in":"query","description":"Set Task Effort fields: mode, total Effort","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskEffort"}}}},{"name":"setResponsibleAllocation","in":"query","description":"Update responsible allocations","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Update responsible allocations","items":{"$ref":"#/components/schemas/ResponsibleAllocation"}}}}},{"name":"convertToCustomItemType","in":"query","description":"Custom Item Type id","required":false,"schema":{"$ref":"#/components/schemas/EntityTypeId"}},{"name":"addParents","in":"query","description":"Put task into specified folders of same account. Cannot contain RecycleBin folder","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Put task into specified folders of same account. Cannot contain RecycleBin folder","items":{"$ref":"#/components/schemas/FolderId"}}}}},{"name":"removeParents","in":"query","description":"Remove task from specified folders. Can not contain RecycleBin folder","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove task from specified folders. Can not contain RecycleBin folder","items":{"$ref":"#/components/schemas/FolderId"}}}}},{"name":"addResponsibles","in":"query","description":"Add specified users or invitations to assignee list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add specified users or invitations to assignee list","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"removeResponsibles","in":"query","description":"Remove specified users or invitations from assignee list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove specified users or invitations from assignee list","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"addResponsiblePlaceholders","in":"query","description":"Add specified placeholders to placeholder assignee list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add specified placeholders to placeholder assignee list","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}},{"name":"removeResponsiblePlaceholders","in":"query","description":"Remove specified placeholders from placeholder assignee list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove specified placeholders from placeholder assignee list","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}},{"name":"customStatus","in":"query","description":"Custom status ID","required":false,"schema":{"$ref":"#/components/schemas/CustomStatusId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/tasks/{taskIds}/tasks_history":{"get":{"tags":["Tasks"],"summary":"Query Tasks fields history","description":"Query Tasks fields history.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/tasks/multi/tasks_history","parameters":[{"name":"taskIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/TaskId"}}}}},{"name":"updatedDate","in":"query","description":"Update date filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `plannedCost` - Planned cost change history\n* `plannedFees` - Planned fees change history\n* `actualFees` - Actual fees change history\n* `actualCost` - Actual cost change history","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["plannedCost","plannedFees","actualFees","actualCost"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TaskChangeHistory"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/tasks/{taskId}":{"put":{"tags":["Tasks"],"summary":"Update Task","description":"Update task.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/tasks/single","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"title","in":"query","description":"Title of task","required":false,"schema":{"type":"string","description":"Title of task"}},{"name":"description","in":"query","description":"Task Description","required":false,"schema":{"type":"string","description":"Task Description"}},{"name":"status","in":"query","description":"Task status. Not available for the Team plan\n* `Active` - Active\n* `Deferred` - Deferred\n* `Completed` - Completed\n* `Cancelled` - Cancelled","required":false,"schema":{"$ref":"#/components/schemas/TaskStatus"}},{"name":"importance","in":"query","description":"Task importance\n* `High`\n* `Low`\n* `Normal`","required":false,"schema":{"$ref":"#/components/schemas/TaskImportance"}},{"name":"dates","in":"query","description":"Reschedule task and/or change task type","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskDates"}}}},{"name":"addParents","in":"query","description":"Put task into specified folders of same account. Cannot contain RecycleBin folder","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Put task into specified folders of same account. Cannot contain RecycleBin folder","items":{"$ref":"#/components/schemas/FolderId"}}}}},{"name":"removeParents","in":"query","description":"Remove task from specified folders. Can not contain RecycleBin folder","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove task from specified folders. Can not contain RecycleBin folder","items":{"$ref":"#/components/schemas/FolderId"}}}}},{"name":"addShareds","in":"query","description":"Shared task with specified users or invitations","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Shared task with specified users or invitations","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"removeShareds","in":"query","description":"Unshare task from specified users or invitations","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Unshare task from specified users or invitations","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"addResponsibles","in":"query","description":"Add specified users or invitations to assignee list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add specified users or invitations to assignee list","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"removeResponsibles","in":"query","description":"Remove specified users or invitations from assignee list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove specified users or invitations from assignee list","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"addResponsiblePlaceholders","in":"query","description":"Add specified placeholders to placeholder assignee list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add specified placeholders to placeholder assignee list","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}},{"name":"removeResponsiblePlaceholders","in":"query","description":"Remove specified placeholders from placeholder assignee list","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove specified placeholders from placeholder assignee list","items":{"$ref":"#/components/schemas/PlaceholderId"}}}}},{"name":"addFollowers","in":"query","description":"Add specified users to task followers","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add specified users to task followers","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"follow","in":"query","description":"Follow task","required":false,"schema":{"type":"boolean","description":"Follow task"}},{"name":"priorityBefore","in":"query","description":"Put task in task list before specified task","required":false,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"priorityAfter","in":"query","description":"Put task in task list after specified task","required":false,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"addSuperTasks","in":"query","description":"Add the task as subtask to specified tasks","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Add the task as subtask to specified tasks","items":{"$ref":"#/components/schemas/TaskId"}}}}},{"name":"removeSuperTasks","in":"query","description":"Remove the task form specified tasks subtasks","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Remove the task form specified tasks subtasks","items":{"$ref":"#/components/schemas/TaskId"}}}}},{"name":"metadata","in":"query","description":"Metadata to be updated (null value removes entry). Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Metadata to be updated (null value removes entry)","items":{"$ref":"#/components/schemas/Metadata"}}}}},{"name":"customFields","in":"query","description":"Custom fields to be updated or deleted (null value removes field). Limit : `100`","required":false,"content":{"application/json":{"schema":{"maxItems":100,"type":"array","description":"Custom fields to be updated or deleted (null value removes field)","items":{"$ref":"#/components/schemas/CustomField"}}}}},{"name":"customStatus","in":"query","description":"Custom status ID","required":false,"schema":{"$ref":"#/components/schemas/CustomStatusId"}},{"name":"restore","in":"query","description":"Restore task from Recycled Bin","required":false,"schema":{"type":"boolean","description":"Restore task from Recycled Bin"}},{"name":"effortAllocation","in":"query","description":"Set Task Effort fields: mode, total Effort","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskEffort"}}}},{"name":"setResponsibleAllocation","in":"query","description":"Update responsible allocations","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Update responsible allocations","items":{"$ref":"#/components/schemas/ResponsibleAllocation"}}}}},{"name":"billingType","in":"query","description":"Task's timelogs billing type\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"schema":{"$ref":"#/components/schemas/BillingType"}},{"name":"withInvitations","in":"query","description":"Include invitations in sharedIds & responsibleIds lists","required":false,"schema":{"type":"boolean","description":"Include invitations in sharedIds & responsibleIds lists"}},{"name":"convertToCustomItemType","in":"query","description":"Custom Item Type id","required":false,"schema":{"$ref":"#/components/schemas/EntityTypeId"}},{"name":"plainTextCustomFields","in":"query","description":"Strip HTML tags from custom fields","required":false,"schema":{"type":"boolean","description":"Strip HTML tags from custom fields"}},{"name":"workScheduleId","in":"query","description":"Id of work schedule to assign to task","required":false,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `billingType` - Billing type\n* `workScheduleId` - Id of work schedule assigned to task\n* `effortAllocation` - Effort Allocation\n* `responsiblePlaceholderIds` - List of placeholder assignee IDs","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["billingType","workScheduleId","effortAllocation","responsiblePlaceholderIds"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Tasks"],"summary":"Delete Tasks By ID","description":"Delete task by Id.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/tasks/single","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Task"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/timelog_categories":{"get":{"tags":["Timelog categories"],"summary":"Query Timelog categories","description":"Get timelog categories in account.\n\nScopes: Default, amReadOnlyTimelogCategory, amReadWriteTimelogCategory, wsReadOnly, wsReadWrite","operationId":"GET:/timelog_categories/empty","responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimelogCategory"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}/timelog_lock_periods":{"get":{"tags":["Timelog lock periods"],"summary":"Get Timelog Locks (Folder)","description":"Get all timelog lock periods for a folder.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/single/timelog_lock_periods","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"period","in":"query","description":"Dates (from, to, a specific day) for which you want to get lock periods. If no 'period' param was found in the request we will try to find lock periods for 1 year (6 months in the past and 6 months in the future from the current date)","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimelogLockPeriod"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Timelog lock periods"],"summary":"Create Timelog Lock (Folder)","description":"Create timelog lock periods for a folder/project. Important Note: In Response all the active timelog lock periods (within the requested date range) for the corresponding folder/project are returned.\n\nScopes: Default, wsReadWrite","operationId":"POST:/folders/single/timelog_lock_periods","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"period","in":"query","description":"Date range to lock (from, to, or a specific day).","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimelogLockPeriod"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Timelog lock periods"],"summary":"Delete Timelog Lock (Folder)","description":"Delete timelog lock periods for a folder/project. Important Note: In Response all the remaining timelog lock periods (within the requested date range) for the corresponding folder/project are returned. If no other timelog lock periods (within the requested date range) exist response will be empty.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/folders/single/timelog_lock_periods","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"period","in":"query","description":"Date range to unlock (from, to, or a specific day).","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimelogLockPeriod"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/tasks/{taskId}/timelog_lock_periods":{"get":{"tags":["Timelog lock periods"],"summary":"Get Timelog Locks (Task)","description":"Get all timelog lock periods for a task.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/tasks/single/timelog_lock_periods","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"period","in":"query","description":"Dates (from, to, a specific day) for which you want to get lock periods. If no 'period' param was found in the request we will try to find lock periods for 1 year (6 months in the past and 6 months in the future from the current date)","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimelogLockPeriod"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/spaces/{spaceId}/timelog_lock_periods":{"get":{"tags":["Timelog lock periods"],"summary":"Get Timelog Locks (Space)","description":"Get all timelog lock periods for a space.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/spaces/single/timelog_lock_periods","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"period","in":"query","description":"Dates (from, to, a specific day) for which you want to get lock periods. If no 'period' param was found in the request we will try to find lock periods for 1 year (6 months in the past and 6 months in the future from the current date)","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimelogLockPeriod"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Timelog lock periods"],"summary":"Create Timelog Lock (Space)","description":"Create timelog lock periods for a space. Important Note: In Response all the active timelog lock periods (within the requested date range) for the corresponding space are returned.\n\nScopes: Default, wsReadWrite","operationId":"POST:/spaces/single/timelog_lock_periods","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"period","in":"query","description":"Date range to lock (from, to, or a specific day).","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimelogLockPeriod"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Timelog lock periods"],"summary":"Delete Timelog Lock (Space)","description":"Delete timelog lock periods for a space. Important Note: In Response all the remaining timelog lock periods (within the requested date range) for the corresponding space are returned. If no other timelog lock periods (within the requested date range) exist response will be empty.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/spaces/single/timelog_lock_periods","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"period","in":"query","description":"Date range to unlock (from, to, or a specific day).","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimelogLockPeriod"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/timelogs":{"get":{"tags":["Timelogs"],"summary":"Get Timelogs (Account)","description":"Get all timelog records in current account.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/timelogs/empty","parameters":[{"name":"createdDate","in":"query","description":"Created date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"updatedDate","in":"query","description":"Last updated date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"trackedDate","in":"query","description":"Tracked date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"me","in":"query","description":"If present - only timelogs created by current user are returned","required":false,"schema":{"type":"boolean","description":"If present - only timelogs created by current user are returned"}},{"name":"descendants","in":"query","description":"Adds all descendant tasks to search scope","required":false,"schema":{"type":"boolean","description":"Adds all descendant tasks to search scope","default":"true"}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"timelogCategories","in":"query","description":"Get timelog records for specified categories. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Get timelog records for specified categories","items":{"$ref":"#/components/schemas/TimelogCategoryId"}}}}},{"name":"exportStatuses","in":"query","description":"Get timelog records with specified export statuses\n* `NotExported` - Not Exported\n* `Exported` - Exported\n* `ReadyForExport` - Ready For Export","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Get timelog records with specified export statuses","items":{"$ref":"#/components/schemas/TimelogExportStatus"}}}}},{"name":"billingTypes","in":"query","description":"Billing type filter\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Billing type filter","items":{"$ref":"#/components/schemas/BillingType"}}}}},{"name":"approvalStatuses","in":"query","description":"Approval status filter\n* `Draft`\n* `Approved`\n* `Rejected`\n* `Cancelled`\n* `Pending`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Approval status filter","items":{"$ref":"#/components/schemas/ApprovalStatus"}}}}},{"name":"limit","in":"query","description":"Limit on number of returned timelogs","required":false,"schema":{"type":"number","description":"Limit on number of returned timelogs"}},{"name":"pageSize","in":"query","description":"Page size for pagination (1-1000 items per page). When not specified, all matching timelogs are returned in a single response. When specified, results are paginated and nextPageToken is provided for subsequent pages.","required":false,"schema":{"type":"number","description":"Page size for pagination (1-1000 items per page). When not specified, all matching timelogs are returned in a single response. When specified, results are paginated and nextPageToken is provided for subsequent pages."}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case.","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case."}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `approvalStatus` - Timesheet approval status\n* `lockStatus` - Timelog lock status\n* `exportStatus` - Timelog export status field\n* `billingType` - Timelog billing type","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["approvalStatus","lockStatus","exportStatus","billingType"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Timelog"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/contacts/{contactId}/timelogs":{"get":{"tags":["Timelogs"],"summary":"Get Timelogs (User)","description":"Get all timelog records that were created by the user.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/contacts/single/timelogs","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"oneOf":[{"$ref":"#/components/schemas/UserId"},{"$ref":"#/components/schemas/InvitationId"}]}},{"name":"createdDate","in":"query","description":"Created date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"updatedDate","in":"query","description":"Last updated date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"trackedDate","in":"query","description":"Tracked date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"me","in":"query","description":"If present - only timelogs created by current user are returned","required":false,"schema":{"type":"boolean","description":"If present - only timelogs created by current user are returned"}},{"name":"descendants","in":"query","description":"Adds all descendant tasks to search scope","required":false,"schema":{"type":"boolean","description":"Adds all descendant tasks to search scope","default":"true"}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"timelogCategories","in":"query","description":"Get timelog records for specified categories. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Get timelog records for specified categories","items":{"$ref":"#/components/schemas/TimelogCategoryId"}}}}},{"name":"exportStatuses","in":"query","description":"Get timelog records with specified export statuses\n* `NotExported` - Not Exported\n* `Exported` - Exported\n* `ReadyForExport` - Ready For Export","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Get timelog records with specified export statuses","items":{"$ref":"#/components/schemas/TimelogExportStatus"}}}}},{"name":"billingTypes","in":"query","description":"Billing type filter\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Billing type filter","items":{"$ref":"#/components/schemas/BillingType"}}}}},{"name":"approvalStatuses","in":"query","description":"Approval status filter\n* `Draft`\n* `Approved`\n* `Rejected`\n* `Cancelled`\n* `Pending`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Approval status filter","items":{"$ref":"#/components/schemas/ApprovalStatus"}}}}},{"name":"limit","in":"query","description":"Limit on number of returned timelogs","required":false,"schema":{"type":"number","description":"Limit on number of returned timelogs"}},{"name":"pageSize","in":"query","description":"Page size for pagination (1-1000 items per page). When not specified, all matching timelogs are returned in a single response. When specified, results are paginated and nextPageToken is provided for subsequent pages.","required":false,"schema":{"type":"number","description":"Page size for pagination (1-1000 items per page). When not specified, all matching timelogs are returned in a single response. When specified, results are paginated and nextPageToken is provided for subsequent pages."}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case.","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case."}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `approvalStatus` - Timesheet approval status\n* `lockStatus` - Timelog lock status\n* `exportStatus` - Timelog export status field\n* `billingType` - Timelog billing type\n* `finance` - Timelog Finance fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["approvalStatus","lockStatus","exportStatus","billingType","finance"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Timelog"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/folders/{folderId}/timelogs":{"get":{"tags":["Timelogs"],"summary":"Get Timelogs (Folder)","description":"Get all timelog records for a folder.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/folders/single/timelogs","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FolderId"}},{"name":"createdDate","in":"query","description":"Created date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"updatedDate","in":"query","description":"Last updated date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"trackedDate","in":"query","description":"Tracked date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"me","in":"query","description":"If present - only timelogs created by current user are returned","required":false,"schema":{"type":"boolean","description":"If present - only timelogs created by current user are returned"}},{"name":"descendants","in":"query","description":"Adds all descendant tasks to search scope","required":false,"schema":{"type":"boolean","description":"Adds all descendant tasks to search scope","default":"true"}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"timelogCategories","in":"query","description":"Get timelog records for specified categories. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Get timelog records for specified categories","items":{"$ref":"#/components/schemas/TimelogCategoryId"}}}}},{"name":"exportStatuses","in":"query","description":"Get timelog records with specified export statuses\n* `NotExported` - Not Exported\n* `Exported` - Exported\n* `ReadyForExport` - Ready For Export","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Get timelog records with specified export statuses","items":{"$ref":"#/components/schemas/TimelogExportStatus"}}}}},{"name":"billingTypes","in":"query","description":"Billing type filter\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Billing type filter","items":{"$ref":"#/components/schemas/BillingType"}}}}},{"name":"approvalStatuses","in":"query","description":"Approval status filter\n* `Draft`\n* `Approved`\n* `Rejected`\n* `Cancelled`\n* `Pending`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Approval status filter","items":{"$ref":"#/components/schemas/ApprovalStatus"}}}}},{"name":"limit","in":"query","description":"Limit on number of returned timelogs","required":false,"schema":{"type":"number","description":"Limit on number of returned timelogs"}},{"name":"pageSize","in":"query","description":"Page size for pagination (1-1000 items per page). When not specified, all matching timelogs are returned in a single response. When specified, results are paginated and nextPageToken is provided for subsequent pages.","required":false,"schema":{"type":"number","description":"Page size for pagination (1-1000 items per page). When not specified, all matching timelogs are returned in a single response. When specified, results are paginated and nextPageToken is provided for subsequent pages."}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case.","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case."}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `approvalStatus` - Timesheet approval status\n* `lockStatus` - Timelog lock status\n* `exportStatus` - Timelog export status field\n* `billingType` - Timelog billing type\n* `finance` - Timelog Finance fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["approvalStatus","lockStatus","exportStatus","billingType","finance"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Timelog"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/tasks/{taskId}/timelogs":{"get":{"tags":["Timelogs"],"summary":"Get Timelogs (Task)","description":"Get all timelog records for a task.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/tasks/single/timelogs","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"createdDate","in":"query","description":"Created date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"updatedDate","in":"query","description":"Last updated date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"trackedDate","in":"query","description":"Tracked date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"me","in":"query","description":"If present - only timelogs created by current user are returned","required":false,"schema":{"type":"boolean","description":"If present - only timelogs created by current user are returned"}},{"name":"descendants","in":"query","description":"Adds all descendant tasks to search scope","required":false,"schema":{"type":"boolean","description":"Adds all descendant tasks to search scope","default":"true"}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"timelogCategories","in":"query","description":"Get timelog records for specified categories. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Get timelog records for specified categories","items":{"$ref":"#/components/schemas/TimelogCategoryId"}}}}},{"name":"exportStatuses","in":"query","description":"Get timelog records with specified export statuses\n* `NotExported` - Not Exported\n* `Exported` - Exported\n* `ReadyForExport` - Ready For Export","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Get timelog records with specified export statuses","items":{"$ref":"#/components/schemas/TimelogExportStatus"}}}}},{"name":"billingTypes","in":"query","description":"Billing type filter\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Billing type filter","items":{"$ref":"#/components/schemas/BillingType"}}}}},{"name":"approvalStatuses","in":"query","description":"Approval status filter\n* `Draft`\n* `Approved`\n* `Rejected`\n* `Cancelled`\n* `Pending`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Approval status filter","items":{"$ref":"#/components/schemas/ApprovalStatus"}}}}},{"name":"limit","in":"query","description":"Limit on number of returned timelogs","required":false,"schema":{"type":"number","description":"Limit on number of returned timelogs"}},{"name":"pageSize","in":"query","description":"Page size for pagination (1-1000 items per page). When not specified, all matching timelogs are returned in a single response. When specified, results are paginated and nextPageToken is provided for subsequent pages.","required":false,"schema":{"type":"number","description":"Page size for pagination (1-1000 items per page). When not specified, all matching timelogs are returned in a single response. When specified, results are paginated and nextPageToken is provided for subsequent pages."}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case.","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case."}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `approvalStatus` - Timesheet approval status\n* `lockStatus` - Timelog lock status\n* `exportStatus` - Timelog export status field\n* `billingType` - Timelog billing type\n* `finance` - Timelog Finance fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["approvalStatus","lockStatus","exportStatus","billingType","finance"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Timelog"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Timelogs"],"summary":"Create Timelog","description":"Create timelog record for task.\n\nScopes: Default, wsReadWrite","operationId":"POST:/tasks/single/timelogs","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TaskId"}},{"name":"comment","in":"query","description":"Timelog record comment","required":true,"schema":{"type":"string","description":"Timelog record comment"}},{"name":"hours","in":"query","description":"Time to log in hours","required":true,"schema":{"type":"number","description":"Time to log in hours"}},{"name":"trackedDate","in":"query","description":"Date to register time\nFormat: yyyy-MM-dd","required":true,"schema":{"type":"string","description":"Date to register time Format: yyyy-MM-dd"}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"categoryId","in":"query","description":"Timelog category","required":false,"schema":{"$ref":"#/components/schemas/TimelogCategoryId"}},{"name":"onBehalfOf","in":"query","description":"Create a time entry for another user","required":false,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `approvalStatus` - Timesheet approval status\n* `billingType` - Timelog billing type","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["approvalStatus","billingType"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Timelog"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/timelog_categories/{timelogCategoryId}/timelogs":{"get":{"tags":["Timelogs"],"summary":"Get Timelogs (Category)","description":"Get all timelog records with specific timelog category.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/timelog_categories/single/timelogs","parameters":[{"name":"timelogCategoryId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TimelogCategoryId"}},{"name":"createdDate","in":"query","description":"Created date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"updatedDate","in":"query","description":"Last updated date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantRange"}}}},{"name":"trackedDate","in":"query","description":"Tracked date filter, exact match or range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateTimeRange"}}}},{"name":"me","in":"query","description":"If present - only timelogs created by current user are returned","required":false,"schema":{"type":"boolean","description":"If present - only timelogs created by current user are returned"}},{"name":"descendants","in":"query","description":"Adds all descendant tasks to search scope","required":false,"schema":{"type":"boolean","description":"Adds all descendant tasks to search scope","default":"true"}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"timelogCategories","in":"query","description":"Get timelog records for specified categories. Limit : `1000`","required":false,"content":{"application/json":{"schema":{"maxItems":1000,"type":"array","description":"Get timelog records for specified categories","items":{"$ref":"#/components/schemas/TimelogCategoryId"}}}}},{"name":"exportStatuses","in":"query","description":"Get timelog records with specified export statuses\n* `NotExported` - Not Exported\n* `Exported` - Exported\n* `ReadyForExport` - Ready For Export","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Get timelog records with specified export statuses","items":{"$ref":"#/components/schemas/TimelogExportStatus"}}}}},{"name":"billingTypes","in":"query","description":"Billing type filter\n* `Billable` - Billable\n* `NonBillable` - Non-Billable","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Billing type filter","items":{"$ref":"#/components/schemas/BillingType"}}}}},{"name":"approvalStatuses","in":"query","description":"Approval status filter\n* `Draft`\n* `Approved`\n* `Rejected`\n* `Cancelled`\n* `Pending`","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Approval status filter","items":{"$ref":"#/components/schemas/ApprovalStatus"}}}}},{"name":"limit","in":"query","description":"Limit on number of returned timelogs","required":false,"schema":{"type":"number","description":"Limit on number of returned timelogs"}},{"name":"pageSize","in":"query","description":"Page size for pagination (1-1000 items per page). When not specified, all matching timelogs are returned in a single response. When specified, results are paginated and nextPageToken is provided for subsequent pages.","required":false,"schema":{"type":"number","description":"Page size for pagination (1-1000 items per page). When not specified, all matching timelogs are returned in a single response. When specified, results are paginated and nextPageToken is provided for subsequent pages."}},{"name":"nextPageToken","in":"query","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case.","required":false,"schema":{"type":"string","description":"A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case."}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `approvalStatus` - Timesheet approval status\n* `lockStatus` - Timelog lock status\n* `exportStatus` - Timelog export status field\n* `billingType` - Timelog billing type\n* `finance` - Timelog Finance fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["approvalStatus","lockStatus","exportStatus","billingType","finance"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Timelog"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/timelogs/{timelogIds}":{"get":{"tags":["Timelogs"],"summary":"Get Timelogs By ID","description":"Get timelog record by IDs.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/timelogs/multi","parameters":[{"name":"timelogIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/TimelogId"}}}}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `approvalStatus` - Timesheet approval status\n* `lockStatus` - Timelog lock status\n* `exportStatus` - Timelog export status field\n* `billingType` - Timelog billing type\n* `finance` - Timelog Finance fields","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["approvalStatus","lockStatus","exportStatus","billingType","finance"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Timelog"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/timelogs/{timelogId}":{"put":{"tags":["Timelogs"],"summary":"Modify Timelog","description":"Update timelog by Id.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/timelogs/single","parameters":[{"name":"timelogId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TimelogId"}},{"name":"comment","in":"query","description":"Timelog comment","required":false,"schema":{"type":"string","description":"Timelog comment"}},{"name":"hours","in":"query","description":"New timelog tracked hours","required":false,"schema":{"type":"number","description":"New timelog tracked hours"}},{"name":"trackedDate","in":"query","description":"New timelog date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"New timelog date Format: yyyy-MM-dd"}},{"name":"plainText","in":"query","description":"Get comment text as plain text, HTML otherwise","required":false,"schema":{"type":"boolean","description":"Get comment text as plain text, HTML otherwise","default":"false"}},{"name":"categoryId","in":"query","description":"Timelog category","required":false,"schema":{"$ref":"#/components/schemas/TimelogCategoryId"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `approvalStatus` - Timesheet approval status\n* `billingType` - Timelog billing type","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["approvalStatus","billingType"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Timelog"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Timelogs"],"summary":"Delete Timelog","description":"Delete Timelog record by ID.\n\nScopes: Default, wsReadWrite","operationId":"DELETE:/timelogs/single","parameters":[{"name":"timelogId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TimelogId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"type":"string"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/timesheet_rows/{timesheetRowId}":{"put":{"tags":["Timesheet Rows"],"summary":"Update Timesheet Row","description":"Update timesheet row by Id.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/timesheet_rows/single","parameters":[{"name":"timesheetRowId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TimesheetRowId"}},{"name":"categoryId","in":"query","description":"Category ID for the timesheet row","required":false,"schema":{"$ref":"#/components/schemas/TimelogCategoryId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetRowForApiV4"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/timesheet_submission_rules":{"get":{"tags":["Timesheet Submission Rules"],"summary":"Get Timesheet Submission Rules (Account)","description":"List all timesheet submission rules in account.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/timesheet_submission_rules/empty","responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetSubmissionRule"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/workschedules/{workscheduleId}/timesheet_submission_rules":{"get":{"tags":["Timesheet Submission Rules"],"summary":"Get Timesheet Submission Rules (Work Schedule)","description":"Get timesheet submission rule.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/workschedules/single/timesheet_submission_rules","parameters":[{"name":"workscheduleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetSubmissionRule"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Timesheet Submission Rules"],"summary":"Update Timesheet Submission Rules","description":"Update timesheet submission rule.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/workschedules/single/timesheet_submission_rules","parameters":[{"name":"workscheduleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"enabled","in":"query","description":"Switch to toggle on/off timesheet submission rule","required":false,"schema":{"type":"boolean","description":"Switch to toggle on/off timesheet submission rule"}},{"name":"ruleType","in":"query","description":"Type of timesheet submission rule\n* `Hard` - Hard\n* `Soft` - Soft","required":false,"schema":{"$ref":"#/components/schemas/TimesheetSubmissionRuleType"}},{"name":"frequency","in":"query","description":"Frequency for timesheet submission rule\n* `Month` - Week\n* `Week` - Week\n* `Day` - Day","required":false,"schema":{"$ref":"#/components/schemas/TimesheetSubmissionRuleFrequency"}},{"name":"trackExceptionsMode","in":"query","description":"Track exceptions mode for timesheet submission rule\n* `TotalCapacity` - Total Capacity\n* `ActualCapacity` - Actual Capacity","required":false,"schema":{"$ref":"#/components/schemas/TimesheetSubmissionRuleTrackExceptionsMode"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetSubmissionRule"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/timesheets":{"get":{"tags":["Timesheets"],"summary":"Query Timesheets","description":"Retrieves user timesheets.Note: Only timesheets that have been explicitly created—either via the UI or API—will be returned. Unsubmitted timesheets that have never been accessed do not exist in the database and cannot be retrieved. There is no endpoint to query for timesheets that have not yet been created.\n\nScopes: Default, wsReadOnly, wsReadWrite","operationId":"GET:/timesheets/empty","parameters":[{"name":"periodStartDate","in":"query","description":"Returns timesheet for specified start date match or start date range filter","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"userIds","in":"query","description":"UserIds filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"UserIds filter, match of any","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"approvalStatuses","in":"query","description":"Approval statuses filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Approval statuses filter, match of any","items":{"type":"string"}}}}},{"name":"timeframes","in":"query","description":"Timeframes filter, match of any","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Timeframes filter, match of any","items":{"type":"string"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Timesheet"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Timesheets"],"summary":"Create Timesheet","description":"Create Timesheet.\n\nScopes: Default, wsReadWrite","operationId":"POST:/timesheets/empty","parameters":[{"name":"periodStartDate","in":"query","description":"Timesheet period start date range (required)","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"userId","in":"query","description":"UserId for whom to create the timesheet","required":false,"schema":{"$ref":"#/components/schemas/IdAbstract"}},{"name":"taskIds","in":"query","description":"Optional: TaskIds to create new rows","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Optional: TaskIds to create new rows","items":{"$ref":"#/components/schemas/IdAbstract"}}}}},{"name":"timeframe","in":"query","description":"Optional: Timeframe for the timesheet\n* `Monthly`\n* `Weekly`","required":false,"schema":{"$ref":"#/components/schemas/TimeframeType"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Timesheet"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/timesheets/{timesheetId}":{"put":{"tags":["Timesheets"],"summary":"Update Timesheet","description":"Update Timesheet by ID.\n\nScopes: Default, wsReadWrite","operationId":"PUT:/timesheets/single","parameters":[{"name":"timesheetId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/TimesheetPeriodId"}},{"name":"approvalStatus","in":"query","description":"Timesheet approval status\n* `NotSubmitted`\n* `Approved`\n* `Rejected`\n* `Pending`","required":false,"schema":{"$ref":"#/components/schemas/TimesheetApprovalStatus"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Timesheet"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/user_schedule_capacity_change":{"get":{"tags":["User Schedule capacity changes"],"summary":"Get Work Schedule Capacity Changes (User)","description":"Get all capacity changes for given users.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/user_schedule_capacity_change/empty","parameters":[{"name":"userIds","in":"query","description":"User IDs to query","required":true,"schema":{"type":"string","description":"User IDs to query"}},{"name":"dateRange","in":"query","description":"Date range to query","required":true,"schema":{"type":"string","description":"Date range to query"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserScheduleCapacityChange"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/user_schedule_capacity_change/{userScheduleCapacityChangeIds}":{"get":{"tags":["User Schedule capacity changes"],"summary":"Get User Work Schedule Capacity Change by ID","description":"Get user schedule capacity changes by Ids.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/user_schedule_capacity_change/multi","parameters":[{"name":"userScheduleCapacityChangeIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/UserCapacityOverrideId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserScheduleCapacityChange"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/users/{userId}/user_schedule_capacity_change":{"post":{"tags":["User Schedule capacity changes"],"summary":"Create User Schedule Capacity change","description":"Create schedule capacity change for given user.\n\nScopes: amReadWriteWorkSchedule","operationId":"POST:/users/single/user_schedule_capacity_change","parameters":[{"name":"userId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"userId","in":"query","description":"User ID","required":true,"schema":{"type":"string","description":"User ID"}},{"name":"dateRange","in":"query","description":"Date range","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"capacityMinutes","in":"query","description":"Capacity in minutes","required":true,"schema":{"type":"number","description":"Capacity in minutes"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserScheduleCapacityChange"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/user_schedule_capacity_change/{userScheduleCapacityChangeId}":{"put":{"tags":["User Schedule capacity changes"],"summary":"Update User Schedule Capacity change","description":"Update user schedule capacity change.\n\nScopes: amReadWriteWorkSchedule","operationId":"PUT:/user_schedule_capacity_change/single","parameters":[{"name":"userScheduleCapacityChangeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserCapacityOverrideId"}},{"name":"dateRange","in":"query","description":"Date range","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"capacityMinutes","in":"query","description":"Capacity in minutes","required":true,"schema":{"type":"number","description":"Capacity in minutes"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserScheduleCapacityChange"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["User Schedule capacity changes"],"summary":"Delete User Schedule Capacity change","description":"Delete user schedule capacity change.\n\nScopes: amReadWriteWorkSchedule","operationId":"DELETE:/user_schedule_capacity_change/single","parameters":[{"name":"userScheduleCapacityChangeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserCapacityOverrideId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"type":"string"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/user_schedule_exclusions":{"get":{"tags":["User Schedule exceptions"],"summary":"Query User Schedule exception","description":"Get exceptions for given users and date range.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/user_schedule_exclusions/empty","parameters":[{"name":"dateRange","in":"query","description":"Query exceptions for given date range","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"userIds","in":"query","description":"Query exceptions for given user ids. Limit : `100000`","required":false,"content":{"application/json":{"schema":{"maxItems":100000,"type":"array","description":"Query exceptions for given user ids","items":{"$ref":"#/components/schemas/UserId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserScheduleException"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["User Schedule exceptions"],"summary":"Create User Schedule exception","description":"Create new exception for given user.\n\nScopes: amReadWriteWorkSchedule","operationId":"POST:/user_schedule_exclusions/empty","parameters":[{"name":"userId","in":"query","description":"User id to add new exception","required":true,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"fromDate","in":"query","description":"New exception from date\nFormat: yyyy-MM-dd","required":true,"schema":{"type":"string","description":"New exception from date Format: yyyy-MM-dd"}},{"name":"toDate","in":"query","description":"New exception to date\nFormat: yyyy-MM-dd","required":true,"schema":{"type":"string","description":"New exception to date Format: yyyy-MM-dd"}},{"name":"exclusionType","in":"query","description":"Type of new exception\n* `VacationPTO` - Paid vacations\n* `Overtime` - Additional working days\n* `OtherNonWorking` - Other non-working days","required":true,"schema":{"$ref":"#/components/schemas/UserScheduleExclusionType"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserScheduleException"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/user_schedule_exclusions/{userScheduleExclusionId}":{"get":{"tags":["User Schedule exceptions"],"summary":"Query User Schedule exception","description":"Get exception by Id.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/user_schedule_exclusions/single","parameters":[{"name":"userScheduleExclusionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserScheduleExclusionId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserScheduleException"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["User Schedule exceptions"],"summary":"Update User Schedule exception","description":"Update exception for given user.\n\nScopes: amReadWriteWorkSchedule","operationId":"PUT:/user_schedule_exclusions/single","parameters":[{"name":"userScheduleExclusionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserScheduleExclusionId"}},{"name":"fromDate","in":"query","description":"Exception from date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Exception from date Format: yyyy-MM-dd"}},{"name":"toDate","in":"query","description":"Exception to date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Exception to date Format: yyyy-MM-dd"}},{"name":"exclusionType","in":"query","description":"Type of exception\n* `VacationPTO` - Paid vacations\n* `Overtime` - Additional working days\n* `OtherNonWorking` - Other non-working days","required":false,"schema":{"$ref":"#/components/schemas/UserScheduleExclusionType"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserScheduleException"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["User Schedule exceptions"],"summary":"Delete User Schedule exception","description":"Delete exception.\n\nScopes: amReadWriteWorkSchedule","operationId":"DELETE:/user_schedule_exclusions/single","parameters":[{"name":"userScheduleExclusionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserScheduleExclusionId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserScheduleException"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/user_schedule_partial_exclusion":{"get":{"tags":["User Schedule partial exclusions"],"summary":"Query User Schedule partial exceptions","description":"Get all schedule partial day exceptions for given users.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/user_schedule_partial_exclusion/empty","parameters":[{"name":"userIds","in":"query","description":"User IDs to query","required":true,"schema":{"type":"string","description":"User IDs to query"}},{"name":"dateRange","in":"query","description":"Date range to query","required":true,"schema":{"type":"string","description":"Date range to query"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserSchedulePartialExclusion"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["User Schedule partial exclusions"],"summary":"Create User Schedule partial exception","description":"Create user schedule partial day exclusion.\n\nScopes: amReadWriteWorkSchedule","operationId":"POST:/user_schedule_partial_exclusion/empty","parameters":[{"name":"userId","in":"query","description":"User id","required":true,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"dateRange","in":"query","description":"Date range","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"exclusionType","in":"query","description":"Exclusion type\n* `VacationPTO` - Vacation or paid time off\n* `OtherNonWorking` - Other non-working time","required":true,"schema":{"type":"string","enum":["VacationPTO","OtherNonWorking"]}},{"name":"capacityMinutes","in":"query","description":"Capacity minutes","required":true,"schema":{"type":"number","description":"Capacity minutes"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserSchedulePartialExclusion"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/user_schedule_partial_exclusion/{userSchedulePartialExclusionIds}":{"get":{"tags":["User Schedule partial exclusions"],"summary":"Query User Schedule partial exceptions","description":"Get user schedule partial day exceptions by Ids.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/user_schedule_partial_exclusion/multi","parameters":[{"name":"userSchedulePartialExclusionIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/UserCapacityExclusionId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserSchedulePartialExclusion"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/user_schedule_partial_exclusion/{userSchedulePartialExclusionId}":{"put":{"tags":["User Schedule partial exclusions"],"summary":"Update User Schedule partial exception","description":"Update user schedule partial day exclusion.\n\nScopes: amReadWriteWorkSchedule","operationId":"PUT:/user_schedule_partial_exclusion/single","parameters":[{"name":"userSchedulePartialExclusionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserCapacityExclusionId"}},{"name":"dateRange","in":"query","description":"Date range","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"exclusionType","in":"query","description":"Exclusion type\n* `VacationPTO` - Vacation or paid time off\n* `OtherNonWorking` - Other non-working time","required":false,"schema":{"type":"string","enum":["VacationPTO","OtherNonWorking"]}},{"name":"capacityMinutes","in":"query","description":"Capacity minutes","required":true,"schema":{"type":"number","description":"Capacity minutes"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserSchedulePartialExclusion"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["User Schedule partial exclusions"],"summary":"Delete User Schedule partial exception","description":"Delete user schedule partial day exception.\n\nScopes: amReadWriteWorkSchedule","operationId":"DELETE:/user_schedule_partial_exclusion/single","parameters":[{"name":"userSchedulePartialExclusionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserCapacityExclusionId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"type":"string"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/user_types":{"get":{"tags":["User Types"],"summary":"Get User Types","description":"User types.\n\nScopes: amReadOnlyAccessRole","operationId":"GET:/user_types/empty","responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserType"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/users/{userId}":{"get":{"tags":["Users"],"summary":"Query User","description":"Returns information about single user.\n\nScopes: amReadOnlyUser, amReadWriteUser","operationId":"GET:/users/single","parameters":[{"name":"userId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Users"],"summary":"Modify User","description":"Update users by ID (accessible to Admins only).\n\nScopes: amReadWriteUser","operationId":"PUT:/users/single","parameters":[{"name":"userId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/UserId"}},{"name":"profile","in":"query","description":"[Deprecated] It is recommended to use 'userTypeId' parameter instead. Profile to be updated. Mutually exclusive with other params","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserProfileParam"}}}},{"name":"userTypeId","in":"query","description":"Change user type of user in account. Mutually exclusive with other params","required":false,"schema":{"type":"string","description":"Change user type of user in account. Mutually exclusive with other params"}},{"name":"active","in":"query","description":"Activate or deactivate user. Mutually exclusive with other params","required":false,"schema":{"type":"boolean","description":"Activate or deactivate user. Mutually exclusive with other params"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/users/{userIds}":{"put":{"tags":["Users"],"summary":"Modify User","description":"Activate/deactivate users in account by ID (accessible to Admins only).\n\nScopes: amReadWriteUser","operationId":"PUT:/users/multi","parameters":[{"name":"userIds","in":"path","description":"Comma-separated list of ids. Limit : 100","required":true,"content":{"text/csv":{"schema":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"active","in":"query","description":"Activate or deactivate user. Mutually exclusive with other params","required":false,"schema":{"type":"boolean","description":"Activate or deactivate user. Mutually exclusive with other params"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/version":{"get":{"tags":["Version"],"summary":"API Version","description":"Returns current API version info.","operationId":"GET:/version/empty","responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Apiv3Version"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/workschedule_capacity_change/{workscheduleCapacityChangeIds}":{"get":{"tags":["Work Schedule capacity changes"],"summary":"Get Work Schedule Capacity Changes by Change ID","description":"Get capacity changes by Ids.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/workschedule_capacity_change/multi","parameters":[{"name":"workscheduleCapacityChangeIds","in":"path","description":"Comma-separated list of ids. Limit : 1000","required":true,"content":{"text/csv":{"schema":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/WorkScheduleCapacityOverrideId"}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkScheduleCapacityChange"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/workschedules/{workscheduleId}/workschedule_capacity_change":{"get":{"tags":["Work Schedule capacity changes"],"summary":"Get Work Schedule Capacity Changes (Work Schedule)","description":"Get all capacity changes for given schedule.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/workschedules/single/workschedule_capacity_change","parameters":[{"name":"workscheduleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"dateRange","in":"query","description":"Date range to query","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkScheduleCapacityChange"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Work Schedule capacity changes"],"summary":"Create Work Schedule capacity change","description":"Create capacity change for given schedule.\n\nScopes: amReadWriteWorkSchedule","operationId":"POST:/workschedules/single/workschedule_capacity_change","parameters":[{"name":"workscheduleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"dateRange","in":"query","description":"Date range","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"capacityMinutes","in":"query","description":"Capacity in minutes","required":true,"schema":{"type":"number","description":"Capacity in minutes"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkScheduleCapacityChange"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/workschedule_capacity_change/{workscheduleCapacityChangeId}":{"put":{"tags":["Work Schedule capacity changes"],"summary":"Update Work Schedule capacity change","description":"Update capacity change.\n\nScopes: amReadWriteWorkSchedule","operationId":"PUT:/workschedule_capacity_change/single","parameters":[{"name":"workscheduleCapacityChangeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleCapacityOverrideId"}},{"name":"dateRange","in":"query","description":"Date range","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}},{"name":"capacityMinutes","in":"query","description":"Capacity in minutes","required":true,"schema":{"type":"number","description":"Capacity in minutes"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkScheduleCapacityChange"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Work Schedule capacity changes"],"summary":"Delete Work Schedule capacity change","description":"Delete capacity change.\n\nScopes: amReadWriteWorkSchedule","operationId":"DELETE:/workschedule_capacity_change/single","parameters":[{"name":"workscheduleCapacityChangeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleCapacityOverrideId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"type":"string"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/workschedule_exclusions/{workscheduleExclusionId}":{"get":{"tags":["Work Schedule exceptions"],"summary":"Get Work Schedule Exception by ID","description":"Get exception by Id.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/workschedule_exclusions/single","parameters":[{"name":"workscheduleExclusionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleExclusionId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkScheduleException"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Work Schedule exceptions"],"summary":"Update Work Schedule exception","description":"Update exception by Id.\n\nScopes: amReadWriteWorkSchedule","operationId":"PUT:/workschedule_exclusions/single","parameters":[{"name":"workscheduleExclusionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleExclusionId"}},{"name":"fromDate","in":"query","description":"Exception from date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Exception from date Format: yyyy-MM-dd"}},{"name":"toDate","in":"query","description":"Exception to date\nFormat: yyyy-MM-dd","required":false,"schema":{"type":"string","description":"Exception to date Format: yyyy-MM-dd"}},{"name":"exclusionType","in":"query","description":"Type of exception\n* `PublicHolidays` - Non-working days because of public holidays\n* `OtherEvent` - Non-working days because of some company or private event\n* `AdditionalWorkDays` - Additional working days, i.e. during weekends","required":false,"schema":{"$ref":"#/components/schemas/WorkScheduleExclusionType"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkScheduleException"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Work Schedule exceptions"],"summary":"Delete Work Schedule exception","description":"Delete exception by id.\n\nScopes: amReadWriteWorkSchedule","operationId":"DELETE:/workschedule_exclusions/single","parameters":[{"name":"workscheduleExclusionId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleExclusionId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkScheduleException"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/workschedules/{workscheduleId}/workschedule_exclusions":{"get":{"tags":["Work Schedule exceptions"],"summary":"Get Work Schedule Exceptions (Work Schedule)","description":"Get all exceptions for given schedule.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/workschedules/single/workschedule_exclusions","parameters":[{"name":"workscheduleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"dateRange","in":"query","description":"Date range to query exceptions","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalDateRange"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkScheduleException"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Work Schedule exceptions"],"summary":"Create Work Schedule exception","description":"Create exception for given schedule.\n\nScopes: amReadWriteWorkSchedule","operationId":"POST:/workschedules/single/workschedule_exclusions","parameters":[{"name":"workscheduleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"fromDate","in":"query","description":"New exception from date\nFormat: yyyy-MM-dd","required":true,"schema":{"type":"string","description":"New exception from date Format: yyyy-MM-dd"}},{"name":"toDate","in":"query","description":"New exception to date\nFormat: yyyy-MM-dd","required":true,"schema":{"type":"string","description":"New exception to date Format: yyyy-MM-dd"}},{"name":"exclusionType","in":"query","description":"Type of new exception\n* `PublicHolidays` - Non-working days because of public holidays\n* `OtherEvent` - Non-working days because of some company or private event\n* `AdditionalWorkDays` - Additional working days, i.e. during weekends","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleExclusionType"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkScheduleException"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/workschedules":{"get":{"tags":["Work Schedules"],"summary":"Query Work Schedules","description":"Returns list of all work schedules in account.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/workschedules/empty","parameters":[{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `userIds` - Users assigned to WorkSchedule","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["userIds"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkSchedule"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Work Schedules"],"summary":"Create Work Schedule","description":"Create schedule in account.\n\nScopes: amReadWriteWorkSchedule","operationId":"POST:/workschedules/empty","parameters":[{"name":"title","in":"query","description":"Name of schedule","required":true,"schema":{"type":"string","description":"Name of schedule"}},{"name":"workweek","in":"query","description":"Work week: working and non-working days. Limit : `7`","required":true,"content":{"application/json":{"schema":{"maxItems":7,"type":"array","description":"Work week: working and non-working days","items":{"$ref":"#/components/schemas/WorkWeekUpdate"}}}}},{"name":"addUsers","in":"query","description":"User ids to assign to the schedule. Limit : `100000`","required":false,"content":{"application/json":{"schema":{"maxItems":100000,"type":"array","description":"User ids to assign to the schedule","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"capacityMinutes","in":"query","description":"Custom capacity in minutes","required":false,"schema":{"type":"number","description":"Custom capacity in minutes"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `userIds` - Users assigned to WorkSchedule","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["userIds"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkSchedule"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/workschedules/{workscheduleId}":{"get":{"tags":["Work Schedules"],"summary":"Query Work Schedules","description":"Get work schedule by Id.\n\nScopes: amReadOnlyWorkSchedule, amReadWriteWorkSchedule","operationId":"GET:/workschedules/single","parameters":[{"name":"workscheduleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `userIds` - Users assigned to WorkSchedule","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["userIds"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkSchedule"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"put":{"tags":["Work Schedules"],"summary":"Update Work Schedule","description":"Create work schedule in account.\n\nScopes: amReadWriteWorkSchedule","operationId":"PUT:/workschedules/single","parameters":[{"name":"workscheduleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}},{"name":"title","in":"query","description":"Name of work schedule","required":false,"schema":{"type":"string","description":"Name of work schedule"}},{"name":"workweek","in":"query","description":"Work week: working and non-working days. Limit : `7`","required":false,"content":{"application/json":{"schema":{"maxItems":7,"type":"array","description":"Work week: working and non-working days","items":{"$ref":"#/components/schemas/WorkWeekUpdate"}}}}},{"name":"addUsers","in":"query","description":"User ids to assign to the schedule. Limit : `100000`","required":false,"content":{"application/json":{"schema":{"maxItems":100000,"type":"array","description":"User ids to assign to the schedule","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"removeUsers","in":"query","description":"User ids to unassign from the schedule","required":false,"content":{"application/json":{"schema":{"type":"array","description":"User ids to unassign from the schedule","items":{"$ref":"#/components/schemas/UserId"}}}}},{"name":"capacityMinutes","in":"query","description":"Custom capacity in minutes","required":false,"schema":{"type":"number","description":"Custom capacity in minutes"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `userIds` - Users assigned to WorkSchedule","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["userIds"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkSchedule"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"delete":{"tags":["Work Schedules"],"summary":"Delete Work Schedule","description":"Delete work schedule from account.\n\nScopes: amReadWriteWorkSchedule","operationId":"DELETE:/workschedules/single","parameters":[{"name":"workscheduleId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkScheduleId"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkSchedule"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/workflows":{"get":{"tags":["Workflows"],"summary":"Query Workflows","description":"Returns list of workflows with custom statuses. Only account-wide workflows are returned.\n\nScopes: Default, amReadOnlyWorkflow, amReadWriteWorkflow, wsReadOnly, wsReadWrite","operationId":"GET:/workflows/empty","parameters":[{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `dataUsageStatistics` - Return collection of data usage statistics","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["dataUsageStatistics"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Workflow"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]},"post":{"tags":["Workflows"],"summary":"Create Workflow","description":"Create workflow in account.\n\nScopes: amReadWriteWorkflow","operationId":"POST:/workflows/empty","parameters":[{"name":"name","in":"query","description":"Name of workflow, required","required":true,"schema":{"type":"string","description":"Name of workflow, required"}},{"name":"description","in":"query","description":"Description of workflow","required":false,"schema":{"type":"string","description":"Description of workflow"}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Workflow"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/spaces/{spaceId}/workflows":{"get":{"tags":["Workflows"],"summary":"Query Workflows","description":"Returns list of workflows with custom statuses for a specific space.\n\nScopes: Default, amReadOnlyWorkflow, amReadWriteWorkflow, wsReadOnly, wsReadWrite","operationId":"GET:/spaces/single/workflows","parameters":[{"name":"spaceId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/SpaceId"}},{"name":"fields","in":"query","description":"Json string array of optional fields to be included in the response model\n* `dataUsageStatistics` - Return collection of data usage statistics","required":false,"content":{"application/json":{"schema":{"type":"array","description":"Json string array of optional fields to be included in the response model","items":{"type":"string","enum":["dataUsageStatistics"]}}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Workflow"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}},"/workflows/{workflowId}":{"put":{"tags":["Workflows"],"summary":"Modify Workflow","description":"Update workflow or custom statuses.\n\nScopes: amReadWriteWorkflow","operationId":"PUT:/workflows/single","parameters":[{"name":"workflowId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/WorkflowId"}},{"name":"name","in":"query","description":"Name of workflow (128 symbols max)","required":false,"schema":{"type":"string","description":"Name of workflow (128 symbols max)"}},{"name":"description","in":"query","description":"Description of workflow (2000 symbols max)","required":false,"schema":{"type":"string","description":"Description of workflow (2000 symbols max)"}},{"name":"hidden","in":"query","description":"Workflow is hidden","required":false,"schema":{"type":"boolean","description":"Workflow is hidden"}},{"name":"customStatus","in":"query","description":"Custom status","required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomStatusInput"}}}}],"responses":{"2XX":{"description":"success response","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"$ref":"#/components/schemas/ResponseKind"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Workflow"}}}}}}},"4XX":{"description":"client-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"server-side error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"HTTP":[]}]}}},"components":{"schemas":{"CustomStatus":{"required":["standardName","standard","id","name","group","hidden"],"type":"object","properties":{"standard":{"type":"boolean","description":"Defines default custom status (ignored in requests)"},"standardName":{"type":"boolean","description":"Whether status name is default or not"},"color":{"$ref":"#/components/schemas/StatusColor"},"hidden":{"type":"boolean","description":"Custom status is hidden"},"name":{"type":"string","description":"Name (128 symbols max)"},"id":{"$ref":"#/components/schemas/CustomStatusId"},"group":{"$ref":"#/components/schemas/TaskStatus"}},"description":"ID and group cannot be set simultaneously in request parameter,\nbut ID is required for update, and group is required for insert"},"ResponseKind":{"type":"string","enum":["accounts","users","contacts","assets","eDiscoveryReport","folders","folderTree","tasks","taskIds","timelogs","timelogCategories","timelogLockPeriods","timetrackerTimers","comments","attachments","url","version","dataExport","dataExportSchema","auditLog","accessRoles","stream","changes","posts","mailSettings","integrationInfo","gmailIntegrationSettings","workTypesForIntegrations","ids","backups","domains","dependencies","workflows","workschedules","workscheduleExclusions","workscheduleUserExclusions","customfields","customfieldIds","customstatuses","invitations","notifications","jobroles","placeholders","groups","session","dashboards","widgets","taskCreationSettings","colors","experiments","topics","topicComments","webhooks","reviews","boards","textSearch","chatChannels","chatMessages","forms","requestForms","request","report","platformWidgets","platformWidgetInstances","spaces","pdf","customerSatisfaction","asyncJob","approvals","highlights","highlightsList","highlightsSettings","highlightsCard","timesheet","timesheetRow","timesheetSubmissionRule","mobileFeatures","mobileSettings","folderBlueprintTree","taskBlueprintTree","feedback","timeline_snapshot","contactIds","bookings","integrateThreshold","hourlyRatesProvision","hourlyRates","projectTeamMembers","contactsHistory","tasksHistory","foldersHistory","activityDigest","workItemTemplates","workTemplates","workItemMetadata","workItem","customItemTypes","verificationCode","views","listView","tableView","userTypes","reactions","externalRequesters","workscheduleCapacityOverrides","userCapacityOverrides","userCapacityExclusions","rollups","requestFormPrefill"]},"DataExportStatus":{"type":"string","description":"* `Scheduled`\n* `Failed`\n* `Completed`\n* `InProgress`\n* `Cancelled`","enum":["Scheduled","Failed","Completed","InProgress","Cancelled"]},"CustomFieldApplicableEntityType":{"type":"string","description":"* `User`\n* `WorkItem`","enum":["User","WorkItem"]},"CustomFieldId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"AuditLogOperation":{"type":"string","description":"* `SecondFactorEnabled`\n* `CustomFieldRemoved`\n* `CalendarExternalLinksActivated`\n* `TaskDuplication`\n* `GanttSnapshotDeleted`\n* `CalendarExternalLinkDeleted`\n* `TaskRestored`\n* `CalendarExternalLinksDeactivated`\n* `PowerBIPublicLinkDeleted`\n* `ApprovalCanceled`\n* `RequestFormCreated`\n* `SamlClearPasswordForSamlUsers`\n* `OneTimePasswordUsed`\n* `AnalyzeWidgetPublicLinkCreated`\n* `TaskErased`\n* `InvitationPolicyChanged`\n* `CalendarExternalLinkCreated`\n* `UserTaskGroupRolesChanged`\n* `UserJoinedSpace`\n* `SamlSSOSettingsChanged`\n* `UserFailLogin`\n* `SamlSSODisabled`\n* `AdminMailSettingsChanged`\n* `CustomFieldRemovedFromFolder`\n* `UserLoggedIn`\n* `UserRoleChanged`\n* `CustomFieldAddedToFolder`\n* `UserTypeModified`\n* `AccessCodeAccepted`\n* `PublicLinkExpirationChanged`\n* `UserLogout`\n* `PowerBIPublicLinkCreated`\n* `GuestReviewerRevoked`\n* `ApprovedIpRangesOrSubnetsChanged`\n* `TaskScheduleChanged`\n* `CustomFieldRestored`\n* `AccountDeleted`\n* `UserAdminPermissionsChanged`\n* `AttachDeleted`\n* `SpaceDeleted`\n* `AuditReportCreated`\n* `UserTypeCreated`\n* `ExcelExportCreated`\n* `AdminLoggedInAsUser`\n* `WorkflowCreated`\n* `TaskUnsharedFromAuthor`\n* `AccessAuditReportCsvExport`\n* `AttachMarkAsFinal`\n* `OneTimePasswordStatusSwitched`\n* `ApproverAdded`\n* `UserLeftSpace`\n* `TaskUnarchived`\n* `ApprovalDescriptionChanged`\n* `GroupParentRemoved`\n* `GuestReviewAccountSettingsChanged`\n* `WorkflowDeleted`\n* `PasswordPolicyModified`\n* `GroupInviteeAdded`\n* `UserRestored`\n* `WorkflowArchived`\n* `ApprovalDueDateChanged`\n* `AnalyzeWidgetPublicLinkDeleted`\n* `SpaceArchivedUnarchived`\n* `TaskStatusChanged`\n* `TaskCommentChanged`\n* `AccessRoleDeleted`\n* `TaskUnassigned`\n* `AnalyzePublicLinkCreated`\n* `GuestReviewRejected`\n* `TaskUnshared`\n* `PasswordChanged`\n* `RequestFormDeleted`\n* `AttemptDownloadInfectedAttach`\n* `InvitationSend`\n* `AccessRoleModified`\n* `SpaceCreated`\n* `ApprovedDomainsChanged`\n* `TimesheetStatusChanged`\n* `TimelogLocked`\n* `UserRevokeAdmin`\n* `RecycleBinErased`\n* `ApproverRemoved`\n* `UserDeleted`\n* `GanttSnapshotCreated`\n* `GroupMemberRemoved`\n* `UserProfileUpdated`\n* `SecondFactorUsageReportCreated`\n* `SecondFactorDisabled`\n* `WhiteboardCreated`\n* `AttachViewed`\n* `AccessRoleCreated`\n* `GroupMemberAdded`\n* `AccountDataExportRequested`\n* `SamlSSOMetadataChanged`\n* `GroupRenamed`\n* `PublicLinkCreated`\n* `TaskShared`\n* `AccountModified`\n* `PublicLinkPasswordRequested`\n* `WorkflowModified`\n* `PublicLinkDeleted`\n* `AccessCodeDeclined`\n* `AnalyzeWidgetPublicLinkAccessed`\n* `ApprovalCreated`\n* `Oauth2AccessRevoked`\n* `TaskParentRemoved`\n* `AntivirusDeletedInfectedAttach`\n* `RequestFormModified`\n* `GroupInviteeRemoved`\n* `GuestReviewerInvited`\n* `TaskArchived`\n* `AccountBackupCreated`\n* `FeedCreated`\n* `AccessCodeGenerated`\n* `UserDeactivated`\n* `AttachCopied`\n* `GroupParentAdded`\n* `GuestReviewerChanged`\n* `TimelogUnlocked`\n* `TaskCreated`\n* `WhiteboardRemoved`\n* `OneTimePasswordRevoked`\n* `ApprovalFinished`\n* `TaskAssigned`\n* `OneTimePasswordCreated`\n* `GroupCreated`\n* `TimesheetCreated`\n* `UsersAndGroupsExported`\n* `AttachMoved`\n* `CustomFieldCreated`\n* `AutomatedIntegrationsExecution`\n* `PowerBIPublicLinkAccessed`\n* `AttachUnmarkAsFinal`\n* `AnalyzePublicLinkAccessed`\n* `TimesheetTimeframeSettingsModified`\n* `GroupDeleted`\n* `CustomFieldModified`\n* `TaskCommentDeleted`\n* `AnalyzePublicLinkDeleted`\n* `UserTypeDeleted`\n* `TimesheetTimeframeSettingsCreated`\n* `Oauth2AccessGranted`\n* `UserGrantAdmin`\n* `PublicLinksAccountSettingsChanged`\n* `WorkflowUnarchived`\n* `TaskDeleted`\n* `InvitationAccepted`\n* `AccountDataExportGenerated`\n* `SamlSSOEnabled`\n* `PublicLinkPasswordChanged`\n* `TaskParentAdded`\n* `ApprovalDecisionMade`\n* `GuestReviewAccepted`\n* `UserCustomFieldValueChanged`\n* `UserActivated`\n* `AttachUploaded`\n* `AttachDownloaded`","enum":["SecondFactorEnabled","CustomFieldRemoved","CalendarExternalLinksActivated","TaskDuplication","GanttSnapshotDeleted","CalendarExternalLinkDeleted","TaskRestored","CalendarExternalLinksDeactivated","PowerBIPublicLinkDeleted","ApprovalCanceled","RequestFormCreated","SamlClearPasswordForSamlUsers","OneTimePasswordUsed","AnalyzeWidgetPublicLinkCreated","TaskErased","InvitationPolicyChanged","CalendarExternalLinkCreated","UserTaskGroupRolesChanged","UserJoinedSpace","SamlSSOSettingsChanged","UserFailLogin","SamlSSODisabled","AdminMailSettingsChanged","CustomFieldRemovedFromFolder","UserLoggedIn","UserRoleChanged","CustomFieldAddedToFolder","UserTypeModified","AccessCodeAccepted","PublicLinkExpirationChanged","UserLogout","PowerBIPublicLinkCreated","GuestReviewerRevoked","ApprovedIpRangesOrSubnetsChanged","TaskScheduleChanged","CustomFieldRestored","AccountDeleted","UserAdminPermissionsChanged","AttachDeleted","SpaceDeleted","AuditReportCreated","UserTypeCreated","ExcelExportCreated","AdminLoggedInAsUser","WorkflowCreated","TaskUnsharedFromAuthor","AccessAuditReportCsvExport","AttachMarkAsFinal","OneTimePasswordStatusSwitched","ApproverAdded","UserLeftSpace","TaskUnarchived","ApprovalDescriptionChanged","GroupParentRemoved","GuestReviewAccountSettingsChanged","WorkflowDeleted","PasswordPolicyModified","GroupInviteeAdded","UserRestored","WorkflowArchived","ApprovalDueDateChanged","AnalyzeWidgetPublicLinkDeleted","SpaceArchivedUnarchived","TaskStatusChanged","TaskCommentChanged","AccessRoleDeleted","TaskUnassigned","AnalyzePublicLinkCreated","GuestReviewRejected","TaskUnshared","PasswordChanged","RequestFormDeleted","AttemptDownloadInfectedAttach","InvitationSend","AccessRoleModified","SpaceCreated","ApprovedDomainsChanged","TimesheetStatusChanged","TimelogLocked","UserRevokeAdmin","RecycleBinErased","ApproverRemoved","UserDeleted","GanttSnapshotCreated","GroupMemberRemoved","UserProfileUpdated","SecondFactorUsageReportCreated","SecondFactorDisabled","WhiteboardCreated","AttachViewed","AccessRoleCreated","GroupMemberAdded","AccountDataExportRequested","SamlSSOMetadataChanged","GroupRenamed","PublicLinkCreated","TaskShared","AccountModified","PublicLinkPasswordRequested","WorkflowModified","PublicLinkDeleted","AccessCodeDeclined","AnalyzeWidgetPublicLinkAccessed","ApprovalCreated","Oauth2AccessRevoked","TaskParentRemoved","AntivirusDeletedInfectedAttach","RequestFormModified","GroupInviteeRemoved","GuestReviewerInvited","TaskArchived","AccountBackupCreated","FeedCreated","AccessCodeGenerated","UserDeactivated","AttachCopied","GroupParentAdded","GuestReviewerChanged","TimelogUnlocked","TaskCreated","WhiteboardRemoved","OneTimePasswordRevoked","ApprovalFinished","TaskAssigned","OneTimePasswordCreated","GroupCreated","TimesheetCreated","UsersAndGroupsExported","AttachMoved","CustomFieldCreated","AutomatedIntegrationsExecution","PowerBIPublicLinkAccessed","AttachUnmarkAsFinal","AnalyzePublicLinkAccessed","TimesheetTimeframeSettingsModified","GroupDeleted","CustomFieldModified","TaskCommentDeleted","AnalyzePublicLinkDeleted","UserTypeDeleted","TimesheetTimeframeSettingsCreated","Oauth2AccessGranted","UserGrantAdmin","PublicLinksAccountSettingsChanged","WorkflowUnarchived","TaskDeleted","InvitationAccepted","AccountDataExportGenerated","SamlSSOEnabled","PublicLinkPasswordChanged","TaskParentAdded","ApprovalDecisionMade","GuestReviewAccepted","UserCustomFieldValueChanged","UserActivated","AttachUploaded","AttachDownloaded"]},"AccountSubscriptionType":{"type":"string","description":"* `CreativeBusiness`\n* `CreativeEnterprise`\n* `Enterprise`\n* `Premium`\n* `Free`\n* `Business`","enum":["CreativeBusiness","CreativeEnterprise","Enterprise","Premium","Free","Business"]},"DataExportOperation":{"type":"object","properties":{"resources":{"type":"array","description":"List of exported resources","items":{"$ref":"#/components/schemas/DataExportResource"}},"id":{"$ref":"#/components/schemas/DataExportId"},"completedDate":{"type":"string","description":"The date when data export was finished Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"status":{"$ref":"#/components/schemas/DataExportStatus"}}},"WorkflowId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"CustomFieldSettings":{"required":["readOnly"],"type":"object","properties":{"optionColorsEnabled":{"type":"boolean","description":"Is colors for options enabled (only for DropDown and MultipleSelect type). Use parameter 'options' to specify colors"},"linkToDatabaseInfo":{"$ref":"#/components/schemas/CustomFieldLinkToDatabaseField"},"timezone":{"type":"string","description":"Timezone Id, e.g 'America/New_York' (only for Date type)"},"values":{"type":"array","description":"Dropdown values without colors (only for DropDown and MultipleSelect type)","items":{"type":"string"}},"aggregation":{"$ref":"#/components/schemas/CustomFieldAggregationType"},"readOnly":{"type":"boolean","description":"Is field value read only"},"allowOtherValues":{"type":"boolean","description":"Allow users to input other values (only for DropDown type)","default":"true"},"useThousandsSeparator":{"type":"boolean","description":"Use thousands separator (only for Numeric type)","default":"false"},"decimalPlaces":{"type":"number","description":"Decimal places (only for Numeric, Percentage and Currency types)","default":"2"},"options":{"type":"array","description":"Dropdown options with colors (only for DropDown and MultipleSelect type). Array of objects:\n{\"value\": \"string\", \"color\": \"enum: Brown, Red, Purple, Indigo, DarkBlue, Blue, Turquoise, DarkCyan, Green, YellowGreen, Yellow, Orange, Gray, DarkRed\"}\n","items":{"$ref":"#/components/schemas/CustomFieldDropdownOption"}},"currency":{"$ref":"#/components/schemas/CustomFieldCurrency"},"allowTime":{"type":"boolean","description":"Allow users to input time (only for Date type)"},"mirrorInfo":{"$ref":"#/components/schemas/CustomFieldMirrorField"},"applicableEntityTypes":{"type":"array","description":"Applicable entity types","items":{"$ref":"#/components/schemas/CustomFieldApplicableEntityType"},"default":"WorkItem"},"contacts":{"type":"array","description":"Allowed users or invitations (only for Users type)","items":{"$ref":"#/components/schemas/UserId"}},"inheritanceType":{"type":"string","enum":["All","Projects","Folders"]}}},"InvitationStatus":{"type":"string","description":"* `Declined`\n* `Cancelled`\n* `Pending`\n* `Accepted`","enum":["Declined","Cancelled","Pending","Accepted"]},"CustomStatusInput":{"required":["id","name","group","hidden"],"type":"object","properties":{"color":{"$ref":"#/components/schemas/StatusColor"},"hidden":{"type":"boolean","description":"Custom status is hidden"},"name":{"type":"string","description":"Name (128 symbols max)"},"id":{"$ref":"#/components/schemas/CustomStatusId"},"group":{"$ref":"#/components/schemas/TaskStatus"}},"description":"ID and group cannot be set simultaneously in request parameter,\nbut ID is required for update, and group is required for insert"},"UserScheduleExclusionId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"AsyncJobType":{"type":"string","description":"* `TaskBlueprintLaunch`\n* `BatchOperation`\n* `SubmitRequestForm`\n* `CopyFolder`\n* `FolderBlueprintLaunch`","enum":["TaskBlueprintLaunch","BatchOperation","SubmitRequestForm","CopyFolder","FolderBlueprintLaunch"]},"Approval":{"type":"object","properties":{"dueDate":{"type":"string","description":"Due date, if exists Format: yyyy-MM-dd"},"description":{"type":"string","description":"Description"},"finished":{"type":"boolean","description":"Is approval finished"},"updatedDate":{"type":"string","description":"Update date Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"authorId":{"$ref":"#/components/schemas/UserId"},"title":{"type":"string","description":"Title. Empty by default, set via workflow automation or by user on the portal"},"type":{"$ref":"#/components/schemas/ApprovalType"},"autoFinishOnReject":{"type":"boolean","description":"Is approval would be finished automatically on reaching Rejected status"},"folderId":{"$ref":"#/components/schemas/FolderId"},"finisherId":{"$ref":"#/components/schemas/UserId"},"autoFinishOnApprove":{"type":"boolean","description":"Is approval would be finished automatically on reaching Approved status"},"decisions":{"type":"array","description":"Approvers and their decisions","items":{"$ref":"#/components/schemas/ApprovalDecision"}},"attachmentIds":{"type":"array","description":"ID of origin version attachments in review","items":{"$ref":"#/components/schemas/AttachmentId"}},"id":{"$ref":"#/components/schemas/ApprovalId"},"taskId":{"$ref":"#/components/schemas/TaskId"},"status":{"$ref":"#/components/schemas/ApprovalStatus"}}},"BudgetRateProvision":{"required":["contact","rateType","rateSource"],"type":"object","properties":{"rateValue":{"type":"number","description":"Rate value is displayed to 2 decimal places. More digits will be rounded arithmetically to 2 decimal places. No need to specify rate value if rate source is \"job role\""},"rateType":{"$ref":"#/components/schemas/BudgetRateType"},"contact":{"$ref":"#/components/schemas/UserId"},"rateSource":{"$ref":"#/components/schemas/BudgetRateSource"}}},"RollupSettings":{"type":"object","properties":{"itemId":{"$ref":"#/components/schemas/TaskId"},"rollupSettings":{"type":"array","description":"Rollup settings for fields","items":{"$ref":"#/components/schemas/FieldRollupSettings"}},"childIds":{"type":"array","description":"Child item IDs","items":{"$ref":"#/components/schemas/TaskId"}}}},"WorkScheduleCapacityChange":{"type":"object","properties":{"workScheduleId":{"type":"string","description":""},"finishDate":{"type":"string","description":" Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"id":{"type":"string","description":""},"capacityMinutes":{"type":"number","description":""},"startDate":{"type":"string","description":" Format: yyyy-MM-dd'T'HH:mm:ss'Z'"}}},"Space":{"type":"object","properties":{"defaultTaskWorkflowId":{"$ref":"#/components/schemas/WorkflowId"},"guestRoleId":{"$ref":"#/components/schemas/AccessRoleId"},"avatarUrl":{"type":"string","description":"Avatar URL"},"description":{"type":"string","description":"Description"},"suggestedProjectWorkflowIds":{"type":"array","description":"Suggested project workflows IDs for a space.","items":{"$ref":"#/components/schemas/WorkflowId"}},"suggestedTaskWorkflowIds":{"type":"array","description":"Suggested task workflows IDs for a space","items":{"$ref":"#/components/schemas/WorkflowId"}},"title":{"type":"string","description":"Title"},"defaultProjectWorkflowId":{"$ref":"#/components/schemas/WorkflowId"},"accessType":{"$ref":"#/components/schemas/SpaceAccessType"},"archived":{"type":"boolean","description":"Space is archived"},"members":{"type":"array","description":"Space members","items":{"$ref":"#/components/schemas/SpaceMember"}},"workScheduleId":{"$ref":"#/components/schemas/WorkScheduleId"},"id":{"$ref":"#/components/schemas/SpaceId"}}},"AuditLogId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"TimelogExportStatus":{"type":"string","description":"* `NotExported` - Not Exported\n* `Exported` - Exported\n* `ReadyForExport` - Ready For Export","enum":["NotExported","Exported","ReadyForExport"]},"RequestForm":{"type":"object","properties":{"spaceId":{"$ref":"#/components/schemas/SpaceId"},"pages":{"type":"array","description":"Pages","items":{"$ref":"#/components/schemas/FormPage"}},"description":{"type":"string","description":"Description. By default contains plain text with tags for line breaks. Set plainTextDescription=true to receive plain text without HTML tags."},"id":{"$ref":"#/components/schemas/FormId"},"title":{"type":"string","description":"Title"},"dataUsageStatistics":{"$ref":"#/components/schemas/DataUsageStatistics"}}},"Timesheet":{"type":"object","properties":{"timesheetId":{"$ref":"#/components/schemas/TimesheetPeriodId"},"accountId":{"$ref":"#/components/schemas/AccountId"},"periodStartDate":{"type":"string","description":"Date of when the timesheet started Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"timeframe":{"$ref":"#/components/schemas/TimeframeType"},"approval":{"$ref":"#/components/schemas/TimesheetApproval"},"rows":{"type":"array","description":"List of timesheet rows","items":{"$ref":"#/components/schemas/TimesheetRow"}},"userId":{"$ref":"#/components/schemas/UserId"},"periodEndDate":{"type":"string","description":"Date of when the timesheet ended Format: yyyy-MM-dd'T'HH:mm:ss'Z'"}}},"Workflow":{"type":"object","properties":{"standard":{"type":"boolean","description":"Defines default workflow"},"hidden":{"type":"boolean","description":"Workflow is hidden"},"customStatuses":{"type":"array","description":"Custom statuses","items":{"$ref":"#/components/schemas/CustomStatus"}},"name":{"type":"string","description":"Name (128 symbols max)"},"description":{"type":"string","description":"Description (2000 symbols max)"},"id":{"$ref":"#/components/schemas/WorkflowId"},"dataUsageStatistics":{"$ref":"#/components/schemas/DataUsageStatistics"}}},"Dependency":{"type":"object","properties":{"relationType":{"$ref":"#/components/schemas/DependencyRelationType"},"successorId":{"$ref":"#/components/schemas/TaskId"},"lagTime":{"type":"number","description":"Always in minutes, positive numbers are lag time and negative numbers are lead time"},"id":{"$ref":"#/components/schemas/DependencyId"},"predecessorId":{"$ref":"#/components/schemas/TaskId"}}},"BookingEffort":{"required":["mode"],"type":"object","properties":{"mode":{"$ref":"#/components/schemas/EffortMode"},"totalEffort":{"type":"number","description":"Total Effort in minutes"},"responsibleAllocation":{"type":"array","description":"Responsible allocations by day","items":{"$ref":"#/components/schemas/ResponsibleAllocation"}}}},"CustomFieldAggregationType":{"type":"string","description":"* `Average`\n* `Sum`\n* `None`","enum":["Average","Sum","None"]},"JobRole":{"type":"object","properties":{"isDeleted":{"type":"boolean","description":"Job Role is deleted"},"avatarUrl":{"type":"string","description":"Avatar URL"},"id":{"$ref":"#/components/schemas/JobRoleId"},"shortTitle":{"type":"string","description":"Short title"},"title":{"type":"string","description":"Title"}}},"CustomFieldLinkToDatabaseMirrorFieldParam":{"required":["dataHubFieldId","customFieldName"],"type":"object","properties":{"dataHubFieldId":{"type":"string","description":"DataHub field identifier in DataHub Public API format"},"customFieldName":{"type":"string","description":"Custom field name for this mirror"}}},"InstantRange":{"type":"object","properties":{"start":{"type":"string","description":"Range start Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"end":{"type":"string","description":"Range end Format: yyyy-MM-dd'T'HH:mm:ss'Z'"}}},"DependencyId":{"pattern":"^([a-zA-Z0-9-_:\\.=]){1,256}$","type":"string"},"CustomFieldSharing":{"type":"object","properties":{"readerIds":{"type":"array","description":"Users who can see the field. \n
\n
null – everyone can read values
\n
empty – available for space custom fields only. When readerIds is empty, spaceReaders must be non-null. It means that read access is granted only via space membership (spaceReaders)
\n
\n","items":{"$ref":"#/components/schemas/UserId"}},"spaceReaders":{"$ref":"#/components/schemas/CustomFieldSharingSpaceMembership"},"spaceWriters":{"$ref":"#/components/schemas/CustomFieldSharingSpaceMembership"},"writerIds":{"type":"array","description":"Users who can edit field values. \n
\n
null – everyone can edit values. Allowed only when readerIds == null
\n
empty – if spaceWriters is null, then nobody can edit values. Otherwise, write access is granted only via space membership (spaceWriters)
\n
\n \nVarious system actions (request form submission, automation action...) are not affected by this setting\n","items":{"$ref":"#/components/schemas/UserId"}}}},"UserType":{"type":"object","properties":{"description":{"type":"string","description":"User Type description"},"id":{"$ref":"#/components/schemas/UserTypeId"},"title":{"type":"string","description":"User Type title"}}},"BudgetRateParam":{"required":["rateSubjectId","rateType"],"type":"object","properties":{"rateValue":{"type":"number","description":"Rate value is displayed to 2 decimal places. More digits will be rounded arithmetically to 2 decimal places. No need to specify rate value if rate source is \"job role\""},"rateType":{"$ref":"#/components/schemas/BudgetRateType"},"rateSubjectId":{"$ref":"#/components/schemas/UserId"},"rateSource":{"$ref":"#/components/schemas/BudgetRateSource"}}},"ApprovalDecision":{"required":["approverId","comment","status","updatedDate"],"type":"object","properties":{"approverId":{"$ref":"#/components/schemas/UserId"},"comment":{"type":"string","description":"comment"},"updatedDate":{"type":"string","description":"update date Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"status":{"$ref":"#/components/schemas/ApprovalDecisionStatus"}}},"Group":{"type":"object","properties":{"accountId":{"$ref":"#/components/schemas/AccountId"},"metadata":{"type":"array","description":"List of group metadata entries","items":{"$ref":"#/components/schemas/Metadata"}},"childIds":{"type":"array","description":"List of child group IDs","items":{"$ref":"#/components/schemas/UserId"}},"avatarUrl":{"type":"string","description":"Avatar URL"},"parentIds":{"type":"array","description":"List of parent group IDs","items":{"$ref":"#/components/schemas/UserId"}},"myTeam":{"type":"boolean","description":"Field is present and set to true for My Team (default) group"},"id":{"$ref":"#/components/schemas/UserId"},"title":{"type":"string","description":"Group title"},"memberIds":{"type":"array","description":"List of group members user IDs","items":{"$ref":"#/components/schemas/UserId"}}}},"Placeholder":{"type":"object","properties":{"deleted":{"type":"boolean","description":"True if Placeholder is deleted, false otherwise"},"avatarUrl":{"type":"string","description":"Avatar URL"},"jobRoleId":{"$ref":"#/components/schemas/JobRoleId"},"id":{"$ref":"#/components/schemas/PlaceholderId"},"shortTitle":{"type":"string","description":"Short title"},"title":{"type":"string","description":"Title"}}},"CustomFieldDescription":{"type":"object","properties":{"accountId":{"$ref":"#/components/schemas/AccountId"},"spaceId":{"$ref":"#/components/schemas/SpaceId"},"settings":{"$ref":"#/components/schemas/CustomFieldSettings"},"sharedIds":{"type":"array","description":"Users with whom the custom field is shared. Field is obsolete, use 'sharing' to get more relevant access settings","items":{"$ref":"#/components/schemas/UserId"}},"description":{"type":"string","description":"Custom field description"},"id":{"$ref":"#/components/schemas/CustomFieldId"},"title":{"type":"string","description":"Custom field title"},"type":{"$ref":"#/components/schemas/CustomFieldType"},"sharing":{"$ref":"#/components/schemas/CustomFieldSharing"},"dataUsageStatistics":{"$ref":"#/components/schemas/DataUsageStatistics"}}},"Metadata":{"required":["key","value"],"type":"object","properties":{"value":{"type":"string","description":"Value should be less than 1000 symbols, compatible with JSON string. Use JSON 'null' in order to remove metadata entry"},"key":{"type":"string","description":"Key should be less than 50 symbols and match following regular expression ([A-Za-z0-9_-]+)"}},"description":"Metadata entries are isolated on per-client (application) basis"},"BudgetRateHistoryItem":{"required":["rateSource","rateValue","startDate"],"type":"object","properties":{"rateValue":{"type":"number","description":"Rate value is displayed to 2 decimal places"},"endDate":{"type":"string","description":"The date when the rate became no longer effective and change to another rate Format: yyyy-MM-dd'T'HH:mm:ss ('T'HH:mm:ss is optional)"},"rateSource":{"$ref":"#/components/schemas/BudgetRateSource"},"startDate":{"type":"string","description":"The date when the rate became effective Format: yyyy-MM-dd'T'HH:mm:ss ('T'HH:mm:ss is optional)"}}},"TimeframeType":{"type":"string","description":"* `Monthly`\n* `Weekly`","enum":["Monthly","Weekly"]},"AsyncJobId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"UserAvatarColor":{"type":"string","description":"* `Purple1` - #BA68C8\n* `Purple2` - #8E24AA\n* `Blue1` - #64B5F6\n* `Pink1` - #F06292\n* `Pink2` - #D81B60\n* `Red1` - #E57373\n* `Red2` - #E53935\n* `Turquoise1` - #4DD0E1\n* `Turquoise2` - #00ACC1\n* `Blue2` - #1E88E5\n* `DarkBlue1` - #7986CB\n* `Green2` - #43A047\n* `DarkBlue2` - #3949AB\n* `Green1` - #81C784\n* `Yellow1` - #FBC02D\n* `Yellow2` - #F9A825\n* `Orange2` - #F57C00\n* `DarkCyan2` - #00897B\n* `Orange1` - #FF9800\n* `DarkCyan1` - #4DB6AC\n* `YellowGreen2` - #AFB42B\n* `YellowGreen1` - #C0CA33","enum":["Purple1","Purple2","Blue1","Pink1","Pink2","Red1","Red2","Turquoise1","Turquoise2","Blue2","DarkBlue1","Green2","DarkBlue2","Green1","Yellow1","Yellow2","Orange2","DarkCyan2","Orange1","DarkCyan1","YellowGreen2","YellowGreen1"]},"CustomFieldLinkToDatabaseMirrorField":{"required":["dataHubFieldId","customFieldId"],"type":"object","properties":{"dataHubFieldId":{"type":"string","description":"DataHub field identifier in DataHub Public API format"},"customFieldId":{"type":"string","description":"Custom field id of this mirror"}}},"CustomFieldComparator":{"type":"string","description":"* `IsEmpty` - For all field types. No extra parameters required\n* `ContainsAny` - For multiple select and contact fields. Parameter 'values' is required\n* `NotInRange` - For numeric, text, dropdown, currency, percent, duration, and date fields. Parameters 'minValue' and 'maxValue' are required\n* `LessOrEqualTo` - For numeric, text, dropdown, currency, percent, duration, and date fields. Parameter 'value' is required\n* `StartsWith` - For text and dropdown fields. Parameter 'value' is required\n* `ContainsAll` - For multiple select and contact fields. Parameter 'values' is required\n* `EqualTo` - For all field types. Parameter 'value' is required\n* `LessThan` - For numeric, text, dropdown, currency, percent, duration, and date fields. Parameter 'value' is required\n* `GreaterOrEqualTo` - For numeric, text, dropdown, currency, percent, duration, and date fields. Parameter 'value' is required\n* `IsNotEmpty` - For all field types. No extra parameters required\n* `GreaterThan` - For numeric, text, dropdown, currency, percent, duration, and date fields. Parameter 'value' is required\n* `InRange` - For numeric, text, dropdown, currency, percent, duration, and date fields. Parameters 'minValue' and 'maxValue' are required\n* `Contains` - For text and dropdown fields. Parameter 'value' is required\n* `EndsWith` - For text and dropdown fields. Parameter 'value' is required","enum":["IsEmpty","ContainsAny","NotInRange","LessOrEqualTo","StartsWith","ContainsAll","EqualTo","LessThan","GreaterOrEqualTo","IsNotEmpty","GreaterThan","InRange","Contains","EndsWith"]},"RequestFormSubmit":{"type":"object","properties":{"formId":{"$ref":"#/components/schemas/FormId"},"projectId":{"$ref":"#/components/schemas/FolderId"},"taskId":{"$ref":"#/components/schemas/TaskId"}}},"ErrorType":{"type":"string","enum":["invalid_request","invalid_parameter","parameter_required","not_authorized","access_forbidden","not_allowed","resource_not_found","method_not_found","too_many_requests","rate_limit_exceeded","server_error"]},"UserProfileParam":{"required":["accountId","role"],"type":"object","properties":{"accountId":{"$ref":"#/components/schemas/AccountId"},"external":{"type":"boolean","description":"Make user external"},"role":{"$ref":"#/components/schemas/UserRole"}}},"BudgetRate":{"required":["rateSource"],"type":"object","properties":{"rateValue":{"type":"number","description":"Rate value is displayed to 2 decimal places. More digits will be rounded arithmetically to 2 decimal places. No need to specify rate value if rate source is \"job role\""},"rateScope":{"$ref":"#/components/schemas/BudgetRateScope"},"rateSource":{"$ref":"#/components/schemas/BudgetRateSource"}}},"EntityTypeId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"CustomFieldLinkToDatabaseField":{"required":["dataHubDatabaseId","allowMultipleEntries"],"type":"object","properties":{"allowMultipleEntries":{"type":"boolean","description":"Allow linkage of multiple records"},"dataHubDatabaseId":{"type":"string","description":"DataHub database identifier in DataHub Public API format"},"mirrorFields":{"type":"array","description":"Mirror fields associated with this link","items":{"$ref":"#/components/schemas/CustomFieldLinkToDatabaseMirrorField"}}}},"CustomFieldInheritanceType":{"type":"string","description":"* `All`\n* `Tasks`\n* `Projects`\n* `Folders`","enum":["All","Tasks","Projects","Folders"]},"FormDateFieldLimitType":{"type":"string","description":"* `FUTURE_DATE_ONLY`\n* `DATE_BEFORE`\n* `DATE_BETWEEN`\n* `UNLIMITED`\n* `X_DAYS_AFTER_TODAY`\n* `DATE_AFTER`","enum":["FUTURE_DATE_ONLY","DATE_BEFORE","DATE_BETWEEN","UNLIMITED","X_DAYS_AFTER_TODAY","DATE_AFTER"]},"DataExportForeignKeySchema":{"required":["tableId","columnId"],"type":"object","properties":{"columnId":{"type":"string","description":"Foreign column id"},"tableId":{"type":"string","description":"Foreign table id"}}},"UserSchedulePartialExclusion":{"type":"object","properties":{"exclusionType":{"type":"string","enum":["VacationPTO","OtherNonWorking"]},"finishDate":{"type":"string","description":" Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"id":{"type":"string","description":""},"userId":{"$ref":"#/components/schemas/UserId"},"capacityMinutes":{"type":"number","description":""},"startDate":{"type":"string","description":" Format: yyyy-MM-dd'T'HH:mm:ss'Z'"}}},"RollupFilter":{"required":["fields"],"type":"object","properties":{"fields":{"type":"array","description":"List of field filters","items":{"$ref":"#/components/schemas/RollupFieldFilter"}}}},"ErrorResponse":{"type":"object","properties":{"errorDescription":{"type":"string"},"error":{"$ref":"#/components/schemas/ErrorType"}}},"UserTypeId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"CustomFieldSharingSpaceMembership":{"type":"string","description":"* `Admin` - Grant access to space admins only\n* `Member` - Grant access to all space members","enum":["Admin","Member"]},"WorkTypeIcon":{"required":["symbol"],"type":"object","properties":{"symbol":{"type":"string","description":"Icon symbol"},"version":{"type":"string","description":"Icon version"}}},"LocalDateTimeRange":{"type":"object","properties":{"equal":{"type":"string","description":"Date exact match value Format: yyyy-MM-dd'T'HH:mm:ss ('T'HH:mm:ss is optional)"},"start":{"type":"string","description":"Range start Format: yyyy-MM-dd'T'HH:mm:ss ('T'HH:mm:ss is optional)"},"end":{"type":"string","description":"Range end Format: yyyy-MM-dd'T'HH:mm:ss ('T'HH:mm:ss is optional)"}}},"AccountId":{"pattern":"^([A-Z0-9]){8}$","type":"string"},"CustomFieldLinkToDatabaseFieldParam":{"required":["dataHubDatabaseId","allowMultipleEntries"],"type":"object","properties":{"allowMultipleEntries":{"type":"boolean","description":"Allow linkage of multiple records"},"dataHubDatabaseId":{"type":"string","description":"DataHub database identifier in DataHub Public API format"},"mirrorFields":{"type":"array","description":"Mirror fields associated with this link","items":{"$ref":"#/components/schemas/CustomFieldLinkToDatabaseMirrorFieldParam"}}}},"WorkScheduleCapacityOverrideId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"Attachment":{"type":"object","properties":{"currentAttachmentId":{"$ref":"#/components/schemas/AttachmentId"},"originVersionId":{"$ref":"#/components/schemas/AttachmentId"},"reviewIds":{"type":"array","description":"Review IDs","items":{"$ref":"#/components/schemas/ReviewId"}},"previewUrl":{"type":"string","description":"Link to download external attachment preview (present if preview is available)"},"playlistUrl":{"type":"string","description":"Link to video playlist"},"authorId":{"$ref":"#/components/schemas/UserId"},"type":{"$ref":"#/components/schemas/AttachmentType"},"version":{"type":"number","description":"Attachment version"},"folderId":{"type":"string","description":"ID of related folder. Only one of taskId/folderId fields is present"},"url":{"type":"string","description":"Link to download attachment"},"createdDate":{"type":"string","description":"Upload date Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"size":{"type":"number","description":"Size for Wrike Attachments. For external attachments, size is equal to -1"},"name":{"type":"string","description":"Attachment filename"},"width":{"type":"number","description":"Attachment width, if image"},"commentId":{"type":"string","description":"ID of related comment"},"id":{"$ref":"#/components/schemas/AttachmentId"},"contentType":{"type":"string","description":"Content type"},"taskId":{"type":"string","description":"ID of related task. Only one of taskId/folderId fields is present"},"height":{"type":"number","description":"Attachment height, if image"}}},"CustomFieldDropdownOption":{"required":["value"],"type":"object","properties":{"color":{"$ref":"#/components/schemas/DropdownOptionColor"},"value":{"type":"string","description":"value"}}},"Apiv3Apiv2Id":{"type":"object","properties":{"id":{"type":"string","description":"API v3 ID"},"apiV2Id":{"type":"string","description":"API v2 legacy ID"}}},"BudgetRateSubjectType":{"type":"string","description":"* `Placeholder` - Placeholder\n* `User` - Regular user","enum":["Placeholder","User"]},"TimesheetRowId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"WorkWeekUpdate":{"required":["dayOfWeek","isWorkDay"],"type":"object","properties":{"dayOfWeek":{"$ref":"#/components/schemas/WeekDay"},"isWorkDay":{"type":"boolean","description":"Is it working day"}}},"AccessRole":{"type":"object","properties":{"description":{"type":"string","description":"Role description"},"id":{"$ref":"#/components/schemas/AccessRoleId"},"title":{"type":"string","description":"Role title"}}},"ExternalRequesterId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"FolderProjectUpdateParam":{"type":"object","properties":{"ownersRemove":{"type":"array","description":"List of userIds to be removed from owners","items":{"$ref":"#/components/schemas/UserId"}},"endDate":{"type":"string","description":"Project end date (null value to remove) Format: yyyy-MM-dd"},"contractType":{"$ref":"#/components/schemas/ContractType"},"customStatusId":{"type":"string","description":"Project custom status ID. Use this parameter if status value is not one of specified above"},"ownersAdd":{"type":"array","description":"List of userIds to be added as owners","items":{"$ref":"#/components/schemas/UserId"}},"startDate":{"type":"string","description":"Project start date (null value to remove) Format: yyyy-MM-dd"},"status":{"$ref":"#/components/schemas/ProjectStatus"},"budget":{"type":"number","description":"Budget"}}},"BookingDates":{"type":"object","properties":{"duration":{"type":"number","description":"Duration in days"},"workOnWeekends":{"type":"boolean","description":"Weekends are included in booking scheduling"},"finishDate":{"type":"string","description":"Finish date Format: yyyy-MM-dd"},"startDate":{"type":"string","description":"Start date Format: yyyy-MM-dd"}}},"UserScheduleException":{"type":"object","properties":{"fromDate":{"type":"string","description":" Format: yyyy-MM-dd"},"isWorkDays":{"type":"boolean","description":"True if this exception is for working days"},"toDate":{"type":"string","description":" Format: yyyy-MM-dd"},"exclusionType":{"$ref":"#/components/schemas/UserScheduleExclusionType"},"id":{"$ref":"#/components/schemas/UserScheduleExclusionId"},"userId":{"$ref":"#/components/schemas/UserId"}}},"BudgetRateScope":{"type":"string","description":"* `Account`\n* `Project`","enum":["Account","Project"]},"IdAbstract":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"BudgetMetricHistoryItem":{"required":["value","startDate"],"type":"object","properties":{"endDate":{"type":"string","description":"Field's value for the selected end date Format: yyyy-MM-dd'T'HH:mm:ss ('T'HH:mm:ss is optional)"},"value":{"type":"number","description":"Field's value"},"startDate":{"type":"string","description":"Field's value for the selected start date Format: yyyy-MM-dd'T'HH:mm:ss ('T'HH:mm:ss is optional)"}}},"AvatarParam":{"required":["letters","color"],"type":"object","properties":{"color":{"type":"string","description":"Hex color code"},"letters":{"type":"string","description":"Group letters (2 symbols max)"}}},"WeekDay":{"type":"string","description":"* `Thu`\n* `Tue`\n* `Wed`\n* `Sat`\n* `Fri`\n* `Sun`\n* `Mon`","enum":["Thu","Tue","Wed","Sat","Fri","Sun","Mon"]},"DropdownOptionColor":{"type":"string","description":"* `Brown` - #795548\n* `DarkCyan` - #009688\n* `Gray` - #9E9E9E\n* `Blue` - #2196F3\n* `DarkBlue` - #3F51B5\n* `Orange` - #FF9800\n* `Red` - #E91E63\n* `YellowGreen` - #CDDC39\n* `Purple` - #9C27B0\n* `Yellow` - #FFEB3B\n* `Indigo` - #673AB7\n* `Turquoise` - #00BCD4\n* `DarkRed` - #F44336\n* `Green` - #8BC34A","enum":["Brown","DarkCyan","Gray","Blue","DarkBlue","Orange","Red","YellowGreen","Purple","Yellow","Indigo","Turquoise","DarkRed","Green"]},"Datapoint":{"required":["timesUsedTotal","timesUsedThisMonth"],"type":"object","properties":{"lastUsedOn":{"type":"string","description":"Last used on Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"timesUsedThisMonth":{"type":"number","description":"Number of times used this month"},"timesUsedTotal":{"type":"number","description":"Total number of times used"},"lastUsedBy":{"$ref":"#/components/schemas/UserId"}}},"DataExportColumnSchema":{"required":["id","alias","dataType"],"type":"object","properties":{"dataType":{"$ref":"#/components/schemas/DataExportColumnDataType"},"alias":{"type":"string","description":"Column alias"},"id":{"type":"string","description":"Column id"},"foreignKey":{"$ref":"#/components/schemas/DataExportForeignKeySchema"}}},"FolderProjectCreateParam":{"type":"object","properties":{"ownerIds":{"type":"array","description":"List of project owner IDs","items":{"$ref":"#/components/schemas/UserId"}},"endDate":{"type":"string","description":"Project end date Format: yyyy-MM-dd"},"contractType":{"$ref":"#/components/schemas/ContractType"},"customStatusId":{"type":"string","description":"Project custom status ID. Use this parameter if status value is not one of specified above"},"startDate":{"type":"string","description":"Project start date Format: yyyy-MM-dd"},"status":{"$ref":"#/components/schemas/ProjectStatus"},"budget":{"type":"number","description":"Budget"}}},"OperationOutput":{"type":"object","properties":{"id":{"type":"string"}},"description":"OperationOutput","oneOf":[]},"WorkScheduleExclusionId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"CustomFieldFilterParam":{"required":["id"],"type":"object","properties":{"comparator":{"$ref":"#/components/schemas/CustomFieldComparator"},"minValue":{"type":"string","description":"Custom field min value"},"maxValue":{"type":"string","description":"Custom field max value"},"values":{"type":"array","description":"Custom field possible values","items":{"type":"string"}},"id":{"$ref":"#/components/schemas/CustomFieldId"},"value":{"type":"string","description":"Custom field value"}}},"ModifyFieldRollupSettings":{"required":["fieldId","isEnabled"],"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Enable rollup for field"},"fieldId":{"type":"string","description":"Id of field: custom field or one of system fields: StartDate, DueDate, Effort, BookedEffort, PlannedFees, ActualFees, PlannedCost, ActualCost, TimeSpent\n"}}},"StatusColor":{"type":"string","description":"* `Brown` - #795548\n* `DarkCyan` - #009688\n* `Gray` - #9E9E9E\n* `Blue` - #2196F3\n* `DarkBlue` - #3F51B5\n* `Orange` - #FF9800\n* `Red` - #E91E63\n* `YellowGreen` - #CDDC39\n* `Purple` - #9C27B0\n* `Yellow` - #FFEB3B\n* `Indigo` - #673AB7\n* `DarkRed` - #F44336\n* `Turquoise` - #00BCD4\n* `Green` - #8BC34A","enum":["Brown","DarkCyan","Gray","Blue","DarkBlue","Orange","Red","YellowGreen","Purple","Yellow","Indigo","DarkRed","Turquoise","Green"]},"CommentType":{"type":"string","description":"* `Email`\n* `Regular`","enum":["Email","Regular"]},"TaskChangeHistory":{"type":"object","properties":{"plannedCost":{"type":"array","description":"Planned cost change history","items":{"$ref":"#/components/schemas/BudgetMetricHistoryItem"}},"plannedFees":{"type":"array","description":"Planned fees change history","items":{"$ref":"#/components/schemas/BudgetMetricHistoryItem"}},"id":{"$ref":"#/components/schemas/TaskId"},"actualFees":{"type":"array","description":"Actual fees change history","items":{"$ref":"#/components/schemas/BudgetMetricHistoryItem"}},"actualCost":{"type":"array","description":"Actual cost change history","items":{"$ref":"#/components/schemas/BudgetMetricHistoryItem"}}}},"TimelogCategory":{"type":"object","properties":{"hidden":{"type":"boolean","description":"Timelog category is hidden"},"name":{"type":"string","description":"Name of the timelog record"},"id":{"$ref":"#/components/schemas/TimelogCategoryId"},"order":{"type":"number","description":"Order number of the timelog category in category list"}}},"FormId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"TimesheetSubmissionRuleFrequency":{"type":"string","description":"* `Month` - Week\n* `Week` - Week\n* `Day` - Day","enum":["Month","Week","Day"]},"BillingType":{"type":"string","description":"* `Billable` - Billable\n* `NonBillable` - Non-Billable","enum":["Billable","NonBillable"]},"AttachmentUrl":{"type":"object","properties":{"playlistUrl":{"type":"string","description":"URL to video playlist of attachment"},"url":{"type":"string","description":"URL by which attachment can be accessed"}}},"AttachmentType":{"type":"string","description":"* `Google` - Google attachment. Attachment can be accessed only via URL, downloads are not supported by Wrike.When deleted, only stored link is removed\n* `DAM` - Attachment from an external DAM system\n* `OneDrive` - OneDrive attachment. When deleted, only stored link is removed\n* `Wrike` - Attachment file content stored in Wrike. When deleted, actual file is removed\n* `External` - External attachment\n* `Box` - Box attachment. Attachment can be accessed only via URL, downloads are not supported by Wrike.When deleted, only stored link is removed\n* `SharePoint` - SharePoint attachment. When deleted, only stored link is removed\n* `DropBox` - DropBox attachment. When deleted, only stored link is removed","enum":["Google","DAM","OneDrive","Wrike","External","Box","SharePoint","DropBox"]},"ExternalRequester":{"required":["id","firstName","email"],"type":"object","properties":{"firstName":{"type":"string","description":"The first name of the external requester"},"lastName":{"type":"string","description":"The last name of the external requester"},"id":{"$ref":"#/components/schemas/ExternalRequesterId"},"email":{"type":"string","description":"The email address of the external requester"}}},"TimelogId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"JobRoleId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"ColorsInfo":{"type":"object","properties":{"name":{"type":"string","description":"Color name"},"hex":{"type":"string","description":"HEX code"}}},"ApprovalDecisionStatus":{"type":"string","description":"* `Approved`\n* `Rejected`\n* `Pending`","enum":["Approved","Rejected","Pending"]},"TimesheetRowForApiV4":{"type":"object","properties":{"parentIds":{"type":"array","description":"List of entry parent folder IDs","items":{"$ref":"#/components/schemas/FolderId"}},"type":{"$ref":"#/components/schemas/EntityTypeId"},"weeklyEntries":{"type":"array","description":"List of weekly entries per row","items":{"$ref":"#/components/schemas/TimesheetRowWeeklyEntry"}},"taskId":{"type":"string","description":"Task ID associated with this row"},"categoryId":{"$ref":"#/components/schemas/TimelogCategoryId"},"rowId":{"$ref":"#/components/schemas/TimesheetRowId"}}},"WorkSchedule":{"type":"object","properties":{"scheduleType":{"$ref":"#/components/schemas/WorkScheduleType"},"workweek":{"type":"array","description":"Work week","items":{"$ref":"#/components/schemas/WorkWeek"}},"userIds":{"type":"array","description":"User ids assigned to schedule","items":{"$ref":"#/components/schemas/UserId"}},"id":{"$ref":"#/components/schemas/WorkScheduleId"},"title":{"type":"string","description":"Title"}}},"WorkScheduleException":{"type":"object","properties":{"fromDate":{"type":"string","description":" Format: yyyy-MM-dd"},"isWorkDays":{"type":"boolean","description":"True if this exception is for working days"},"toDate":{"type":"string","description":" Format: yyyy-MM-dd"},"exclusionType":{"$ref":"#/components/schemas/WorkScheduleExclusionType"},"id":{"$ref":"#/components/schemas/WorkScheduleExclusionId"}}},"PlaceholderId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"FolderProjectHistory":{"type":"object","properties":{"plannedCost":{"type":"array","description":"Planned cost change history","items":{"$ref":"#/components/schemas/BudgetMetricHistoryItem"}},"plannedFees":{"type":"array","description":"Planned fees change history","items":{"$ref":"#/components/schemas/BudgetMetricHistoryItem"}},"actualFees":{"type":"array","description":"Actual fees change history","items":{"$ref":"#/components/schemas/BudgetMetricHistoryItem"}},"actualCost":{"type":"array","description":"Actual cost change history","items":{"$ref":"#/components/schemas/BudgetMetricHistoryItem"}},"budget":{"type":"array","description":"Budget change history","items":{"$ref":"#/components/schemas/BudgetMetricHistoryItem"}}}},"Equipment":{"type":"object","properties":{"name":{"type":"string","description":"Asset name"},"id":{"$ref":"#/components/schemas/UserId"}}},"UserRole":{"type":"string","description":"* `User`\n* `Collaborator`","enum":["User","Collaborator"]},"TimelogLockSourceType":{"type":"string","description":"* `folder` - Source is a folder/project\n* `space` - Source is a space\n* `unknown` - Source entity type is unknown or inaccessible to the user","enum":["folder","space","unknown"]},"ReviewId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"FolderBlueprint":{"type":"object","properties":{"childIds":{"type":"array","description":"Child Blueprint IDs","items":{"$ref":"#/components/schemas/FolderBlueprintId"}},"customFields":{"type":"array","description":"Custom fields","items":{"$ref":"#/components/schemas/CustomField"}},"scope":{"$ref":"#/components/schemas/BlueprintTreeScope"},"id":{"$ref":"#/components/schemas/FolderBlueprintId"},"permalink":{"type":"string","description":"Link to open blueprint in web workspace, if user has appropriate access"},"title":{"type":"string","description":"Title"}}},"PrefilledRequestFormUrl":{"type":"object","properties":{"url":{"type":"string","description":"Prefilled form URL"}}},"LocalDateRange":{"type":"object","properties":{"equal":{"type":"string","description":"Date exact match value Format: yyyy-MM-dd"},"start":{"type":"string","description":"Range start Format: yyyy-MM-dd"},"end":{"type":"string","description":"Range end Format: yyyy-MM-dd"}}},"Account":{"type":"object","properties":{"metadata":{"type":"array","description":"List of account metadata entries. Entries could be read by all users of account and modified by admins only","items":{"$ref":"#/components/schemas/Metadata"}},"createdDate":{"type":"string","description":"Registration date Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"workDays":{"type":"array","description":"List of weekdays, not empty. These days are used in task duration computation","items":{"$ref":"#/components/schemas/WeekDay"}},"dateFormat":{"type":"string","description":"Date format: dd/MM/yyyy or MM/dd/yyyy"},"firstDayOfWeek":{"type":"string","enum":["Sat","Sun","Mon"]},"customFields":{"type":"array","description":"List of custom fields accessible for requesting user in the account","items":{"$ref":"#/components/schemas/CustomFieldInfo"}},"name":{"type":"string","description":"Name of account"},"recycleBinId":{"$ref":"#/components/schemas/FolderId"},"rootFolderId":{"$ref":"#/components/schemas/FolderId"},"id":{"$ref":"#/components/schemas/AccountId"},"subscription":{"$ref":"#/components/schemas/AccountSubscription"},"joinedDate":{"type":"string","description":"Date when the user has joined the account Format: yyyy-MM-dd'T'HH:mm:ss'Z'"}}},"FolderColor":{"type":"string","description":"* `Indigo4`\n* `Gray3`\n* `Indigo2`\n* `Indigo3`\n* `Gray2`\n* `Gray1`\n* `Yellow1`\n* `Yellow2`\n* `Yellow3`\n* `Blue1`\n* `Yellow4`\n* `Blue2`\n* `Green4`\n* `Blue3`\n* `Green3`\n* `Blue4`\n* `Green2`\n* `Green1`\n* `Orange4`\n* `Orange3`\n* `Orange2`\n* `Orange1`\n* `Person`\n* `Purple1`\n* `Purple2`\n* `Purple3`\n* `Pink1`\n* `Red3`\n* `Pink2`\n* `Red4`\n* `Pink3`\n* `Red1`\n* `Pink4`\n* `Red2`\n* `Purple4`\n* `DarkBlue1`\n* `DarkBlue3`\n* `DarkBlue2`\n* `DarkBlue4`\n* `YellowGreen4`\n* `YellowGreen3`\n* `YellowGreen2`\n* `YellowGreen1`\n* `Turquoise3`\n* `Turquoise4`\n* `Turquoise1`\n* `Turquoise2`\n* `Indigo1`\n* `DarkCyan2`\n* `None`\n* `DarkCyan1`\n* `DarkCyan4`\n* `DarkCyan3`","enum":["Indigo4","Gray3","Indigo2","Indigo3","Gray2","Gray1","Yellow1","Yellow2","Yellow3","Blue1","Yellow4","Blue2","Green4","Blue3","Green3","Blue4","Green2","Green1","Orange4","Orange3","Orange2","Orange1","Person","Purple1","Purple2","Purple3","Pink1","Red3","Pink2","Red4","Pink3","Red1","Pink4","Red2","Purple4","DarkBlue1","DarkBlue3","DarkBlue2","DarkBlue4","YellowGreen4","YellowGreen3","YellowGreen2","YellowGreen1","Turquoise3","Turquoise4","Turquoise1","Turquoise2","Indigo1","DarkCyan2","None","DarkCyan1","DarkCyan4","DarkCyan3"]},"FormFieldType":{"type":"string","description":"* `Importance`\n* `Email`\n* `User`\n* `Number`\n* `TextArea`\n* `CheckBox`\n* `ComboBox`\n* `TextField`\n* `Attachment`\n* `Date`\n* `Separator`\n* `Name`","enum":["Importance","Email","User","Number","TextArea","CheckBox","ComboBox","TextField","Attachment","Date","Separator","Name"]},"TaskEffort":{"required":["mode"],"type":"object","properties":{"dailyAllocationPercentage":{"type":"number","description":"Allocation in percentages per day, for effort daily mode"},"mode":{"$ref":"#/components/schemas/EffortMode"},"allocatedEffort":{"type":"number","description":"Allocated Effort in minutes"},"totalEffort":{"type":"number","description":"Total Effort in minutes"},"responsibleAllocation":{"type":"array","description":"Responsible allocations by day","items":{"$ref":"#/components/schemas/ResponsibleAllocation"}}}},"ApprovalStatus":{"type":"string","description":"* `Draft`\n* `Approved`\n* `Rejected`\n* `Cancelled`\n* `Pending`","enum":["Draft","Approved","Rejected","Cancelled","Pending"]},"UserCapacityExclusionId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"WorkScheduleType":{"type":"string","description":"* `Custom` - Custom schedule is used when some account users have schedules which is different to default\n* `Default` - Default schedule is created along with account and used for all users not explicitly assigned to custom schedule","enum":["Custom","Default"]},"AccessRoleId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"ApprovalType":{"type":"string","description":"* `FilesOnly`\n* `Regular`","enum":["FilesOnly","Regular"]},"CopyFolderAsyncResult":{"type":"object","properties":{"folderId":{"type":"string"}},"description":"Async copy folder result","oneOf":[]},"TimesheetPeriodId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"CustomFieldCurrency":{"type":"string","description":"* `CHF`\n* `ARS`\n* `MXN`\n* `QAR`\n* `SAR`\n* `CLP`\n* `ZAR`\n* `INR`\n* `VND`\n* `THB`\n* `CNY`\n* `AUD`\n* `ILS`\n* `KRW`\n* `JPY`\n* `PLN`\n* `GBP`\n* `IDR`\n* `HUF`\n* `AMD`\n* `PHP`\n* `BYR`\n* `TRY`\n* `BWP`\n* `RUB`\n* `AED`\n* `HKD`\n* `TWD`\n* `EUR`\n* `COP`\n* `DKK`\n* `USD`\n* `CAD`\n* `MYR`\n* `NOK`\n* `RON`\n* `SGD`\n* `CZK`\n* `AZN`\n* `PEN`\n* `SEK`\n* `NZD`\n* `BRL`\n* `UAH`","enum":["CHF","ARS","MXN","QAR","SAR","CLP","ZAR","INR","VND","THB","CNY","AUD","ILS","KRW","JPY","PLN","GBP","IDR","HUF","AMD","PHP","BYR","TRY","BWP","RUB","AED","HKD","TWD","EUR","COP","DKK","USD","CAD","MYR","NOK","RON","SGD","CZK","AZN","PEN","SEK","NZD","BRL","UAH"]},"Booking":{"type":"object","properties":{"responsiblePlaceholderId":{"$ref":"#/components/schemas/PlaceholderId"},"bookingDates":{"$ref":"#/components/schemas/BookingDates"},"responsibleId":{"$ref":"#/components/schemas/UserId"},"id":{"$ref":"#/components/schemas/BookingId"},"effortAllocation":{"$ref":"#/components/schemas/BookingEffort"},"title":{"type":"string","description":"Title"},"folderId":{"type":"string","description":"Folder ID"}}},"WorkWeek":{"required":["workDays"],"type":"object","properties":{"workDays":{"type":"array","description":"List of work days","items":{"$ref":"#/components/schemas/WeekDay"}},"capacityMinutes":{"type":"number","description":"Custom capacity in minutes"}}},"FolderId":{"pattern":"^([a-zA-Z0-9-_:\\.=]){1,256}$","type":"string"},"EDiscoveryScope":{"type":"string","description":"* `task`\n* `folder`\n* `attachment`\n* `project`\n* `space`","enum":["task","folder","attachment","project","space"]},"UserCapacityOverrideId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"UserScheduleCapacityChange":{"type":"object","properties":{"finishDate":{"type":"string","description":" Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"id":{"type":"string","description":""},"userId":{"$ref":"#/components/schemas/UserId"},"capacityMinutes":{"type":"number","description":""},"startDate":{"type":"string","description":" Format: yyyy-MM-dd'T'HH:mm:ss'Z'"}}},"AsyncJobResult":{"type":"object","oneOf":[{"$ref":"#/components/schemas/CopyFolderAsyncResult"},{"$ref":"#/components/schemas/BatchOperationAsyncResult"}]},"TimelogLockSource":{"required":["type"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/TaskId"},"type":{"$ref":"#/components/schemas/TimelogLockSourceType"}}},"IdsType":{"type":"string","description":"* `ApiV2Task` - API v2 task\n* `ApiV2Attachment` - API v2 attachment\n* `ApiV2Comment` - API v2 comment\n* `ApiV2Folder` - API v2 folder\n* `ApiV2Timelog` - API v2 timelog entry\n* `ApiV2User` - API v2 user or group\n* `ApiV2Account` - API v2 account\n* `ApiV2RequestForm` - API v2 request form","enum":["ApiV2Task","ApiV2Attachment","ApiV2Comment","ApiV2Folder","ApiV2Timelog","ApiV2User","ApiV2Account","ApiV2RequestForm"]},"SpaceAccessType":{"type":"string","description":"* `Locked`\n* `Personal`\n* `Private`\n* `Public`","enum":["Locked","Personal","Private","Public"]},"TaskBlueprint":{"type":"object","properties":{"childIds":{"type":"array","description":"Child Blueprint IDs","items":{"$ref":"#/components/schemas/TaskBlueprintId"}},"customFields":{"type":"array","description":"Custom fields","items":{"$ref":"#/components/schemas/CustomField"}},"scope":{"$ref":"#/components/schemas/BlueprintTreeScope"},"id":{"$ref":"#/components/schemas/TaskBlueprintId"},"permalink":{"type":"string","description":"Link to open blueprint in web workspace, if user has appropriate access"},"title":{"type":"string","description":"Title"}}},"Apiv3Version":{"type":"object","properties":{"major":{"type":"number","description":"Major version number"},"minor":{"type":"number","description":"Minor version number"}}},"TaskId":{"pattern":"^([a-zA-Z0-9-_:\\.=]){1,256}$","type":"string"},"FieldRollupSettings":{"required":["fieldId","system","isEnabled","canToggle"],"type":"object","properties":{"system":{"type":"boolean","description":"System field"},"isEnabled":{"type":"boolean","description":"Rollup state for field"},"canToggle":{"type":"boolean","description":"Whether the rollup can be toggled for field"},"fieldId":{"type":"string","description":"Id of field: custom field or one of system fields: StartDate, DueDate, Effort, BookedEffort, PlannedFees, ActualFees, PlannedCost, ActualCost, TimeSpent\n"}}},"BatchOperation":{"required":["type","input"],"type":"object","properties":{"input":{"type":"object","additionalProperties":true,"description":"Input parameters for the operation. \nThe structure depends on the operation type: \n
\n
TaskCreate: Required: folderId (parent folder where task will be created) \nSee POST /folders/{folderId}/tasks for full parameter list.\n\n
FolderCreate: Required: folderId (parent folder where folder will be created) \n See POST /folders/{folderId}/folders for full parameter list. \n\n
\n"},"clientId":{"type":"string","description":"Client-provided identifier used to correlate an operation request with its corresponding result in the async job response"},"type":{"$ref":"#/components/schemas/BatchOperationType"}}},"Folder":{"type":"object","properties":{"color":{"$ref":"#/components/schemas/FolderColor"},"customItemTypeId":{"$ref":"#/components/schemas/EntityTypeId"},"childIds":{"type":"array","description":"Child folder IDs","items":{"$ref":"#/components/schemas/FolderId"}},"scope":{"$ref":"#/components/schemas/TreeScope"},"project":{"$ref":"#/components/schemas/FolderProject"},"id":{"$ref":"#/components/schemas/FolderId"},"title":{"type":"string","description":"Title"},"space":{"type":"boolean","description":"Is folder a space"}}},"CustomFieldMirrorField":{"required":["dataHubFieldId","linkToDatabaseCustomFieldId"],"type":"object","properties":{"dataHubFieldId":{"type":"string","description":"DataHub field identifier in DataHub Public API format"},"linkToDatabaseCustomFieldId":{"type":"string","description":"Link to Database custom field id of this mirror"}}},"RescheduleMode":{"type":"string","description":"* `Start` - Tasks in scope are rescheduled starting from reschedule date\n* `End` - Tasks in scope are rescheduled ending with reschedule date","enum":["Start","End"]},"DailyAllocation":{"required":["date","effortMinutes"],"type":"object","properties":{"date":{"type":"string","description":"Allocation date Format: yyyy-MM-dd"},"effortMinutes":{"type":"number","description":"Effort in minutes"}}},"TaskDates":{"type":"object","properties":{"duration":{"type":"number","description":"Duration in minutes. Duration is present in Planned tasks and is optional for Backlog tasks. \nWhen updating duration, ensure to re-submit the start and due dates, even if they are to stay the same. Otherwise, the dates will be cleared. \nWhen present for Planned tasks and due date is not given, this field limit is [1, 1800000). \nNote that 1 day in Wrike is equal to 8 hours, or 480 minutes."},"due":{"type":"string","description":"Due date is present only in Planned and Milestone tasks. When setting this field alone, the task will default to a milestone. Format: yyyy-MM-dd'T'HH:mm:ss ('T'HH:mm:ss is optional)"},"start":{"type":"string","description":"Start date is present only in Planned tasks. Important: If setting a start date, always include either a due date or duration. Format: yyyy-MM-dd'T'HH:mm:ss ('T'HH:mm:ss is optional)"},"workOnWeekends":{"type":"boolean","description":"Weekends are included in task scheduling"},"type":{"$ref":"#/components/schemas/TaskDatesType"}},"description":"Field values limits:\nduration - [0, 1800000)\nstart & due - [1970-01-01T00:00:00, 2100-01-01T00:00:00)"},"TaskBlueprintId":{"pattern":"^([a-zA-Z0-9-_:\\.=]){1,256}$","type":"string"},"BudgetRateSource":{"type":"string","description":"* `JobRole`\n* `User`","enum":["JobRole","User"]},"TimelogFinance":{"type":"object","properties":{"currency":{"type":"string","description":"Currency"},"actualFees":{"type":"number","description":"Actual fees"},"actualCost":{"type":"number","description":"Actual cost"}}},"CustomFieldInfo":{"required":["id","accountId","title","type","sharedIds","sharing","description"],"type":"object","properties":{"accountId":{"$ref":"#/components/schemas/AccountId"},"spaceId":{"$ref":"#/components/schemas/SpaceId"},"settings":{"$ref":"#/components/schemas/CustomFieldSettings"},"sharedIds":{"type":"array","description":"Users with whom the custom field is shared. Field is obsolete, use 'sharing' to get more relevant access settings","items":{"$ref":"#/components/schemas/UserId"}},"description":{"type":"string","description":"Custom field description"},"id":{"$ref":"#/components/schemas/CustomFieldId"},"title":{"type":"string","description":"Custom field title"},"type":{"$ref":"#/components/schemas/CustomFieldType"},"sharing":{"$ref":"#/components/schemas/CustomFieldSharing"},"dataUsageStatistics":{"$ref":"#/components/schemas/DataUsageStatistics"}}},"TaskDatesType":{"type":"string","description":"* `Milestone`\n* `Backlog`\n* `Planned`","enum":["Milestone","Backlog","Planned"]},"TimelogLockStatus":{"type":"string","description":"* `Locked` - Locked\n* `Unlocked` - Unlocked","enum":["Locked","Unlocked"]},"FolderBlueprintId":{"pattern":"^([a-zA-Z0-9-_:\\.=]){1,256}$","type":"string"},"TaskFinance":{"type":"object","properties":{"plannedCost":{"type":"number","description":"Planned cost"},"plannedFees":{"type":"number","description":"Planned fees"},"currency":{"type":"string","description":"Currency"},"actualFees":{"type":"number","description":"Actual fees"},"actualCost":{"type":"number","description":"Actual cost"}}},"EffortMode":{"type":"string","description":"* `Basic`\n* `Flexible`\n* `FullTime`\n* `None`","enum":["Basic","Flexible","FullTime","None"]},"FormFieldItem":{"required":["id","title"],"type":"object","properties":{"id":{"type":"string","description":""},"title":{"type":"string","description":"Form item title"},"selectedByDefault":{"type":"boolean","description":"True if item is selected by default"}}},"FormDateFieldLimit":{"required":["type"],"type":"object","properties":{"days":{"type":"number","description":"Number of days after today"},"from":{"type":"string","description":"Range start date"},"to":{"type":"string","description":"Range end date"},"type":{"$ref":"#/components/schemas/FormDateFieldLimitType"}}},"GroupModifyParam":{"required":["id"],"type":"object","properties":{"addMembers":{"type":"array","description":"Add specified users to group","items":{"$ref":"#/components/schemas/UserId"}},"removeMembers":{"type":"array","description":"Remove specified users from group","items":{"$ref":"#/components/schemas/UserId"}},"id":{"$ref":"#/components/schemas/UserId"}}},"SpaceMember":{"required":["id","accessRoleId","isManager"],"type":"object","properties":{"accessRoleId":{"$ref":"#/components/schemas/AccessRoleId"},"isManager":{"type":"boolean","description":"User is Space manager"},"id":{"$ref":"#/components/schemas/UserId"}}},"BatchOperationType":{"type":"string","description":"* `FolderCreate`\n* `TaskCreate`","enum":["FolderCreate","TaskCreate"]},"TimesheetApprovalStatus":{"type":"string","description":"* `NotSubmitted`\n* `Approved`\n* `Rejected`\n* `Pending`","enum":["NotSubmitted","Approved","Rejected","Pending"]},"ApprovalId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"TaskStatus":{"type":"string","description":"* `Active` - Active\n* `Deferred` - Deferred\n* `Completed` - Completed\n* `Cancelled` - Cancelled","enum":["Active","Deferred","Completed","Cancelled"]},"ResponsibleAllocation":{"required":["dailyAllocation"],"type":"object","properties":{"placeholderId":{"$ref":"#/components/schemas/PlaceholderId"},"dailyAllocation":{"type":"array","description":"Daily allocations","items":{"$ref":"#/components/schemas/DailyAllocation"}},"userId":{"$ref":"#/components/schemas/UserId"}}},"ProjectStatus":{"type":"string","description":"* `Red`\n* `OnHold`\n* `Yellow`\n* `Completed`\n* `Custom`\n* `Cancelled`\n* `Green`","enum":["Red","OnHold","Yellow","Completed","Custom","Cancelled","Green"]},"AccountSubscription":{"required":["type","suspended","paid","userLimit"],"type":"object","properties":{"paid":{"type":"boolean","description":"Subscription is paid (available only to account admins)"},"type":{"$ref":"#/components/schemas/AccountSubscriptionType"},"userLimit":{"type":"number","description":"Limit of subscription users (available only to account admins)"},"suspended":{"type":"boolean","description":"Account is suspended"}}},"FolderChangeHistory":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/FolderProjectHistory"},"id":{"$ref":"#/components/schemas/FolderId"}}},"Task":{"type":"object","properties":{"metadata":{"type":"array","description":"List of task metadata entries","items":{"$ref":"#/components/schemas/Metadata"}},"importance":{"$ref":"#/components/schemas/TaskImportance"},"customFields":{"type":"array","description":"Custom fields","items":{"$ref":"#/components/schemas/CustomField"}},"followerIds":{"type":"array","description":"List of user IDs, who follows task","items":{"$ref":"#/components/schemas/UserId"}},"parentIds":{"type":"array","description":"List of task parent folder IDs","items":{"$ref":"#/components/schemas/FolderId"}},"description":{"type":"string","description":"Description"},"responsiblePlaceholderIds":{"type":"array","description":"List of placeholder assignee Ids","items":{"$ref":"#/components/schemas/PlaceholderId"}},"updatedDate":{"type":"string","description":"Updated date Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"title":{"type":"string","description":"Title, cannot be empty"},"followedByMe":{"type":"boolean","description":"Is a task followed by me"},"billingType":{"$ref":"#/components/schemas/BillingType"},"scope":{"$ref":"#/components/schemas/TreeScope"},"id":{"$ref":"#/components/schemas/TaskId"},"effortAllocation":{"$ref":"#/components/schemas/TaskEffort"},"hasAttachments":{"type":"boolean","description":"Has attachments"},"subTaskIds":{"type":"array","description":"List of subtask IDs","items":{"$ref":"#/components/schemas/TaskId"}},"recurrent":{"type":"boolean","description":"Is a task recurrent"},"authorIds":{"type":"array","description":"List of author IDs (currently contains 1 element)","items":{"$ref":"#/components/schemas/UserId"}},"responsibleIds":{"type":"array","description":"List of assignee user IDs","items":{"$ref":"#/components/schemas/UserId"}},"customItemTypeId":{"$ref":"#/components/schemas/EntityTypeId"},"sharedIds":{"type":"array","description":"Users with whom the task is shared","items":{"$ref":"#/components/schemas/UserId"}},"dates":{"$ref":"#/components/schemas/TaskDates"},"superTaskIds":{"type":"array","description":"List of super task IDs","items":{"$ref":"#/components/schemas/TaskId"}},"priority":{"type":"string","description":"Ordering key that defines task order in tasklist"},"completedDate":{"type":"string","description":"Completed date Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"superParentIds":{"type":"array","description":"List of folder IDs inherited from parent task","items":{"$ref":"#/components/schemas/FolderId"}},"accountId":{"$ref":"#/components/schemas/AccountId"},"dependencyIds":{"type":"array","description":"List of dependency IDs","items":{"$ref":"#/components/schemas/DependencyId"}},"createdDate":{"type":"string","description":"Created date Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"customStatusId":{"$ref":"#/components/schemas/CustomStatusId"},"attachmentCount":{"type":"number","description":"Total count of task attachments"},"workScheduleId":{"$ref":"#/components/schemas/WorkScheduleId"},"permalink":{"type":"string","description":"Link to open task in web workspace, if user has appropriate access"},"briefDescription":{"type":"string","description":"Brief description"},"finance":{"$ref":"#/components/schemas/TaskFinance"},"status":{"$ref":"#/components/schemas/TaskStatus"}}},"TimelogLockPeriod":{"type":"object","properties":{"start":{"type":"string","description":"Period start Format: yyyy-MM-dd"},"end":{"type":"string","description":"Period end Format: yyyy-MM-dd"},"source":{"$ref":"#/components/schemas/TimelogLockSource"}}},"FormPage":{"required":["id","title","fields"],"type":"object","properties":{"id":{"type":"string","description":""},"title":{"type":"string","description":"Page title"},"fields":{"type":"array","description":"Page fields","items":{"$ref":"#/components/schemas/FormField"}}}},"OperationResult":{"type":"object","properties":{"clientId":{"type":"string"},"errorMessage":{"type":"string"},"errorCode":{"type":"string"},"type":{"type":"string"},"value":{"$ref":"#/components/schemas/OperationOutput"},"status":{"type":"string"}},"description":"Operation result","oneOf":[]},"AsyncJob":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/AsyncJobResult"},"processedCount":{"type":"number","description":"Processed count"},"errorMessage":{"type":"string","description":"Error message"},"progressPercent":{"type":"number","description":"Progress percents"},"id":{"$ref":"#/components/schemas/AsyncJobId"},"totalCount":{"type":"number","description":"Total count"},"type":{"$ref":"#/components/schemas/AsyncJobType"},"status":{"$ref":"#/components/schemas/AsyncJobStatus"}}},"AuditLog":{"type":"object","properties":{"ipAddress":{"type":"string","description":"IP address from which an operation was performed"},"objectName":{"type":"string","description":"Object name"},"userEmail":{"type":"string","description":"Operational user e-mail"},"details":{"type":"object","additionalProperties":{"type":"string"},"description":"Map - Operation details"},"id":{"$ref":"#/components/schemas/AuditLogId"},"operation":{"$ref":"#/components/schemas/AuditLogOperation"},"userId":{"$ref":"#/components/schemas/UserId"},"objectId":{"type":"string","description":"Object ID"},"eventDate":{"type":"string","description":"Date and time when operation was performed Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"objectType":{"$ref":"#/components/schemas/AuditLogObjectType"}}},"RollupFieldFilter":{"required":["id"],"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Whether the field rollup should be enabled. If not provided, the field is included in results regardless of its enabled state"},"id":{"type":"string","description":"Field id (system field name or custom field id)"}}},"BudgetRatesAggregated":{"type":"object","properties":{"billRate":{"$ref":"#/components/schemas/BudgetRate"},"costRate":{"$ref":"#/components/schemas/BudgetRate"},"rateSubjectId":{"$ref":"#/components/schemas/UserId"},"rateSubjectType":{"$ref":"#/components/schemas/BudgetRateSubjectType"}}},"CustomStatusId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"BookingId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"WorkItemMetadata":{"type":"object","properties":{"relatedType":{"type":"string","enum":["Project","Task"]},"id":{"$ref":"#/components/schemas/TaskId"}}},"WorkScheduleId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"AsyncJobStatus":{"type":"string","description":"* `InQueue`\n* `Failed`\n* `Completed`\n* `InProgress`","enum":["InQueue","Failed","Completed","InProgress"]},"FormField":{"required":["id","title","type","mandatory"],"type":"object","properties":{"dateFormat":{"type":"string","description":"Date field format"},"limit":{"$ref":"#/components/schemas/FormDateFieldLimit"},"id":{"type":"string","description":""},"title":{"type":"string","description":"Form field title"},"type":{"$ref":"#/components/schemas/FormFieldType"},"mandatory":{"type":"boolean","description":"True if field is mandatory"},"helperText":{"type":"string","description":"Helper text for field"},"items":{"type":"array","description":"Field items","items":{"$ref":"#/components/schemas/FormFieldItem"}},"prompt":{"type":"string","description":"Text field prompt"},"lineCount":{"type":"number","description":"Text area line count"}}},"TreeScope":{"type":"string","description":"* `WsTask` - Task in account\n* `RbRoot` - Virtual Recycle Bin folder of account\n* `RbFolder` - Folder is in Recycle Bin (deleted folder)\n* `WsFolder` - Folder in account\n* `WsRoot` - Virtual root folder of account\n* `RbTask` - Task is in Recycle Bin (deleted task)","enum":["WsTask","RbRoot","RbFolder","WsFolder","WsRoot","RbTask"]},"ContactChangeHistory":{"type":"object","properties":{"costRateHistory":{"type":"array","description":"Cost rate change history","items":{"$ref":"#/components/schemas/BudgetRateHistoryItem"}},"billRateHistory":{"type":"array","description":"Bill rate change history","items":{"$ref":"#/components/schemas/BudgetRateHistoryItem"}},"id":{"$ref":"#/components/schemas/UserId"}}},"Invitation":{"type":"object","properties":{"userTypeId":{"type":"string","description":"Invited User Type ID"},"accountId":{"$ref":"#/components/schemas/AccountId"},"firstName":{"type":"string","description":"First Name"},"lastName":{"type":"string","description":"LastName"},"external":{"type":"boolean","description":"Is user external"},"inviterUserId":{"$ref":"#/components/schemas/UserId"},"role":{"$ref":"#/components/schemas/UserRole"},"id":{"$ref":"#/components/schemas/InvitationId"},"email":{"type":"string","description":"Email"},"status":{"$ref":"#/components/schemas/InvitationStatus"},"invitationDate":{"type":"string","description":"Date when invitation was created Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"resolvedDate":{"type":"string","description":"Date when the invitation was resolved Format: yyyy-MM-dd'T'HH:mm:ss'Z'"}}},"CustomFieldType":{"type":"string","description":"* `Multiple` - Collection field\n* `Percentage` - Comparable field\n* `Text` - String field, Comparable field\n* `Duration` - Comparable field\n* `CalculatedNumeric` - Calculated comparable field\n* `Date` - Comparable field\n* `CalculatedDate` - Calculated comparable field\n* `Numeric` - Comparable field\n* `Contacts` - Collection field\n* `Checkbox` - Boolean field\n* `Currency` - Comparable field\n* `DropDown` - String field, Comparable field\n* `LinkToDatabase` - Link to database field","enum":["Multiple","Percentage","Text","Duration","CalculatedNumeric","Date","CalculatedDate","Numeric","Contacts","Checkbox","Currency","DropDown","LinkToDatabase"]},"TaskImportance":{"type":"string","description":"* `High`\n* `Low`\n* `Normal`","enum":["High","Low","Normal"]},"DataExportColumnDataType":{"type":"string","description":"* `Number`\n* `String`\n* `Boolean`\n* `Date`","enum":["Number","String","Boolean","Date"]},"DataUsageStatistics":{"required":["spaceDataPoints"],"type":"object","properties":{"spaceDataPoints":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Datapoint"},"description":"Map - Space data points"},"accountDataPoints":{"$ref":"#/components/schemas/Datapoint"}}},"CustomFieldScope":{"type":"string","description":"* `Space` - Use it with valid 'spaceId' parameter to move custom field to space level\n* `Account` - Use it with null 'spaceId' parameter to move custom field to account level","enum":["Space","Account"]},"TimelogCategoryId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"TimesheetSubmissionRule":{"type":"object","properties":{"trackExceptionsMode":{"$ref":"#/components/schemas/TimesheetSubmissionRuleTrackExceptionsMode"},"ruleType":{"$ref":"#/components/schemas/TimesheetSubmissionRuleType"},"workScheduleId":{"$ref":"#/components/schemas/WorkScheduleId"},"enabled":{"type":"boolean","description":"Current state of timesheet submission rule"},"frequency":{"$ref":"#/components/schemas/TimesheetSubmissionRuleFrequency"}}},"ContractType":{"type":"string","description":"* `Billable` - Billable\n* `NonBillable` - Non-Billable","enum":["Billable","NonBillable"]},"WorkScheduleExclusionType":{"type":"string","description":"* `PublicHolidays` - Non-working days because of public holidays\n* `OtherEvent` - Non-working days because of some company or private event\n* `AdditionalWorkDays` - Additional working days, i.e. during weekends","enum":["PublicHolidays","OtherEvent","AdditionalWorkDays"]},"InvitationId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"FolderProject":{"required":["ownerIds","status"],"type":"object","properties":{"createdDate":{"type":"string","description":"Project created date Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"ownerIds":{"type":"array","description":"List of project owner IDs","items":{"$ref":"#/components/schemas/UserId"}},"endDate":{"type":"string","description":"Project end date Format: yyyy-MM-dd"},"contractType":{"$ref":"#/components/schemas/ContractType"},"customStatusId":{"$ref":"#/components/schemas/CustomStatusId"},"authorId":{"$ref":"#/components/schemas/UserId"},"startDate":{"type":"string","description":"Project start date Format: yyyy-MM-dd"},"completedDate":{"type":"string","description":"Project completed date Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"finance":{"$ref":"#/components/schemas/FolderProjectFinance"},"status":{"$ref":"#/components/schemas/ProjectStatus"}}},"Rates":{"type":"object","properties":{"rateValue":{"type":"number","description":"Rate value is displayed to 2 decimal places. More digits will be rounded arithmetically to 2 decimal places. No need to specify rate value if rate source is \"job role\""},"rateType":{"$ref":"#/components/schemas/BudgetRateType"},"contact":{"$ref":"#/components/schemas/UserId"},"rateSource":{"$ref":"#/components/schemas/BudgetRateSource"}}},"TimesheetRow":{"required":["rowId","type","parentIds","taskId","categoryId","weeklyEntries"],"type":"object","properties":{"parentIds":{"type":"array","description":"List of entry parent folder IDs","items":{"$ref":"#/components/schemas/FolderId"}},"type":{"$ref":"#/components/schemas/EntityTypeId"},"weeklyEntries":{"type":"array","description":"List of weekly entries per row","items":{"$ref":"#/components/schemas/TimesheetRowWeeklyEntry"}},"taskId":{"type":"string","description":"Task ID associated with this row"},"categoryId":{"$ref":"#/components/schemas/TimelogCategoryId"},"rowId":{"$ref":"#/components/schemas/TimesheetRowId"}}},"UserScheduleExclusionType":{"type":"string","description":"* `VacationPTO` - Paid vacations\n* `Overtime` - Additional working days\n* `OtherNonWorking` - Other non-working days","enum":["VacationPTO","Overtime","OtherNonWorking"]},"DataExportId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"RequestParam":{"required":["fieldId","values"],"type":"object","properties":{"values":{"type":"array","description":"Field submit values","items":{"type":"string"}},"fieldId":{"type":"string","description":"Form Field ID"}}},"User":{"type":"object","properties":{"userTypeId":{"type":"string","description":"User Type Id"},"lastName":{"type":"string","description":"Last name"},"metadata":{"type":"array","description":"List of contact metadata entries. Requesting user has read/write access to his own metadata, other entries are read-only","items":{"$ref":"#/components/schemas/Metadata"}},"avatarUrl":{"type":"string","description":"Avatar URL"},"timezone":{"type":"string","description":"Timezone Id, e.g 'America/New_York'"},"companyName":{"type":"string","description":"User Company Name"},"profiles":{"type":"array","description":"List of user profiles in accounts accessible for requesting user","items":{"$ref":"#/components/schemas/UserProfile"}},"type":{"type":"string","enum":["Group","Asset","Person","Robot"]},"locale":{"type":"string","description":"Locale"},"title":{"type":"string","description":"User Title"},"firstName":{"type":"string","description":"First name"},"deleted":{"type":"boolean","description":"True if user is deleted, false otherwise"},"phone":{"type":"string","description":"User phone"},"me":{"type":"boolean","description":"Field is present and set to true only for requesting user"},"myTeam":{"type":"boolean","description":"Field is present and set to true for My Team (default) group"},"location":{"type":"string","description":"User location"},"id":{"$ref":"#/components/schemas/UserId"},"memberIds":{"type":"array","description":"List of group members contact IDs (field is present only for groups)","items":{"$ref":"#/components/schemas/UserId"}},"primaryEmail":{"type":"string","description":"Primary Email"}}},"UserProfile":{"required":["accountId","email","role","external","admin","owner","active"],"type":"object","properties":{"owner":{"type":"boolean","description":"Is user account owner"},"accountId":{"$ref":"#/components/schemas/AccountId"},"external":{"type":"boolean","description":"Is user external"},"role":{"$ref":"#/components/schemas/UserRole"},"admin":{"type":"boolean","description":"Is user account admin"},"active":{"type":"boolean","description":"Is user active in account"},"email":{"type":"string","description":"Email address associated with account"}}},"BudgetRateType":{"type":"string","description":"* `Bill`\n* `Cost`","enum":["Bill","Cost"]},"BatchOperationAsyncResult":{"type":"object","properties":{"operations":{"$ref":"#/components/schemas/OperationResult"}},"description":"Async batch operation result","oneOf":[]},"TimesheetApproval":{"required":["submitterId","submissionChangeDate","approvalStatus","approverId","approvalChangeDate"],"type":"object","properties":{"approvalStatus":{"$ref":"#/components/schemas/TimesheetApprovalStatus"},"approvalChangeDate":{"type":"string","description":"Date of when the timesheet was approved or rejected Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"submitterId":{"type":"string","description":"User ID of the person who submitted the timesheet"},"approverId":{"type":"string","description":"User ID of the approver"},"submissionChangeDate":{"type":"string","description":"Date of when the timesheet was submitted Format: yyyy-MM-dd'T'HH:mm:ss'Z'"}}},"FolderProjectFinance":{"type":"object","properties":{"plannedCost":{"type":"number","description":"Planned cost"},"plannedFees":{"type":"number","description":"Planned fees"},"currency":{"type":"string","description":"Currency"},"actualFees":{"type":"number","description":"Actual fees"},"actualCost":{"type":"number","description":"Actual cost"},"budget":{"type":"number","description":"Budget"}}},"Timelog":{"type":"object","properties":{"approvalStatus":{"$ref":"#/components/schemas/TimesheetApprovalStatus"},"hours":{"type":"number","description":"Hours tracked in timelog record, must be in [0..24] hours range"},"exportStatus":{"$ref":"#/components/schemas/TimelogExportStatus"},"updatedDate":{"type":"string","description":"Date of timelog was updated Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"userId":{"$ref":"#/components/schemas/UserId"},"createdDate":{"type":"string","description":"Date of timelog was created Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"lockStatus":{"$ref":"#/components/schemas/TimelogLockStatus"},"billingType":{"$ref":"#/components/schemas/BillingType"},"trackedDate":{"type":"string","description":"Date for which timelog was recorded Format: yyyy-MM-dd"},"comment":{"type":"string","description":"Timelog record comment"},"id":{"$ref":"#/components/schemas/TimelogId"},"taskId":{"$ref":"#/components/schemas/TaskId"},"categoryId":{"$ref":"#/components/schemas/TimelogCategoryId"},"finance":{"$ref":"#/components/schemas/TimelogFinance"}}},"DataExportTableSchema":{"type":"object","properties":{"columns":{"type":"array","description":"List of exported columns","items":{"$ref":"#/components/schemas/DataExportColumnSchema"}},"alias":{"type":"string","description":"Table alias"},"id":{"type":"string","description":"Table id"}}},"BlueprintTreeScope":{"type":"string","description":"* `TaskBp` - Task Blueprint in account\n* `BpRoot` - Virtual blueprint root of account\n* `FolderBp` - Folder Blueprint in account","enum":["TaskBp","BpRoot","FolderBp"]},"TimesheetRowWeeklyEntry":{"required":["date","entriesIds","sum"],"type":"object","properties":{"date":{"type":"string","description":"Date of the entry Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"entriesIds":{"type":"array","description":"List of time entry IDs","items":{"$ref":"#/components/schemas/TimelogId"}},"sum":{"type":"number","description":"Sum of hours logged for this date"}}},"TimesheetSubmissionRuleType":{"type":"string","description":"* `Hard` - Hard\n* `Soft` - Soft","enum":["Hard","Soft"]},"DataExportVersion":{"type":"string","description":"* `V0`\n* `V1`\n* `V2`\n* `V3`","enum":["V0","V1","V2","V3"]},"Comment":{"type":"object","properties":{"externalRequester":{"$ref":"#/components/schemas/ExternalRequester"},"createdDate":{"type":"string","description":"Created date Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"id":{"$ref":"#/components/schemas/CommentId"},"text":{"type":"string","description":"Comment text"},"updatedDate":{"type":"string","description":"Deprecated because this field gets created date instead of updated date. Please use the createdDate field instead. Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"authorId":{"$ref":"#/components/schemas/UserId"},"type":{"$ref":"#/components/schemas/CommentType"},"emailSubject":{"type":"string","description":"The subject in case of email comment"},"taskId":{"type":"string","description":"ID of related task. Only one of taskId/folderId fields is present"},"folderId":{"type":"string","description":"ID of related folder. Only one of taskId/folderId fields is present"},"direction":{"type":"string","description":"The direction (Outgoing/Incoming) in case of email comment"}}},"DataExportResource":{"required":["name","url"],"type":"object","properties":{"name":{"type":"string","description":"Name of exported resource"},"url":{"type":"string","description":"Link to a file of exported resource"}}},"SpaceId":{"pattern":"^([a-zA-Z0-9-_:\\.=]){1,256}$","type":"string"},"SortOrder":{"type":"string","description":"* `Asc` - Ascending sort order\n* `Desc` - Descending sort order","enum":["Asc","Desc"]},"AttachmentId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"CommentId":{"pattern":"^([A-Z0-9]){16}$","type":"string"},"Contact":{"type":"object","properties":{"lastName":{"type":"string","description":"Last name"},"metadata":{"type":"array","description":"List of contact metadata entries. Requesting user has read/write access to his own metadata, other entries are read-only","items":{"$ref":"#/components/schemas/Metadata"}},"avatarUrl":{"type":"string","description":"Avatar URL"},"timezone":{"type":"string","description":"Timezone Id, e.g 'America/New_York'"},"currentCostRate":{"$ref":"#/components/schemas/BudgetRate"},"customFields":{"type":"array","description":"Custom fields","items":{"$ref":"#/components/schemas/CustomField"}},"companyName":{"type":"string","description":"User Company Name"},"profiles":{"type":"array","description":"List of user profiles in accounts accessible for requesting user","items":{"$ref":"#/components/schemas/UserProfile"}},"type":{"type":"string","enum":["Group","Asset","Person","Robot"]},"locale":{"type":"string","description":"Locale"},"title":{"type":"string","description":"User Title"},"firstName":{"type":"string","description":"First name"},"deleted":{"type":"boolean","description":"True if user is deleted, false otherwise"},"phone":{"type":"string","description":"User phone"},"currentBillRate":{"$ref":"#/components/schemas/BudgetRate"},"me":{"type":"boolean","description":"Field is present and set to true only for requesting user"},"myTeam":{"type":"boolean","description":"Field is present and set to true for My Team (default) group"},"jobRoleId":{"$ref":"#/components/schemas/JobRoleId"},"location":{"type":"string","description":"User location"},"workScheduleId":{"$ref":"#/components/schemas/WorkScheduleId"},"id":{"$ref":"#/components/schemas/UserId"},"memberIds":{"type":"array","description":"List of group members contact IDs (field is present only for groups)","items":{"$ref":"#/components/schemas/UserId"}},"primaryEmail":{"type":"string","description":"Primary Email"}}},"UserId":{"pattern":"^([A-Z0-9]){8}$","type":"string"},"DependencyRelationType":{"type":"string","description":"* `FinishToFinish` - Finish to finish. Allowed only when predecessor and successor are Planned or Milestone tasks\n* `StartToStart` - Start to start. Allowed only when both predecessor and successor are Planned tasks\n* `StartToFinish` - Start to finish. Allowed only when predecessor is Planned, and successor is Planned or Milestone task\n* `FinishToStart` - Finish to start. Allowed only when predecessor is Planned or Milestone, and successor is Planned task","enum":["FinishToFinish","StartToStart","StartToFinish","FinishToStart"]},"CustomField":{"required":["id","value"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/CustomFieldId"},"value":{"type":"string","description":"Custom field value. 4000 characters max. Should be valid string according to JSON RFC 8259. In particular, following characters must be escaped: quotation mark, reverse solidus, and the control characters (U+0000 through U+001F). Any character may be escaped, but unnecessarily escaped character can be implicitly translated to it's unescaped version. In addition to RFC 8259 requirements, it is not recommended to use any of control characters in CF value. Wrike's API forbids using U+0000 in every place and U+0011 at the beginning of the CF value string. The correct way for setting multiple values in the multiple select Custom fields is ?customFields=[{\"id\":\"CustomFieldId\",\"value\":\"[\\\"value1\\\",\\\"value2\\\"]\"}] The correct way for setting values in the people Custom fields is ?customFields=[{\"id\":\"CustomFieldId\",\"value\":\"UserId1, UserId2\"}] Note that if custom field values are passed to API as URI param of request, they must be URI encoded. Here are some examples: \"%5c\" - reverse solidus (backslash) \"%5c%22\" - quotation mark \"Vi%5Cu1ec7t\" - unicode-escaped character in word \"Việt\" "}}},"TimesheetSubmissionRuleTrackExceptionsMode":{"type":"string","description":"* `TotalCapacity` - Total Capacity\n* `ActualCapacity` - Actual Capacity","enum":["TotalCapacity","ActualCapacity"]},"AuditLogObjectType":{"type":"string","description":"* `Account`\n* `Group`\n* `AnalyzeReportWidget`\n* `Task`\n* `User`\n* `WorkspaceSnapshot`\n* `TimesheetTimeframeSettings`\n* `CalendarExternalLink`\n* `Attachment`\n* `Folder`\n* `DataExport`\n* `PowerBIEntity`\n* `Whiteboard`\n* `Space`\n* `Comment`\n* `RequestForm`\n* `AccessRole`\n* `Timesheet`\n* `Invitation`\n* `Workflow`\n* `AnalyzeReport`\n* `Oauth2Client`\n* `Project`\n* `PublicLink`\n* `UserRole`\n* `CustomField`\n* `UserType`","enum":["Account","Group","AnalyzeReportWidget","Task","User","WorkspaceSnapshot","TimesheetTimeframeSettings","CalendarExternalLink","Attachment","Folder","DataExport","PowerBIEntity","Whiteboard","Space","Comment","RequestForm","AccessRole","Timesheet","Invitation","Workflow","AnalyzeReport","Oauth2Client","Project","PublicLink","UserRole","CustomField","UserType"]},"CustomFieldSettingsParam":{"type":"object","properties":{"allowOtherValues":{"type":"boolean","description":"Allow users to input other values (only for DropDown type)","default":"true"},"optionColorsEnabled":{"type":"boolean","description":"Is colors for options enabled (only for DropDown and MultipleSelect type). Use parameter 'options' to specify colors"},"useThousandsSeparator":{"type":"boolean","description":"Use thousands separator (only for Numeric type)","default":"false"},"linkToDatabaseInfo":{"$ref":"#/components/schemas/CustomFieldLinkToDatabaseFieldParam"},"decimalPlaces":{"type":"number","description":"Decimal places (only for Numeric, Percentage and Currency types)","default":"2"},"values":{"type":"array","description":"Dropdown values without colors (only for DropDown and MultipleSelect type)","items":{"type":"string"}},"options":{"type":"array","description":"Dropdown options with colors (only for DropDown and MultipleSelect type). Array of objects:\n{\"value\": \"string\", \"color\": \"enum: Brown, Red, Purple, Indigo, DarkBlue, Blue, Turquoise, DarkCyan, Green, YellowGreen, Yellow, Orange, Gray, DarkRed\"}\n","items":{"$ref":"#/components/schemas/CustomFieldDropdownOption"}},"currency":{"$ref":"#/components/schemas/CustomFieldCurrency"},"aggregation":{"$ref":"#/components/schemas/CustomFieldAggregationType"},"applicableEntityTypes":{"type":"array","description":"Applicable entity types","items":{"$ref":"#/components/schemas/CustomFieldApplicableEntityType"},"default":"WorkItem"},"contacts":{"type":"array","description":"Allowed users or invitations (only for Users type)","items":{"$ref":"#/components/schemas/UserId"}},"inheritanceType":{"type":"string","enum":["All","Projects","Folders"]}}},"CustomItemType":{"type":"object","properties":{"spaceId":{"$ref":"#/components/schemas/SpaceId"},"relatedType":{"type":"string","enum":["Project","Task"]},"customFieldIds":{"type":"array","description":"Custom fields that are available","items":{"$ref":"#/components/schemas/CustomFieldId"}},"isDeleted":{"type":"boolean","description":"Custom item type is deleted"},"archivedOn":{"type":"string","description":"Archived date Format: yyyy-MM-dd'T'HH:mm:ss'Z'"},"icon":{"$ref":"#/components/schemas/WorkTypeIcon"},"description":{"type":"string","description":"Custom item type description"},"id":{"$ref":"#/components/schemas/EntityTypeId"},"title":{"type":"string","description":"Work type Title"},"dataUsageStatistics":{"$ref":"#/components/schemas/DataUsageStatistics"},"archivedBy":{"$ref":"#/components/schemas/UserId"}}}},"responses":{},"securitySchemes":{"HTTP":{"type":"http","description":"Use OAuth 2.0 access token or permanent access token for authorization.","scheme":"bearer","bearerFormat":"JWT"}}}}