Example content.
\",\n \"createdAt\": \"2025-03-12T16:11:26Z\",\n \"creatorId\": \"2417c06f-44fe-4913-8c84-cd5d358d6f4b\",\n \"entityId\": \"9edc4eb8-2b52-454a-bacf-c1d3889a1fbd\",\n \"entityType\": \"company\",\n \"id\": \"8c9508c6-ccbb-4f94-939e-5c1c1b0302cb\",\n \"object\": \"note\",\n \"title\": \"Example Note\"\n}"}},"schema":{"type":"object","properties":{"content":{"type":"string","example":"Example content.
"},"createdAt":{"type":"string","example":"2025-03-12T16:11:26Z"},"creatorId":{"type":"string","example":"2417c06f-44fe-4913-8c84-cd5d358d6f4b"},"entityId":{"type":"string","example":"9edc4eb8-2b52-454a-bacf-c1d3889a1fbd"},"entityType":{"type":"string","example":"company"},"id":{"type":"string","example":"8c9508c6-ccbb-4f94-939e-5c1c1b0302cb"},"object":{"type":"string","example":"note"},"title":{"type":"string","example":"Example Note"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"List Notes","description":"This API endpoint retrieves a list of notes on clients or companies in your workspace.Example content.
\",\n \"createdAt\": \"2025-03-12T16:09:26Z\",\n \"creatorId\": \"2417c06f-44fe-4913-8c84-cd5d358d6f4b\",\n \"entityId\": \"9edc4eb8-2b52-454a-bacf-c1d3889a1fbd\",\n \"entityType\": \"company\",\n \"id\": \"22f09cc7-a28f-453a-b39e-f017e4a79484\",\n \"object\": \"note\",\n \"title\": \"Example Note 2\"\n },\n {\n \"content\": \"Example content.
\",\n \"createdAt\": \"2025-03-11T20:29:14Z\",\n \"creatorId\": \"2417c06f-44fe-4913-8c84-cd5d358d6f4b\",\n \"entityId\": \"9edc4eb8-2b52-454a-bacf-c1d3889a1fbd\",\n \"entityType\": \"company\",\n \"id\": \"20a7d78e-9bd1-4b76-a763-bb29603542a4\",\n \"object\": \"note\",\n \"title\": \"Example Note 3\"\n }\n ],\n \"nextToken\": \"eyJwa2V5IjoiOGY0MzM1ZmQtNzc5Yi00Mzc2LWIwZTUtZTc2ODQ4MjFiZDg3Iiwic2tleSI6Ik5PVEUiLCJkYXRhIjoidXdQbm5HYTlwI0NPTVBBTlkjOWVkYzRlYjgtMmI1Mi00NTRhLWJhY2YtYzFkMzg4OWExZmJkIzIwMjUtMDMtMDRUMTc6MDg6NDAtMDU6MDAifQ==\"\n}"}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"content":{"type":"string","example":"Example content.
"},"createdAt":{"type":"string","example":"2025-03-12T16:09:26Z"},"creatorId":{"type":"string","example":"2417c06f-44fe-4913-8c84-cd5d358d6f4b"},"entityId":{"type":"string","example":"9edc4eb8-2b52-454a-bacf-c1d3889a1fbd"},"entityType":{"type":"string","example":"company"},"id":{"type":"string","example":"22f09cc7-a28f-453a-b39e-f017e4a79484"},"object":{"type":"string","example":"note"},"title":{"type":"string","example":"Example Note 2"},"updatedAt":{"type":"string"}}}},"nextToken":{"type":"string","example":"eyJwa2V5IjoiOGY0MzM1ZmQtNzc5Yi00Mzc2LWIwZTUtZTc2ODQ4MjFiZDg3Iiwic2tleSI6Ik5PVEUiLCJkYXRhIjoidXdQbm5HYTlwI0NPTVBBTlkjOWVkYzRlYjgtMmI1Mi00NTRhLWJhY2YtYzFkMzg4OWExZmJkIzIwMjUtMDMtMDRUMTc6MDg6NDAtMDU6MDAifQ=="}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v1/notes/{id}":{"patch":{"summary":"Update Note","description":"This API endpoint updates a specific note.Example updated content.
\",\n \"createdAt\": \"2025-03-12T15:11:57Z\",\n \"creatorId\": \"2417c06f-44fe-4913-8c84-cd5d358d6f4b\",\n \"entityId\": \"a29d0731-2e2b-4b94-9112-ea375517ab31\",\n \"entityType\": \"client\",\n \"id\": \"b47170e8-7ea0-485a-8395-0600bffb8718\",\n \"object\": \"note\",\n \"title\": \"Example Note\"\n}"}},"schema":{"type":"object","properties":{"content":{"type":"string","example":"Example updated content.
"},"createdAt":{"type":"string","example":"2025-03-12T15:11:57Z"},"creatorId":{"type":"string","example":"2417c06f-44fe-4913-8c84-cd5d358d6f4b"},"entityId":{"type":"string","example":"a29d0731-2e2b-4b94-9112-ea375517ab31"},"entityType":{"type":"string","example":"client"},"id":{"type":"string","example":"b47170e8-7ea0-485a-8395-0600bffb8718"},"object":{"type":"string","example":"note"},"title":{"type":"string","example":"Example Note"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"get":{"summary":"Retrieve Note","description":"This API endpoint retrieves a specific note.","operationId":"retrieve-note","parameters":[{"name":"id","in":"path","description":"The ID of the note to retrieve.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"content\": \"Example content.
\",\n \"createdAt\": \"2025-03-11T20:29:14Z\",\n \"creatorId\": \"2417c06f-44fe-4913-8c84-cd5d358d6f4b\",\n \"entityId\": \"9edc4eb8-2b52-454a-bacf-c1d3889a1fbd\",\n \"entityType\": \"company\",\n \"id\": \"20a7d78e-9bd1-4b76-a763-bb29603542a4\",\n \"object\": \"note\",\n \"title\": \"Example Note\"\n}"}},"schema":{"type":"object","properties":{"content":{"type":"string","example":"Example content.
"},"createdAt":{"type":"string","example":"2025-03-11T20:29:14Z"},"creatorId":{"type":"string","example":"2417c06f-44fe-4913-8c84-cd5d358d6f4b"},"entityId":{"type":"string","example":"9edc4eb8-2b52-454a-bacf-c1d3889a1fbd"},"entityType":{"type":"string","example":"company"},"id":{"type":"string","example":"20a7d78e-9bd1-4b76-a763-bb29603542a4"},"object":{"type":"string","example":"note"},"title":{"type":"string","example":"Example Note"},"updatedAt":{"type":"string"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Delete Note","description":"This API endpoint permanently removes a specific note.","operationId":"delete-note","parameters":[{"name":"id","in":"path","description":"The ID of the note to delete.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"20a7d78e-9bd1-4b76-a763-bb29603542a4\",\n \"object\": \"note\",\n \"deleted\": true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"20a7d78e-9bd1-4b76-a763-bb29603542a4"},"object":{"type":"string","example":"note"},"deleted":{"type":"boolean","example":true,"default":true}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v1/notifications":{"get":{"summary":"List Notifications","description":"Lists notifications for a workspace.","operationId":"list-notifications","parameters":[{"name":"recipientId","in":"query","description":"Deprecated in favor of recipientClientId and recipientInternalUserId","schema":{"type":"string"}},{"name":"includeRead","in":"query","description":"Includes read notifications.","schema":{"type":"boolean","default":false}},{"in":"query","name":"recipientClientId","schema":{"type":"string"},"description":"ID of the client to fetch notifications for."},{"in":"query","name":"recipientInternalUserId","schema":{"type":"string"},"description":"ID of the client to fetch notifications for."}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"data":[{"createdAt":"2024-02-23T18:52:54.338474874Z","deliveryTargets":{"inProduct":{"title":"Invoice was paid","isRead":false,"ctaParams":{"foo":"bar"}}},"event":"invoice.paid","id":"dc0f1749-7d01-48b7-bd80-fcbfce835642:in_1On3rOFdviIHOKAnf02di30Z","object":"notification","recipientId":"dc0f1749-7d01-48b7-bd80-fcbfce835642","recipientInternalUserId":"dc0f1749-7d01-48b7-bd80-fcbfce835642","resourceId":"in_1On3rOFdviIHOKAnf02di30Z","senderId":"e960feb9-3b49-45b5-8e15-9202acced3ac","senderType":"client"},{"createdAt":"2024-02-14T20:37:10.107854781Z","deliveryTargets":{"inProduct":{"title":"Invoice was paid","isRead":false}},"event":"invoice.paid","id":"dc0f1749-7d01-48b7-bd80-fcbfce835642:in_1OjpC3FdviIHOKAnytv6rAmj","object":"notification","recipientId":"dc0f1749-7d01-48b7-bd80-fcbfce835642","recipientInternalUserId":"dc0f1749-7d01-48b7-bd80-fcbfce835642","resourceId":"in_1OjpC3FdviIHOKAnytv6rAmj","senderId":"e960feb9-3b49-45b5-8e15-9202acced3ac","senderType":"client"},{"createdAt":"2024-01-17T18:10:25.98720329Z","deliveryTargets":{"inProduct":{"title":"Contract has been signed","isRead":false},"email":{"subject":"New task","header":"New task assigned","body":"You have a new task to complete.","title":"View Task","ctaParams":{"foo":"bar"}}},"event":"contract.signed","id":"dc0f1749-7d01-48b7-bd80-fcbfce835642:TULkiocSR","object":"notification","recipientId":"dc0f1749-7d01-48b7-bd80-fcbfce835642","recipientInternalUserId":"dc0f1749-7d01-48b7-bd80-fcbfce835642","resourceId":"TULkiocSR","senderId":"e960feb9-3b49-45b5-8e15-9202acced3ac","senderType":"client"},{"channelId":"us-east-1_Gz7TRlAaM/7787061b-21d6-4742-b38d-319f3d18831b/none","createdAt":"2024-01-11T19:49:34.836257802Z","deliveryTargets":{"inProduct":{"title":"2 files were uploaded","isRead":false},"email":{"subject":"New task","header":"New task assigned","body":"You have a new task to complete.","title":"View Task","ctaParams":{"foo":"bar"}}},"event":"files.created","id":"831aec02-070b-4d2c-ad0c-6bda38fdb361/fda6ff10-ce5a-4232-8725-0c7941b60bf2","object":"notification","recipientId":"dc0f1749-7d01-48b7-bd80-fcbfce835642","recipientClientId":"dc0f1749-7d01-48b7-bd80-fcbfce835642","recipientCompanyId":"d15b1422-2e57-42f3-a0ac-0a726d6e1b42","resourceId":"","senderId":"e960feb9-3b49-45b5-8e15-9202acced3ac","senderType":"internalUser"}]}}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"createdAt":{"type":"string","example":"2024-02-23T18:52:54.338474874Z"},"deliveryTargets":{"type":"object","properties":{"inProduct":{"type":"object","properties":{"title":{"type":"string","example":"Invoice was paid"},"isRead":{"type":"boolean","example":false,"default":true},"ctaParams":{"type":"object","properties":{"foo":{"type":"string","example":"bar"}}}}}}},"event":{"type":"string","example":"invoice.paid"},"id":{"type":"string","example":"dc0f1749-7d01-48b7-bd80-fcbfce835642:in_1On3rOFdviIHOKAnf02di30Z"},"object":{"type":"string","example":"notification"},"recipientId":{"type":"string","example":"dc0f1749-7d01-48b7-bd80-fcbfce835642","deprecated":true},"recipientClientId":{"type":"string","example":"dc0f1749-7d01-48b7-bd80-fcbfce835642"},"recipientCompanyId":{"type":"string","example":"dc0f1749-7d01-48b7-bd80-fcbfce835642"},"recipientInternalUserId":{"type":"string","example":"dc0f1749-7d01-48b7-bd80-fcbfce835642"},"resourceId":{"type":"string","example":"in_1On3rOFdviIHOKAnf02di30Z"},"senderId":{"type":"string","example":"e960feb9-3b49-45b5-8e15-9202acced3ac"},"senderType":{"type":"string","example":"client"}}}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"post":{"summary":"Create Notification","description":"Creates a notification in a workspace.","operationId":"create-notification","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["senderId"],"properties":{"senderId":{"type":"string","description":"ID of the entity sending the notification. This can be ID of client user, internal user, or a company."},"recipientId":{"type":"string","description":"Deprecated. Use recipientClientId, recipientCompanyId and recipientInternalUserId instead."},"deliveryTargets":{"properties":{"inProduct":{"properties":{"title":{"type":"string","description":"Title of the notification."},"body":{"type":"string","description":"Body of the notification."},"ctaParams":{"type":"string","description":"Key/value pairs that will be included in the search parameters when clicking on the notification’s call to action in product. This call to action is shown in the Notification Center for internal users.","format":"json"}},"required":["title"],"type":"object"},"email":{"properties":{"subject":{"type":"string","description":"Subject of the email notification."},"header":{"type":"string","description":"Header of the email notification."},"body":{"type":"string","description":"Body of the email notification."},"title":{"type":"string","description":"Call To Action button title in the email notification."},"ctaParams":{"type":"string","description":"Key/value pairs that will be included in the search parameters when clicking on an email notification’s call to action.","format":"json"},"htmlBody":{"type":"string","description":"Html body of the email notification. Allows rich formatting for body of email sent (Used when body field is empty.) Allowlist: p, br, strong/b, em/i, ul, ol, li, a."}},"required":[],"type":"object"}},"required":[],"type":"object","description":"The notification details for each delivery target."},"recipientClientId":{"type":"string","description":"ID of the client receiving the notification. This required when sending a notification to a client."},"recipientCompanyId":{"type":"string","description":"ID of the company receiving the notification. This is required when sending a notification to a client that has more than one company."},"recipientInternalUserId":{"type":"string","description":"ID of the internal user receiving the notification. This is required when sending a notification to an internal user."},"senderCompanyId":{"type":"string","description":"The ID of the company associated with the sender of this notification. This is required when the sender is a client with more than one company."}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"appId":"5b58089c-1e81-439c-b511-01e3e599c23d","createdAt":"2024-02-22T18:17:01.577287641+05:30","deliveryTargets":{"inProduct":{"title":"enquiry was done","body":"details will be sent on mail","isRead":false,"ctaParams":{"foo":"bar"}},"email":{"subject":"New task","header":"New task assigned","body":"You have a new task to complete.","title":"View Task","ctaParams":{"foo":"bar"}}},"event":"customApp.action","id":"bb9405f0-8644-4bb8-bbc8-84a1a05dcc01","object":"notification","recipientId":"5d686cec-6ef8-4394-a62c-0c2fde950669","recipientInternalUserId":"5d686cec-6ef8-4394-a62c-0c2fde950669","resourceId":"3a5981d8-6619-4dc6-b9b9-a791d275bd5c","senderId":"33da2a16-f525-4d4b-99c8-a273f6260f43","senderType":"client"}}},"schema":{"type":"object","properties":{"appId":{"type":"string","example":"5b58089c-1e81-439c-b511-01e3e599c23d"},"createdAt":{"type":"string","example":"2024-02-22T18:17:01.577287641+05:30"},"deliveryTargets":{"type":"object","properties":{"inProduct":{"type":"object","properties":{"title":{"type":"string","example":"enquiry was done"},"body":{"type":"string","example":"details will be sent on mail"},"isRead":{"type":"boolean","example":false,"default":true},"ctaParams":{"type":"object","properties":{"foo":{"type":"string","example":"bar"}}}}},"email":{"type":"object","properties":{"subject":{"type":"string","example":"New task"},"header":{"type":"string","example":"New task assigned"},"body":{"type":"string","example":"You have a new task to complete."},"title":{"type":"string","example":"View Task"},"ctaParams":{"type":"object","properties":{"foo":{"type":"string","example":"bar"}}}}}}},"event":{"type":"string","example":"customApp.action"},"id":{"type":"string","example":"bb9405f0-8644-4bb8-bbc8-84a1a05dcc01"},"object":{"type":"string","example":"notification"},"recipientId":{"type":"string","example":"5d686cec-6ef8-4394-a62c-0c2fde950669","deprecated":true},"recipientClientId":{"type":"string","example":"5d686cec-6ef8-4394-a62c-0c2fde950669"},"recipientCompanyId":{"type":"string","example":"5d686cec-6ef8-4394-a62c-0c2fde950669"},"recipientInternalUserId":{"type":"string","example":"5d686cec-6ef8-4394-a62c-0c2fde950669"},"resourceId":{"type":"string","example":"3a5981d8-6619-4dc6-b9b9-a791d275bd5c"},"senderId":{"type":"string","example":"33da2a16-f525-4d4b-99c8-a273f6260f43"},"senderType":{"type":"string","example":"client"}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}}}},"/v1/notifications/{id}":{"delete":{"summary":"Delete Notification","description":"This API endpoint deletes a notification.","operationId":"delete-notification","parameters":[{"name":"id","in":"path","description":"The ID of the notification to delete.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"Our design services are provided by experienced individuals with industry experience.
Our design services are provided by experienced individuals with industry experience.
Bow before me mortals
","dueDate":null,"id":"b941c6ab-9cac-4fb2-9a11-8830396e3f2e","isArchived":false,"isDeleted":false,"label":"TES-089","name":"Task name","object":"task","parentTaskId":"9fccce1a-644b-4331-9741-113d504e7dee","source":"api","status":"todo","templateId":null,"viewers":[],"attachments":[]}}},"schema":{"type":"object","properties":{"archivedBy":{"type":"string"},"archivedDate":{"type":"string"},"clientId":{"type":"string","example":"aead02ad-bd03-4956-8177-7bd8a24b99e4"},"companyId":{"type":"string","example":"fadf235-af2d-afdaa-adfw-fadfadfar23f"},"completedBy":{"type":"string"},"completedByUserType":{"type":"string"},"completedDate":{"type":"string"},"createdBy":{"type":"string","example":"27024189-ea18-40a7-a5cf-48579c352dee"},"createdDate":{"type":"string","example":"2025-05-06T13:24:22Z"},"creatorType":{"type":"string","example":"internalUser"},"deletedBy":{"type":"string"},"deletedDate":{"type":"string"},"description":{"type":"string","example":"Bow before me mortals
"},"dueDate":{"type":"string"},"id":{"type":"string","example":"b941c6ab-9cac-4fb2-9a11-8830396e3f2e"},"isArchived":{"type":"boolean","example":false,"default":true},"isDeleted":{"type":"boolean","example":false,"default":true},"label":{"type":"string","example":"TES-089"},"name":{"type":"string","example":"Task name"},"object":{"type":"string","example":"task"},"parentTaskId":{"type":"string","example":"9fccce1a-644b-4331-9741-113d504e7dee"},"source":{"type":"string","example":"api"},"status":{"type":"string","example":"todo"},"templateId":{"type":"string"},"viewers":{"type":"array","items":{"properties":{"clientId":{"type":"string"},"companyId":{"type":"string"}},"type":"object"}},"attachments":{"type":"array","items":{"properties":{},"type":"object"}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v1/tasks/{id}":{"get":{"summary":"Retrieve Task","description":"This API endpoint retrieves a specific task by its id.","operationId":"retrieve-task","parameters":[{"name":"id","in":"path","description":"The id of the task to retrieve.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"archivedBy":null,"archivedDate":null,"clientId":"aead02ad-bd03-4956-8177-7bd8a24b99e4","companyId":"a2w2lfa-23es-23bs-233s-252532fgadfa","completedBy":null,"completedByUserType":null,"completedDate":null,"createdBy":"27024189-ea18-40a7-a5cf-48579c352dee","createdDate":"2025-05-06T13:24:22Z","creatorType":"internalUser","deletedBy":null,"deletedDate":null,"description":"Bow before me mortals
","dueDate":null,"id":"b941c6ab-9cac-4fb2-9a11-8830396e3f2e","isArchived":false,"isDeleted":false,"label":"TES-089","name":"Task name","object":"task","parentTaskId":"9fccce1a-644b-4331-9741-113d504e7dee","source":"api","status":"todo","templateId":"b961745d-f7ca-4412-9060-a0eb9147ce9f","viewers":[{"clientId":"987e6543-e21b-12d3-a456-426614174111","companyId":"456e7890-e12b-12d3-a456-426614174222"}],"attachments":[{"id":"eddeb6a1-dfd7-4a60-9c8c-38ceed09bde9","fileName":"expense_template.xlsx","fileSize":12044,"mimeType":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","downloadUrl":"https://...","uploadedBy":"27024189-ea18-40a7-a5cf-48579c352dee","uploadedByUserType":"internalUser","uploadedDate":"2025-05-06T15:22:37Z"}]}}},"schema":{"type":"object","properties":{"archivedBy":{"type":"string"},"archivedDate":{"type":"string"},"clientId":{"type":"string","example":"aead02ad-bd03-4956-8177-7bd8a24b99e4"},"companyId":{"type":"string","example":"a2w2lfa-23es-23bs-233s-252532fgadfa"},"completedBy":{"type":"string"},"completedByUserType":{"type":"string"},"completedDate":{"type":"string"},"createdBy":{"type":"string","example":"27024189-ea18-40a7-a5cf-48579c352dee"},"createdDate":{"type":"string","example":"2025-05-06T13:24:22Z"},"creatorType":{"type":"string","example":"internalUser"},"deletedBy":{"type":"string"},"deletedDate":{"type":"string"},"description":{"type":"string","example":"Bow before me mortals
"},"dueDate":{"type":"string"},"id":{"type":"string","example":"b941c6ab-9cac-4fb2-9a11-8830396e3f2e"},"isArchived":{"type":"boolean","example":false,"default":true},"isDeleted":{"type":"boolean","example":false,"default":true},"label":{"type":"string","example":"TES-089"},"name":{"type":"string","example":"Task name"},"object":{"type":"string","example":"task"},"parentTaskId":{"type":"string","example":"9fccce1a-644b-4331-9741-113d504e7dee"},"source":{"type":"string","example":"api"},"status":{"type":"string","example":"todo"},"templateId":{"type":"string","example":"b961745d-f7ca-4412-9060-a0eb9147ce9f"},"viewers":{"type":"array","items":{"properties":{},"type":"object"}},"attachments":{"type":"array","items":{"properties":{},"type":"object"}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"patch":{"summary":"Update Task","description":"This API endpoint updates a task.","operationId":"update-task","parameters":[{"name":"id","in":"path","description":"The id of the task to update.","schema":{"type":"string"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The name of the task."},"description":{"type":"string","description":"The description of the task."},"status":{"type":"string","description":"The status of the task."},"internalUserId":{"type":"string","description":"The uuid of the internal user assigned to this task."},"clientId":{"type":"string","description":"The uuid of the client user assigned to this task."},"companyId":{"type":"string","description":"The uuid of the company assigned to this task. If assigning to a client user field should be required as well."},"dueDate":{"type":"string","description":"The date the task is due, in RFC3339 format."},"isArchived":{"type":"boolean","description":"Whether to archive the task or not."},"viewers":{"type":"object","description":"The ID of the company or client that you would like to grant viewing access to the task. Viewers can only be added to tasks where the assignee is an internal user. Currently, only one entity (either a client or a company) can be added as a viewer per task.","properties":{"clientId":{"type":"string","description":"If the task viewer is a client, you must add both the clientId and their companyId."},"companyId":{"type":"string","description":"If the task viewer is a company, you must only add the companyId (leave clientId empty)."}}}}}}}},"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"archivedBy":null,"archivedDate":null,"clientId":"aead02ad-bd03-4956-8177-7bd8a24b99e4","companyId":"fadfaa-123g-1235-23412-kjgaliw1241g","completedBy":null,"completedByUserType":null,"completedDate":null,"createdBy":"27024189-ea18-40a7-a5cf-48579c352dee","createdDate":"2025-05-06T13:24:22Z","creatorType":"internalUser","deletedBy":null,"deletedDate":null,"description":"Bow before me mortals
","dueDate":null,"id":"b941c6ab-9cac-4fb2-9a11-8830396e3f2e","isArchived":false,"isDeleted":false,"label":"TES-089","name":"Task name","object":"task","parentTaskId":"9fccce1a-644b-4331-9741-113d504e7dee","source":"api","status":"todo","templateId":null,"viewers":[],"attachments":[]}}},"schema":{"type":"object","properties":{"archivedBy":{"type":"string"},"archivedDate":{"type":"string"},"clientId":{"type":"string","example":"aead02ad-bd03-4956-8177-7bd8a24b99e4"},"companyId":{"type":"string","example":"fadfaa-123g-1235-23412-kjgaliw1241g"},"completedBy":{"type":"string"},"completedByUserType":{"type":"string"},"completedDate":{"type":"string"},"createdBy":{"type":"string","example":"27024189-ea18-40a7-a5cf-48579c352dee"},"createdDate":{"type":"string","example":"2025-05-06T13:24:22Z"},"creatorType":{"type":"string","example":"internalUser"},"deletedBy":{"type":"string"},"deletedDate":{"type":"string"},"description":{"type":"string","example":"Bow before me mortals
"},"dueDate":{"type":"string"},"id":{"type":"string","example":"b941c6ab-9cac-4fb2-9a11-8830396e3f2e"},"isArchived":{"type":"boolean","example":false,"default":true},"isDeleted":{"type":"boolean","example":false,"default":true},"label":{"type":"string","example":"TES-089"},"name":{"type":"string","example":"Task name"},"object":{"type":"string","example":"task"},"parentTaskId":{"type":"string","example":"9fccce1a-644b-4331-9741-113d504e7dee"},"source":{"type":"string","example":"api"},"status":{"type":"string","example":"todo"},"templateId":{"type":"string"},"viewers":{"type":"array","items":{"properties":{"clientId":{"type":"string"},"companyId":{"type":"string"}},"type":"object"}},"attachments":{"type":"array","items":{"properties":{},"type":"object"}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false},"delete":{"summary":"Delete Task","description":"This API endpoint deletes a specific task.","operationId":"delete-task","parameters":[{"name":"id","in":"path","description":"The id of the task to delete.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":"{\n \"id\": \"25bd3f5a-c059-4f68-8a2d-2749016ba451\",\n \"object\": \"task\",\n \"deleted\": true\n}"}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"25bd3f5a-c059-4f68-8a2d-2749016ba451"},"object":{"type":"string","example":"task"},"deleted":{"type":"boolean","example":true,"default":true}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v1/task-templates":{"get":{"summary":"List Task Templates","description":"This API endpoint retrieves a list of task templates created in the workspace.","operationId":"list-task-templates","parameters":[{"name":"limit","in":"query","description":"Max number of records to fetch.","schema":{"type":"integer","format":"int32","default":100}},{"name":"nextToken","in":"query","description":"Next token for pagination.","schema":{"type":"string"}}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"data":[{"createdDate":"2025-05-06T15:22:37Z","description":"Task template description","id":"eddeb6a1-dfd7-4a60-9c8c-38ceed09bde9","name":"Task template created as default","object":"taskTemplate","subTaskTemplates":[{"createdDate":"2025-12-19T15:45:50Z","description":"","id":"a14a5ab1-c480-4f2c-b50b-3b9b61398b8f","name":"Create customer profiles","object":"taskTemplate"},{"createdDate":"2025-12-19T15:45:40Z","description":"","id":"430241f4-52b2-4980-9c10-cc319aa01b60","name":"Define your core values","object":"taskTemplate"},{"createdDate":"2025-12-19T15:45:34Z","description":"","id":"c8dbd1c4-fd47-4e2d-9b45-c922adcdf1ea","name":"Upload purpose statement","object":"taskTemplate"}]}]}}},"schema":{"type":"object","properties":{"createdDate":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"subTaskTemplates":{"type":"array","items":{"properties":{"createdDate":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"}},"type":"object"}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v1/task-templates/{id}":{"get":{"summary":"Retrieve Task Template","description":"This API endpoint retrieves a specific task template by its id.","operationId":"retrieve-task-template","parameters":[{"name":"id","in":"path","description":"The id of the task template to retrieve.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"200","content":{"application/json":{"examples":{"Result":{"value":{"createdDate":"2025-05-06T15:22:37Z","description":"Task template description","id":"eddeb6a1-dfd7-4a60-9c8c-38ceed09bde9","name":"Task template created as default","object":"taskTemplate","subTaskTemplates":[{"createdDate":"2025-12-19T15:45:50Z","description":"","id":"a14a5ab1-c480-4f2c-b50b-3b9b61398b8f","name":"Create customer profiles","object":"taskTemplate"},{"createdDate":"2025-12-19T15:45:40Z","description":"","id":"430241f4-52b2-4980-9c10-cc319aa01b60","name":"Define your core values","object":"taskTemplate"},{"createdDate":"2025-12-19T15:45:34Z","description":"","id":"c8dbd1c4-fd47-4e2d-9b45-c922adcdf1ea","name":"Upload purpose statement","object":"taskTemplate"}]}}},"schema":{"type":"object","properties":{"createdDate":{"type":"string","example":"2025-05-06T15:22:37Z"},"description":{"type":"string","example":"Task template description"},"id":{"type":"string","example":"eddeb6a1-dfd7-4a60-9c8c-38ceed09bde9"},"name":{"type":"string","example":"Task template created as default"},"object":{"type":"string","example":"taskTemplate"},"subTaskTemplates":{"type":"array","items":{"properties":{"createdDate":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"}},"type":"object"}}}}}}},"400":{"description":"400","content":{"application/json":{"examples":{"Result":{"value":"{}"}},"schema":{"type":"object","properties":{}}}}}},"deprecated":false}},"/v1/files/{id}/permissions/":{"put":{"description":"","operationId":"put_v1files{id}permissions","responses":{"200":{"description":"Success"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The id of the folder to update or the string 'root' for the root folder"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"clientPermissions":{"type":"string","description":"The permission level for clients. Must be either `read_write` or `read_only`"},"channelId":{"type":"string","description":"The id for the file channel. Required for updating root folder permissions."}},"required":["clientPermissions"]}}}}}},"/v1/comments":{"get":{"description":"","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"b2c3d4e5-6789-01bc-defg-2345678901bc"},"object":{"type":"string","example":"taskComment"},"taskId":{"type":"string","example":"a1b2c3d4-5678-90ab-cdef-1234567890ab"},"parentCommentId":{"type":"string","example":"eddeb6a1-dfd7-4a60-9c8c-38ceed09bde9"},"content":{"type":"string","example":"Here are my receipts!
"},"createdBy":{"type":"string","example":"9eee4ba8-0b5e-47c6-8a4b-53022fbc7875"},"createdByUserType":{"type":"string","example":"clientUser"},"createdDate":{"type":"string","example":"2025-05-06T16:45:12Z"},"updatedDate":{"type":"string"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"file-uuid-123"},"fileName":{"type":"string","example":"receipts_q4.pdf"},"fileSize":{"type":"integer","example":245832,"default":0},"mimeType":{"type":"string","example":"application/pdf"},"downloadUrl":{"type":"string","example":"https://..."},"uploadedBy":{"type":"string","example":"9eee4ba8-0b5e-47c6-8a4b-53022fbc7875"},"uploadedByUserType":{"type":"string","example":"client"},"uploadedDate":{"type":"string","example":"2025-05-06T16:45:12Z"}}}}}},"examples":{"Result ":{"summary":"Result ","value":{"id":"b2c3d4e5-6789-01bc-defg-2345678901bc","object":"taskComment","taskId":"a1b2c3d4-5678-90ab-cdef-1234567890ab","parentCommentId":"eddeb6a1-dfd7-4a60-9c8c-38ceed09bde9","content":"Here are my receipts!
","createdBy":"9eee4ba8-0b5e-47c6-8a4b-53022fbc7875","createdByUserType":"clientUser","createdDate":"2025-05-06T16:45:12Z","updatedDate":null,"attachments":[{"id":"file-uuid-123","fileName":"receipts_q4.pdf","fileSize":245832,"mimeType":"application/pdf","downloadUrl":"https://...","uploadedBy":"9eee4ba8-0b5e-47c6-8a4b-53022fbc7875","uploadedByUserType":"client","uploadedDate":"2025-05-06T16:45:12Z"}]}}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"Result":{"summary":"Result","value":"{}"}}}},"description":"Bad Request"}},"parameters":[{"in":"query","name":"taskId","schema":{"type":"string"},"description":"Add an taskId if you only want comments for a specific task. "}],"operationId":"get_v1-comments"}},"/v1/comments/{commentId}":{"get":{"description":"","responses":{"200":{"description":"","content":{"application/json":{"examples":{"Result":{"summary":"Result","value":{"id":"b2c3d4e5-6789-01bc-defg-2345678901bc","object":"taskComment","taskId":"a1b2c3d4-5678-90ab-cdef-1234567890ab","parentCommentId":"eddeb6a1-dfd7-4a60-9c8c-38ceed09bde9","content":"Here are my receipts!
","createdBy":"9eee4ba8-0b5e-47c6-8a4b-53022fbc7875","createdByUserType":"clientUser","createdDate":"2025-05-06T16:45:12Z","updatedDate":null,"attachments":[{"id":"file-uuid-123","fileName":"receipts_q4.pdf","fileSize":245832,"mimeType":"application/pdf","downloadUrl":"https://...","uploadedBy":"9eee4ba8-0b5e-47c6-8a4b-53022fbc7875","uploadedByUserType":"client","uploadedDate":"2025-05-06T16:45:12Z"}]}}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"b2c3d4e5-6789-01bc-defg-2345678901bc"},"object":{"type":"string","example":"taskComment"},"taskId":{"type":"string","example":"a1b2c3d4-5678-90ab-cdef-1234567890ab"},"parentCommentId":{"type":"string","example":"eddeb6a1-dfd7-4a60-9c8c-38ceed09bde9"},"content":{"type":"string","example":"Here are my receipts!
"},"createdBy":{"type":"string","example":"9eee4ba8-0b5e-47c6-8a4b-53022fbc7875"},"createdByUserType":{"type":"string","example":"clientUser"},"createdDate":{"type":"string","example":"2025-05-06T16:45:12Z"},"updatedDate":{"type":"string"},"attachments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"file-uuid-123"},"fileName":{"type":"string","example":"receipts_q4.pdf"},"fileSize":{"type":"integer","example":245832,"default":0},"mimeType":{"type":"string","example":"application/pdf"},"downloadUrl":{"type":"string","example":"https://..."},"uploadedBy":{"type":"string","example":"9eee4ba8-0b5e-47c6-8a4b-53022fbc7875"},"uploadedByUserType":{"type":"string","example":"client"},"uploadedDate":{"type":"string","example":"2025-05-06T16:45:12Z"}}}}}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"Result":{"summary":"Result","value":"{}"}}}},"description":"Bad Request"}},"parameters":[{"in":"path","name":"commentId","schema":{"type":"string"},"required":true,"description":"The id of the comment to retrieve from the task."}],"operationId":"get_v1-comments-commentid"},"delete":{"description":"","responses":{"200":{"description":"","content":{"application/json":{"examples":{"Result":{"summary":"Result","value":{"id":"b2c3d4e5-6789-01bc-defg-2345678901bc","object":"taskComment","deleted":true}}},"schema":{"type":"object","properties":{"id":{"type":"string","example":"b2c3d4e5-6789-01bc-defg-2345678901bc"},"object":{"type":"string","example":"taskComment"},"deleted":{"type":"boolean","example":true,"default":true}}}}}},"400":{"content":{"application/json":{"schema":{"type":"object","properties":{}},"examples":{"Result ":{"summary":"Result ","value":"{}"}}}},"description":"Bad Request"}},"parameters":[{"in":"path","name":"commentId","schema":{"type":"string"},"required":true,"description":"The id of the comment to delete."}],"operationId":"delete_v1-comments-commentid"}},"/v1/events":{"get":{"description":"This API endpoint retrieves a list of events created in the workspace","responses":{"200":{"description":"","content":{"application/json":{"examples":{"OK":{"summary":"OK","value":{"data":[{"id":"35e1dd1d-5fe8-49e2-b154-7fc0506aabc1","object":"auditLog","actorId":"ab7bd961-0c87-4446-9037-ead4fbc3986f","actorType":"internalUser","source":"platform","eventType":"customEvent.testing","eventDescription":"user starting testing in platform","context":{"clientName":"ari","topic":"testing"},"ip":"67.166.31.192","userAgent":"PostmanRuntime/7.37.3","createdAt":"2026-03-12T20:24:26.206496361Z","updatedAt":"2026-03-12T20:24:26.206496361Z"}],"nextToken":"eyJsYXN0RXZhbHVhdGVkS2V5Ijp7Li4ufX0="}}},"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"35e1dd1d-5fe8-49e2-b154-7fc0506aabc1"},"object":{"type":"string","example":"auditLog"},"actorId":{"type":"string","example":"ab7bd961-0c87-4446-9037-ead4fbc3986f"},"actorType":{"type":"string","example":"internalUser"},"source":{"type":"string","example":"platform"},"eventType":{"type":"string","example":"customEvent.testing"},"eventDescription":{"type":"string","example":"user starting testing in platform"},"context":{"type":"object","properties":{"clientName":{"type":"string","example":"ari"},"topic":{"type":"string","example":"testing"}}},"ip":{"type":"string","example":"67.166.31.192"},"userAgent":{"type":"string","example":"PostmanRuntime/7.37.3"},"createdAt":{"type":"string","example":"2026-03-12T20:24:26.206496361Z"},"updatedAt":{"type":"string","example":"2026-03-12T20:24:26.206496361Z"}}}},"nextToken":{"type":"string","example":"eyJsYXN0RXZhbHVhdGVkS2V5Ijp7Li4ufX0="}}}}}}},"parameters":[{"in":"query","name":"limit","schema":{"type":"integer"},"description":"The maximum number of events to return per page. Defaults to 100 when omitted."},{"in":"query","name":"nextToken","schema":{"type":"string"},"description":"The pagination cursor returned in the previous response's `nextToken` field. Pass it back to fetch the next page."},{"in":"query","name":"actorId","schema":{"type":"string"},"description":"Comma-separated list of actor (user) UUIDs to filter events by."},{"in":"query","name":"eventType","schema":{"type":"string"},"description":"Comma-separated list of event types to filter by (e.g. `clientCreated`, `invoicePaid`)."},{"in":"query","name":"startDate","schema":{"type":"string"},"description":"Inclusive lower bound on event creation time. ISO-8601 / RFC3339 (e.g. `2026-03-01T00:00:00Z`)."},{"in":"query","name":"endDate","schema":{"type":"string"},"description":"Inclusive upper bound on event creation time. ISO-8601 / RFC3339 (e.g. `2026-03-31T23:59:59Z`)."}],"summary":"List Events","operationId":"get_v1-events"},"post":{"description":"This API endpoint creates a custom event in your workspace.","responses":{"201":{"content":{"application/json":{"schema":{"type":"object","properties":{"actorId":{"type":"string","example":"ab7bd961-0c87-4446-9037-ead4fbc3986f"},"actorType":{"type":"string","example":"internalUser"},"context":{"type":"object","properties":{"clientName":{"type":"string","example":"ari"},"topic":{"type":"string","example":"testing"}}},"createdAt":{"type":"string","example":"2026-03-12T20:24:26.206496361Z"},"eventDescription":{"type":"string","example":"user starting testing in platform"},"eventType":{"type":"string","example":"customEvent.testing"},"id":{"type":"string","example":"35e1dd1d-5fe8-49e2-b154-7fc0506aabc1"},"ip":{"type":"string","example":"67.166.31.192"},"object":{"type":"string","example":"auditLog"},"source":{"type":"string","example":"platform"},"updatedAt":{"type":"string","example":"2026-03-12T20:24:26.206496361Z"},"userAgent":{"type":"string","example":"PostmanRuntime/7.37.3"}}},"examples":{"Created":{"summary":"Created","value":{"actorId":"ab7bd961-0c87-4446-9037-ead4fbc3986f","actorType":"internalUser","context":{"clientName":"ari","topic":"testing"},"createdAt":"2026-03-12T20:24:26.206496361Z","eventDescription":"user starting testing in platform","eventType":"customEvent.testing","id":"35e1dd1d-5fe8-49e2-b154-7fc0506aabc1","ip":"67.166.31.192","object":"auditLog","source":"platform","updatedAt":"2026-03-12T20:24:26.206496361Z","userAgent":"PostmanRuntime/7.37.3"}}}}},"description":"Created"}},"parameters":[],"operationId":"post_v1-events","summary":"Create Event","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"eventType":{"type":"string","description":"The event type you wish to log. Max 100 characters. The stored value is prefixed with `customEvent`. (see Notes above)."},"eventDescription":{"type":"string","description":"A human-readable description of the event. Max 500 characters."},"actorId":{"type":"string","description":"The UUID of the user the event pertains to. Recommended for platform API callers so the event is attributed to the correct actor."},"companyId":{"type":"string","description":"The UUID of the company the event pertains to. Required if `actorId` belongs to a client."},"context":{"type":"string","description":"A JSON object of key-value pairs describing the event. See notes above for the expected shape.","format":"json"}},"required":["eventType","eventDescription","context"]}}}}}},"/v1/events/{id}":{"get":{"description":"This API endpoint retrieves a specific event by its ID.","responses":{"200":{"description":"","content":{"application/json":{"examples":{"OK":{"summary":"OK","value":{"actorId":"ab7bd961-0c87-4446-9037-ead4fbc3986f","actorType":"internalUser","context":{"app":"dropbox"},"createdAt":"2026-03-11T18:26:51.914818481Z","eventDescription":"syncing with a third party app","eventType":"customEvent.syncing","id":"2c30ec06-4b7b-414d-b586-c8b9b0235e07","ip":"67.166.31.192","object":"auditLog","source":"platform","updatedAt":"2026-03-11T18:26:51.914818481Z","userAgent":"PostmanRuntime/7.37.3"}}},"schema":{"type":"object","properties":{"actorId":{"type":"string","example":"ab7bd961-0c87-4446-9037-ead4fbc3986f"},"actorType":{"type":"string","example":"internalUser"},"context":{"type":"object","properties":{"app":{"type":"string","example":"dropbox"}}},"createdAt":{"type":"string","example":"2026-03-11T18:26:51.914818481Z"},"eventDescription":{"type":"string","example":"syncing with a third party app"},"eventType":{"type":"string","example":"customEvent.syncing"},"id":{"type":"string","example":"2c30ec06-4b7b-414d-b586-c8b9b0235e07"},"ip":{"type":"string","example":"67.166.31.192"},"object":{"type":"string","example":"auditLog"},"source":{"type":"string","example":"platform"},"updatedAt":{"type":"string","example":"2026-03-11T18:26:51.914818481Z"},"userAgent":{"type":"string","example":"PostmanRuntime/7.37.3"}}}}}}},"parameters":[{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The unique ID of the event you want to retrieve."}],"operationId":"get_v1-events-id","summary":"Retrieve Event "}}},"x-readme":{"headers":[],"explorer-enabled":true,"proxy-enabled":true},"x-readme-fauxas":true}