{"info":{"_postman_id":"0c2d6389-cc6e-4337-9354-16e942203047","name":"API Documentation","description":"\"alt\n\n

Welcome to The Nutcache API! Use this API to easily interact with your Nutcache account programmatically. This guide offers a comprehensive suite of developer resources and web services to connect Nutcache to your existing tools and workflow.

\n

Overview

\n

To use the Nutcache API, an owner must first generate a public key. This action can be done directly in Nutcache under the \"My account -> Profile\" menu. From the \"Profile\" dialog, select the \"Manage API key\" link and click the \"+ API KEY\" to continue.

\n\"alt\n\n

Authentication

\n

Authentication info must be provided along with your request within the Authorization header.

\n

Authorization: Bearer access_token

\n

Company context

\n

A company context is required when making requests. To do this, simply include the company GUID, which can be retrieved via the Company API from the request header.

\n

Schema

\n

Blank Fields:

\n\n

Timestamps:

\n\n

Date Fields:
Input for date fields is expected to be in one of the following formats:

\n\n

If the time zone information is not present, it will be assumed to be in UTC.

\n\n

Pagination

\n

API responses that return a list of objects, such as Projects, Customers or Time Entries are paginated. To scroll through the pages, add the parameter page to the query string. The page number starts with 1. By default, the number of objects returned per page is 10 and is limited to 100.

\n

Rate limit

\n

A rate limit of 20 000 API calls per API key is allowed.
If you go over this limit, Nutcache will start returning a HTTP 429 Too Many Requests error, and a Retry-After HTTP header containing the number of seconds until you can retry.

\n

HTTP/1.1 429 Too Many Requests Retry-After: 30

\n

There is also a burst limit of 5 API calls per second and 200 per minute.

\n

Errors

\n

API requests that result in errors will return an appropriate HTTP code to help you identify the type of error and fix it. You can use the table below to understand what each code means.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeTextDescription
400Client or Validation ErrorThis indicates that the request is not in the correct format.
401Access DeniedThis indicates that the Authorization header is either missing or incorrect.
403Client or Validation ErrorThis indicates that the user whose credentials were used in making this request was not authorized to perform this API call.
404Requested Resource not FoundThis code is returned when the request contains invalid ID/Nutcache domain in the URL or an invalid URL itself. For example, an API call to retrieve a project with an invalid ID will return a HTTP 404 status code to let you know that no such project exists.
429Too Many RequestsThis code appears when the user has exceeded the API rate limit. In Nutcache, this limit is set to 20000 API requests per day per API key.
500Unexpected Server ErrorThis indicates an error on Nutcache's side. Please email us at support@nutcache.com with any relevant information. We will reach out to you and fix this ASAP.
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Company context","slug":"company-context"},{"content":"Schema","slug":"schema"},{"content":"Pagination","slug":"pagination"},{"content":"Rate limit","slug":"rate-limit"},{"content":"Errors","slug":"errors"}],"owner":"14635689","collectionId":"0c2d6389-cc6e-4337-9354-16e942203047","publishedId":"Tz5i9g65","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-12-13T15:37:03.000Z"},"item":[{"name":"Authentication","item":[{"name":"login","event":[{"listen":"test","script":{"id":"910b4578-5ac1-4811-8ab8-d35d95c74e1c","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Access token exists\", function () {\r"," pm.expect(pm.response.text()).to.include(\"access_token\");\r","});\r","\r","// Save the token to an environment variable\r","var jsonData = JSON.parse(pm.response.text());\r","postman.setEnvironmentVariable(\"access_token\", jsonData.access_token);"],"type":"text/javascript","packages":{}}}],"id":"af3c48de-55df-4326-8d49-3434c9f32646","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"","type":"text"},{"key":"password","value":"","type":"text"},{"key":"api_key","value":"","type":"text"}]},"url":"{{server}}/Token","description":"

The user name, password and the api_key are examples. Please create your own valid user name, password and api key.

\n","urlObject":{"path":["Token"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"af3c48de-55df-4326-8d49-3434c9f32646"}],"id":"4ce5dbab-9075-42fe-ba87-e7c2a01c37ae","description":"

Use this request to authenticate yourself to access the application.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b49cf0d1-723c-466c-a451-cd41244ca2f7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c8bdd206-248a-4029-92e4-3a728159c373"}}],"_postman_id":"4ce5dbab-9075-42fe-ba87-e7c2a01c37ae"},{"name":"Company","item":[{"name":"Company - get","event":[{"listen":"test","script":{"id":"b7d33abc-cf01-4d2f-93bf-ef362442eb56","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","// Save the first company info to an environment variable\r","var jsonData = JSON.parse(pm.response.text());\r","postman.setEnvironmentVariable(\"company_id\", jsonData.companies[0].id);\r","postman.setEnvironmentVariable(\"company_guid\", jsonData.companies[0].guid);\r",""],"type":"text/javascript"}}],"id":"69e836fb-f782-4955-8f90-ee6e11c46fa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","type":"text","value":"{{api_version}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/companies/filtered","description":"

Using this API, you can fetch a list of companies.

\n","urlObject":{"path":["companies","filtered"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"69e836fb-f782-4955-8f90-ee6e11c46fa4"},{"name":"Company - get by id","event":[{"listen":"test","script":{"id":"c7816514-59b3-4f01-b2cf-4d552e68e08a","exec":[""],"type":"text/javascript"}}],"id":"04dc0ebf-ea8f-4602-8160-c98b87b01a2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"GET","header":[{"key":"api-version","type":"text","value":"{{api_version}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/companies/12345","description":"

This API allows you to view the details of a company.

\n","urlObject":{"path":["companies","12345"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"04dc0ebf-ea8f-4602-8160-c98b87b01a2d"}],"id":"dd1303a6-5661-410c-b0c0-2315a55cb4b8","description":"

A Nutcache company is an entity comprising multiple members with various roles and projects with varying constraints and goals.

\n","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"b1eefa2f-ace8-4552-a687-96afba1a6ef7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"c98ee7c2-682a-447e-b680-e6205bb89469"}}],"_postman_id":"dd1303a6-5661-410c-b0c0-2315a55cb4b8"},{"name":"Customers","item":[{"name":"Customers - get","event":[{"listen":"test","script":{"id":"63cf6ae1-b04a-4a88-88d3-76ba8ae94cc3","exec":[""],"type":"text/javascript"}}],"id":"17d6f437-71cf-43f1-a846-6cffb85756b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/customers/filtered","description":"

Using this API, you can fetch a list of customers.

\n","urlObject":{"path":["customers","filtered"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"17d6f437-71cf-43f1-a846-6cffb85756b8"},{"name":"Customer - get by id","event":[{"listen":"test","script":{"id":"6479872d-ec09-486f-83d0-9be82650a3ac","exec":[""],"type":"text/javascript"}}],"id":"c229898f-ea18-4455-8654-0d862a73f3ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"GET","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/customers/123","description":"

This API allows you to view the details of a customer.

\n","urlObject":{"path":["customers","123"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c229898f-ea18-4455-8654-0d862a73f3ba"}],"id":"815bab53-ec1f-46ce-a1ea-5fa7a723a324","description":"

An individual or party with whom you conduct business.

\n","_postman_id":"815bab53-ec1f-46ce-a1ea-5fa7a723a324"},{"name":"Projects","item":[{"name":"Project - create","event":[{"listen":"test","script":{"id":"ef9ef087-8188-462a-b71b-e2fdcbdcbecf","exec":[""],"type":"text/javascript"}}],"id":"a9ae0a34-88cf-413c-835a-70ece14defae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"project\" : {\r\n \"name\": \"regular project\",\r\n \"project_template_id\" : 1,\r\n \"status\": 0,\r\n \"start_date\": null,\r\n \"end_date\": null,\r\n \"display_color\": \"#ff6f00\",\r\n \"is_billable\": false,\r\n \"vision\": \"\",\r\n \"description\": null,\r\n \"project_type\": 0,\r\n \"primary_contact_email\": null,\r\n \"primary_contact_name\": null,\r\n \"primary_contact_phone\": null,\r\n \"secondary_contact_email\": null,\r\n \"secondary_contact_name\": null,\r\n \"secondary_contact_phone\": null,\r\n \"budget_type\": 0,\r\n \"is_billable_only\": false,\r\n \"effective_budget_amount\": 0.0,\r\n \"effective_budget_minutes\": 0,\r\n \"budget_approved_only\": false,\r\n \"budget_restrictive\": false,\r\n \"billing_method\": 0,\r\n \"billing_invoice_method_fixed_fee\": null,\r\n \"billing_invoice_method_hourly_rate\": null,\r\n \"billing_approved_entries_only\": false,\r\n \"customer_name\": \"No client\",\r\n \"customer_id\": null,\r\n \"is_system_template\": true\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/projects","description":"

Use this request to create new projects.

\n","urlObject":{"path":["projects"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a9ae0a34-88cf-413c-835a-70ece14defae"},{"name":"Project - create from custom template","event":[{"listen":"test","script":{"id":"ef9ef087-8188-462a-b71b-e2fdcbdcbecf","exec":[""],"type":"text/javascript"}}],"id":"0edeb0da-de46-4a4f-9d9c-ea9c94482174","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"project\" : {\r\n \"name\": \"project from template\",\r\n \"project_template_id\" : ,\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/projects","description":"

Use this request to create a new project from a custom template.

\n

Note: Any values provided in the request payload will override the corresponding template values.

\n","urlObject":{"path":["projects"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0edeb0da-de46-4a4f-9d9c-ea9c94482174"},{"name":"Project - get by id","event":[{"listen":"test","script":{"id":"29e994cd-3a97-4d3f-95b7-916f12b134d8","exec":[""],"type":"text/javascript"}}],"id":"6f40dd93-d6d8-4910-8e32-3b601e91e027","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"GET","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/projects/12374","description":"

This API allows you to view the details of a project.

\n","urlObject":{"path":["projects","12374"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f40dd93-d6d8-4910-8e32-3b601e91e027"},{"name":"Projects - get","event":[{"listen":"test","script":{"id":"fbf2e7a4-d96d-4d34-8b2f-cdf4a3a7ecf1","exec":[""],"type":"text/javascript"}}],"id":"1ed9c188-b9a1-4e8a-bb51-8405af4fe824","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/projects/filtered?includes=task_lists,customers,project_services,project_members,project_labels","description":"

Using this API, you can fetch a list of projects.\nUse 'includes' to embed additional details in the response.

\n

The following entity types can be included in this payload type:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
task_listsThe task lists associated with this project.
customersThe customer associated with this project.
project_servicesThe services associated with this project.
project_membersThe members assigned to this project.
project_labelsThe labels associated with this project.
\n
","urlObject":{"path":["projects","filtered"],"host":["{{server}}"],"query":[{"key":"includes","value":"task_lists,customers,project_services,project_members,project_labels"}],"variable":[]}},"response":[],"_postman_id":"1ed9c188-b9a1-4e8a-bb51-8405af4fe824"},{"name":"Project - update","event":[{"listen":"test","script":{"id":"aaee60a0-5aba-4604-809f-c24439b68b26","exec":[""],"type":"text/javascript"}}],"id":"e637ec8d-0755-4123-b81f-2561ac9ab682","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PUT","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"projects\": [\r\n {\r\n \"entity_type\": \"projects\",\r\n \"id\": 12374,\r\n \"name\": \"empty project new name\", //updated\r\n \"status\": 1, //updated\r\n \"start_date\": null,\r\n \"end_date\": null,\r\n \"display_color\": \"#1a1cc4\", //updated\r\n \"company_id\": 1761,\r\n \"is_billable\": false,\r\n \"vision\": \"new vision\", //updated\r\n \"description\": \"new description\", //updated\r\n \"project_type\": 0,\r\n \"primary_contact_email\": null,\r\n \"primary_contact_name\": \"new primary guy\", //updated\r\n \"primary_contact_phone\": null,\r\n \"secondary_contact_email\": null,\r\n \"secondary_contact_name\": null,\r\n \"secondary_contact_phone\": null,\r\n \"budget_type\": 0,\r\n \"is_billable_only\": false,\r\n \"effective_budget_amount\": 0.0,\r\n \"effective_budget_minutes\": 0,\r\n \"budget_approved_only\": false,\r\n \"budget_restrictive\": false,\r\n \"billing_method\": 0,\r\n \"billing_invoice_method_fixed_fee\": null,\r\n \"billing_invoice_method_hourly_rate\": null,\r\n \"billing_approved_entries_only\": false,\r\n \"customer_name\": \"No client\",\r\n \"customer_id\": null\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/projects/12374","description":"

This API allows you to edit the details of a project.

\n","urlObject":{"path":["projects","12374"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e637ec8d-0755-4123-b81f-2561ac9ab682"},{"name":"Project - delete","event":[{"listen":"test","script":{"id":"d39d7f2b-fc53-4440-9ae0-e633f5c6d3e9","exec":[""],"type":"text/javascript"}}],"id":"f5dc5f12-3337-487c-be4b-e4653d19884c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"DELETE","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/projects/12374","description":"

This API allows you to delete a project.

\n","urlObject":{"path":["projects","12374"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5dc5f12-3337-487c-be4b-e4653d19884c"}],"id":"1082a47a-8e6e-4a49-aa74-ca3b47184856","description":"

A project is a planned work or activity that is to be completed over a period of time using the Scrum or any other Agile methodology.

\n

Some attributes are available only if the authenticated user has the required permissions.

\n

Using the API allows you to do the following with project data.

\n","_postman_id":"1082a47a-8e6e-4a49-aa74-ca3b47184856"},{"name":"Invoices","item":[{"name":"Invoices - get by id","event":[{"listen":"test","script":{"id":"29e994cd-3a97-4d3f-95b7-916f12b134d8","exec":[""],"type":"text/javascript","packages":{}}}],"id":"17e9a0e9-e2f5-4dac-9d41-463a59240fec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"GET","header":[{"key":"api-version","value":"{{api_version}}","type":"text"},{"key":"CompanyGuid","value":"{{company_guid}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/invoices/2375962","description":"

This API allows you to view the details of an invoice.

\n","urlObject":{"path":["invoices","2375962"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"17e9a0e9-e2f5-4dac-9d41-463a59240fec"},{"name":"Invoices - get","event":[{"listen":"test","script":{"id":"fbf2e7a4-d96d-4d34-8b2f-cdf4a3a7ecf1","exec":[""],"type":"text/javascript","packages":{}}}],"id":"023f08b0-1c16-4e3d-be67-7ccd8dd329f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","value":"{{api_version}}","type":"text"},{"key":"CompanyGuid","value":"{{company_guid}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/invoices/filtered?includes=invoiceItems","description":"

Using this API, you can fetch a list of invoices.
Use 'includes' to embed additional details in the response.

\n

The following entity types can be included in this payload type:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
TypeDescription
invoice_detailsThe invoice details (products & services).
\n
","urlObject":{"path":["invoices","filtered"],"host":["{{server}}"],"query":[{"key":"includes","value":"invoiceItems"}],"variable":[]}},"response":[],"_postman_id":"023f08b0-1c16-4e3d-be67-7ccd8dd329f2"}],"id":"5f803c78-878d-4c0f-8e6c-095b6ccbef91","description":"

A project is a planned work or activity that is to be completed over a period of time using the Scrum or any other Agile methodology.

\n

Some attributes are available only if the authenticated user has the required permissions.

\n

Using the API allows you to do the following with project data.

\n","_postman_id":"5f803c78-878d-4c0f-8e6c-095b6ccbef91"},{"name":"Time entries","item":[{"name":"Time entries - create","event":[{"listen":"test","script":{"id":"1114a35d-d082-4189-a17c-c7f1f8406507","exec":[""],"type":"text/javascript"}}],"id":"788ad772-4369-4da9-b03b-4d0aef7f60d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"time_entries\" : {\r\n \"working_date\": \"2021-01-01\",\r\n \"note\": \"test\",\r\n \"minutes\" : 60,\r\n \"billable_minutes\": 0,\r\n \"project_id\": 12345,\r\n \"project_service_id\": null,\r\n \"project_board_id\": null,\r\n \"project_board_task_id\": null,\r\n \"member_id\": 36339\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/time_entries","description":"

Use this request to create new time entries.

\n","urlObject":{"path":["time_entries"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"788ad772-4369-4da9-b03b-4d0aef7f60d1"},{"name":"Time entries - get by id","event":[{"listen":"test","script":{"id":"defc8401-0f0b-4b45-8efa-dd125d9112ca","exec":[""],"type":"text/javascript"}}],"id":"dc8a8adc-1778-4f2d-a538-58053045f460","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"GET","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/time_entries/12345","description":"

This API allows you to view the details of a time entry.

\n","urlObject":{"path":["time_entries","12345"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc8a8adc-1778-4f2d-a538-58053045f460"},{"name":"Time entries - get filtered","event":[{"listen":"test","script":{"id":"d57440a1-d185-4d62-8444-df9a2739d082","exec":[""],"type":"text/javascript"}}],"id":"b95f7666-d5d1-464a-b3f6-414fe8bb0b10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/time_entries/filtered","description":"

Using this API, you can fetch a list of time entries.

\n","urlObject":{"path":["time_entries","filtered"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b95f7666-d5d1-464a-b3f6-414fe8bb0b10"},{"name":"Time entries - update","event":[{"listen":"test","script":{"id":"7cbbb837-fb2e-48a6-bd5a-af30f8c1374e","exec":[""],"type":"text/javascript"}}],"id":"db1496d9-3965-484b-a073-39f57b3a7252","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PUT","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"time_entries\": [\r\n {\r\n \"entity_type\": \"time_entries\",\r\n \"id\": 123456,\r\n \"working_date\": \"2021-01-01T00:00:00\",\r\n \"minutes\": 120, //update the minutes from 60 to 120\r\n \"title\": \"project marketing\",\r\n \"company_id\": 12345,\r\n \"holiday_id\": null,\r\n \"billable_minutes\": 0,\r\n \"creation_date\": \"2021-03-02T19:37:54.817\",\r\n \"note\": \"test the update api\", //update the notes \r\n \"from_timer\": false,\r\n \"project_id\": 1234,\r\n \"project_board_task_id\": null,\r\n \"project_board_id\": null,\r\n \"project_service_id\": null,\r\n \"member_id\": 12345,\r\n \"invoice\": null,\r\n \"timesheet_status\": null\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/time_entries/12345","description":"

This API allows you to edit the details of a time entry.

\n","urlObject":{"path":["time_entries","12345"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"db1496d9-3965-484b-a073-39f57b3a7252"},{"name":"Time entries - delete","event":[{"listen":"test","script":{"id":"517621c3-6cf1-4ac4-838f-2ba6e5e35c7e","exec":[""],"type":"text/javascript"}}],"id":"796a1b19-7eef-43e8-a418-6363045e66cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"DELETE","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"data\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/time_entries/12345","description":"

This API allows you to delete a time entry.

\n","urlObject":{"path":["time_entries","12345"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"796a1b19-7eef-43e8-a418-6363045e66cf"}],"id":"2afaecf4-f310-41c1-8d62-d0209c611e88","description":"

A time entry is a recording of the amount of time a member spent on a specific task.

\n","_postman_id":"2afaecf4-f310-41c1-8d62-d0209c611e88"},{"name":"Task lists","item":[{"name":"Task list - get by id","event":[{"listen":"test","script":{"id":"c63f9b2a-6270-4129-bb05-04cac9d4baaf","exec":[""],"type":"text/javascript"}}],"id":"5cb72269-85b2-45e5-afb0-b6f871727a54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"GET","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_lists/12345","description":"

This API allows you to view the details of a task list.

\n","urlObject":{"path":["task_lists","12345"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5cb72269-85b2-45e5-afb0-b6f871727a54"},{"name":"Task lists - get","event":[{"listen":"test","script":{"id":"e5f8ed3a-2fad-41d7-8674-82ee7e61f314","exec":[""],"type":"text/javascript"}}],"id":"ee04a081-748c-44ad-ad9b-5c1574f1ae2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"filter_rules\": [\r\n {\r\n \"property\": \"id\",\r\n \"operator\": \"eq\",\r\n \"value\":12345\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_lists/filtered?includes=task_status","description":"

Using this API, you can fetch a list of task lists and their status.

\n","urlObject":{"path":["task_lists","filtered"],"host":["{{server}}"],"query":[{"key":"includes","value":"task_status"}],"variable":[]}},"response":[],"_postman_id":"ee04a081-748c-44ad-ad9b-5c1574f1ae2b"},{"name":"Task list - duplicate","event":[{"listen":"test","script":{"id":"1c4cb970-0a76-44b6-93c4-e73e0113b032","exec":[""],"type":"text/javascript"}}],"id":"aa7ded94-dfb9-4b79-a55e-dae968f81df5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"duplicate_task_list_action\",\r\n \"data\": {\r\n \"Title\": \"Duplicate of Campaign\",\r\n \"isSprint\": \"false\",\r\n \"ProjectId\": 123456,\r\n \"copyCards\": \"true\",\r\n \"copyAttachments\": \"true\",\r\n \"copyChecklists\": \"true\",\r\n \"copyComments\": \"true\",\r\n \"copySubCards\": \"true\",\r\n \"copyMemberAssignments\": \"true\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_lists/12345","description":"

Using this API, you can execute the duplicate action on a task list.

\n","urlObject":{"path":["task_lists","12345"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa7ded94-dfb9-4b79-a55e-dae968f81df5"},{"name":"Task list - delete","event":[{"listen":"test","script":{"id":"a1834903-d2ad-4ad7-b462-5b710b683f97","exec":[""],"type":"text/javascript"}}],"id":"13cc962e-1f72-4be0-85f9-45efa1f8ff3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"DELETE","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_lists/12345","description":"

This API allows you to delete a task list.

\n","urlObject":{"path":["task_lists","12345"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"13cc962e-1f72-4be0-85f9-45efa1f8ff3a"}],"id":"3f34535c-9960-49b6-b633-bacd213c8961","description":"

A task list represents a group of related tasks. Task list allows to break a project into prioritized sets of tasks you (or your team) need to do to complete a project

\n","_postman_id":"3f34535c-9960-49b6-b633-bacd213c8961"},{"name":"Task status","item":[{"name":"Task status - get","event":[{"listen":"test","script":{"id":"0c30d22b-e8d4-482e-aad3-59357f9db106","exec":[""],"type":"text/javascript"}}],"id":"e624565e-650d-4785-a557-4f812d1edc2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"filter_rules\": [\r\n {\r\n \"property\": \"id\",\r\n \"operator\": \"eq\",\r\n \"value\":12345\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_status/filtered?includes=tasks","description":"

This API allows you to view the details of a task status including the tasks in contains.

\n","urlObject":{"path":["task_status","filtered"],"host":["{{server}}"],"query":[{"key":"includes","value":"tasks"}],"variable":[]}},"response":[],"_postman_id":"e624565e-650d-4785-a557-4f812d1edc2e"},{"name":"Task status - edit title","event":[{"listen":"test","script":{"id":"350a44f3-9bb7-4b99-94dc-a2c3ca1181d8","exec":[""],"type":"text/javascript"}}],"id":"4f4dcf6a-ed87-49c8-8e8b-434c415dbe35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"edit_title_task_status_action\",\r\n \"data\": {\r\n \"title\": \"New Title\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_status/54321","description":"

This API allows you to edit the title of a task status.

\n","urlObject":{"path":["task_status","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f4dcf6a-ed87-49c8-8e8b-434c415dbe35"},{"name":"Task status - make private","event":[{"listen":"test","script":{"id":"f004978f-c4cf-4dec-b28f-0e5b77164b41","exec":[""],"type":"text/javascript"}}],"id":"3f1f4574-0da9-4811-80a4-64c5dce732e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"make_private_task_status_action\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_status/54321","description":"

This API allows you to make private a task status.

\n","urlObject":{"path":["task_status","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3f1f4574-0da9-4811-80a4-64c5dce732e5"},{"name":"Task status - make public","event":[{"listen":"test","script":{"id":"8886fa92-f845-49b5-8768-f45e4d2e367b","exec":[""],"type":"text/javascript"}}],"id":"32ec00e9-871c-4a01-9004-c9ca5682299a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"make_public_task_status_action\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_status/54321","description":"

This API allows you to make public a task status.

\n","urlObject":{"path":["task_status","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"32ec00e9-871c-4a01-9004-c9ca5682299a"},{"name":"Task status - archive","event":[{"listen":"test","script":{"id":"1eb450de-753e-4a9b-832d-4dfc503652d9","exec":[""],"type":"text/javascript"}}],"id":"136e1821-ecc3-44d5-9d7c-7874bbda80ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"archive_task_status_action\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_status/54321","description":"

This API allows you to archive a task status.

\n","urlObject":{"path":["task_status","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"136e1821-ecc3-44d5-9d7c-7874bbda80ea"},{"name":"Task status - unarchive","event":[{"listen":"test","script":{"id":"92a97707-165b-4731-bfc0-6e6a8a3a6f87","exec":[""],"type":"text/javascript"}}],"id":"bb2a0c8b-6c08-45ec-bfa3-f121e016359d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"unarchive_task_status_action\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_status/54321","description":"

This API allows you to unarchive a task status.

\n","urlObject":{"path":["task_status","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb2a0c8b-6c08-45ec-bfa3-f121e016359d"},{"name":"Task status - edit task limit","event":[{"listen":"test","script":{"id":"3c0bfcc2-c3bd-4612-b9ea-4d9d3dd3c6fe","exec":["\r",""],"type":"text/javascript"}}],"id":"ad248880-5f57-4412-b570-11fa4bad1095","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"edit_task_limit_task_status_action\",\r\n \"data\": {\r\n \"task_limit\": 7\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_status/54321","description":"

This API allows you to edit the task limit of a task status.

\n","urlObject":{"path":["task_status","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad248880-5f57-4412-b570-11fa4bad1095"},{"name":"Task status - set as done","event":[{"listen":"test","script":{"id":"166a7a63-81ef-4f09-a2e1-25e31b260cdb","exec":[""],"type":"text/javascript"}}],"id":"c1f599f7-bea4-4346-bb1d-818cf068600a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"set_as_done_task_status_action\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_status/54321","description":"

This API allows you to set a task status as 'done'.

\n","urlObject":{"path":["task_status","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c1f599f7-bea4-4346-bb1d-818cf068600a"},{"name":"Task status - delete","event":[{"listen":"test","script":{"id":"0f807fa0-4fdd-451a-aa25-76ed9c3e1715","exec":[""],"type":"text/javascript"}}],"id":"b93650b6-dcfb-49e1-9ffb-ed376487d4c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"DELETE","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/task_status/54321","description":"

This API allows you to delete a status.

\n","urlObject":{"path":["task_status","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b93650b6-dcfb-49e1-9ffb-ed376487d4c0"}],"id":"8a8d15af-2b93-4b54-9c32-6bd6fec1a3ac","description":"

A status represents a phase within a specific task list. Statuses are composed of tasks that can be moved from one status to another depending on the workflow (To do, Doing, Done).

\n","_postman_id":"8a8d15af-2b93-4b54-9c32-6bd6fec1a3ac"},{"name":"Tasks","item":[{"name":"Task - create","event":[{"listen":"test","script":{"id":"c24ffd02-f9c1-4adb-967b-4a7d8b2a6b12","exec":[""],"type":"text/javascript"}}],"id":"c76293fa-d5ad-400a-8548-1c5c73662c82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"task\" : {\r\n \"title\": \"My Created Task\",\r\n \"board_list_id\": 12345\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/tasks","description":"

This API allows you to create a new task.

\n","urlObject":{"path":["tasks"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c76293fa-d5ad-400a-8548-1c5c73662c82"},{"name":"Task - get","event":[{"listen":"test","script":{"id":"880f8755-eeba-4ac0-a9e0-c61b1c58cfb4","exec":[""],"type":"text/javascript"}}],"id":"88e53310-8b7a-4ea0-adcd-f02f6144a171","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"POST","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"filter_rules\": [\r\n {\r\n \"property\": \"id\",\r\n \"operator\": \"eq\",\r\n \"value\": 123546\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/tasks/filtered?includes=task_subtasks","description":"

This API allows you to view the details of a task including the subtasks in contains.

\n","urlObject":{"path":["tasks","filtered"],"host":["{{server}}"],"query":[{"key":"includes","value":"task_subtasks"}],"variable":[]}},"response":[],"_postman_id":"88e53310-8b7a-4ea0-adcd-f02f6144a171"},{"name":"Task - edit description","event":[{"listen":"test","script":{"id":"118d8b4e-c736-4b9b-946e-8bce5461a914","exec":[""],"type":"text/javascript"}}],"id":"c87628fd-7199-4463-8b41-b2d783e995ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"edit_description_task_action\",\r\n \"data\": {\r\n \"description\": \"new description\",\r\n \"raw_description\": \"new description\" //must edit the raw description to see it in the card rich text editor\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/tasks/54321","description":"

This API allows you to edit the description of a task.

\n","urlObject":{"path":["tasks","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c87628fd-7199-4463-8b41-b2d783e995ab"},{"name":"Task - edit planned start date","event":[{"listen":"test","script":{"id":"c3c18fa8-0fb7-42f0-96d5-9150c1d2fe80","exec":[""],"type":"text/javascript"}}],"id":"a10de9bd-d3ee-42ef-8a9b-a9d3ea4485fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"edit_planned_start_date_task_action\",\r\n \"data\": {\r\n \"date_field_value\": \"2021-12-12\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/tasks/54321","description":"

This API allows you to edit the planned start date of a task.

\n","urlObject":{"path":["tasks","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a10de9bd-d3ee-42ef-8a9b-a9d3ea4485fd"},{"name":"Task - edit planned end date","event":[{"listen":"test","script":{"id":"f5bcf07a-5ba8-4be5-bea1-cc92bf977504","exec":[""],"type":"text/javascript"}}],"id":"83c3ae40-7f54-4244-9915-58e18471cab3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"edit_planned_end_date_task_action\",\r\n \"data\": {\r\n \"date_field_value\": \"2021-12-29\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/tasks/54321","description":"

This API allows you to edit the planned end date of a task.

\n","urlObject":{"path":["tasks","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"83c3ae40-7f54-4244-9915-58e18471cab3"},{"name":"Task - edit priority","event":[{"listen":"test","script":{"id":"257e3d33-47b0-4251-b296-7ea57f678743","exec":[""],"type":"text/javascript"}}],"id":"dfdf6eb0-f9d5-4a08-980c-7be744e22369","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"edit_priority_task_action\",\r\n \"data\": {\r\n \"priority\": \"4\" // High priority\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/tasks/54321","description":"

This API allows you to edit the priority of a task.

\n","urlObject":{"path":["tasks","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dfdf6eb0-f9d5-4a08-980c-7be744e22369"},{"name":"Task - subscribe","event":[{"listen":"test","script":{"id":"e79788d1-0993-4a96-b646-324ab7d9d4a2","exec":[""],"type":"text/javascript"}}],"id":"6f2c41ef-431c-4bc7-b8d6-0edc0d067f3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"subscribe_task_action\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/tasks/54321?includes=task_followers","description":"

This API allows you to subscribe/follow a task.\nAll followers receive a notification when other members edit the task.

\n","urlObject":{"path":["tasks","54321"],"host":["{{server}}"],"query":[{"key":"includes","value":"task_followers"}],"variable":[]}},"response":[],"_postman_id":"6f2c41ef-431c-4bc7-b8d6-0edc0d067f3c"},{"name":"Task - unsubscribe","event":[{"listen":"test","script":{"id":"7fcd9db3-3eb3-4039-baeb-fda01ae7124d","exec":[""],"type":"text/javascript"}}],"id":"ee07e4e3-0a5c-4540-9f3c-3ab0c3c93bec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"unsubscribe_task_action\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/tasks/54321?includes=task_followers","description":"

This API allows you to unsubscribe/stop following a task. You will no longer receive notifications when other members edit the task.

\n","urlObject":{"path":["tasks","54321"],"host":["{{server}}"],"query":[{"key":"includes","value":"task_followers"}],"variable":[]}},"response":[],"_postman_id":"ee07e4e3-0a5c-4540-9f3c-3ab0c3c93bec"},{"name":"Task - set done date","event":[{"listen":"test","script":{"id":"ce9f292a-5438-46eb-afc1-1032b3d8f3bf","exec":[""],"type":"text/javascript"}}],"id":"d2535614-2b7a-49fc-9b20-7f1d39e55fe0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"set_done_task_action\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/tasks/54321","description":"

This API allows you to set the done date of a task.

\n","urlObject":{"path":["tasks","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2535614-2b7a-49fc-9b20-7f1d39e55fe0"},{"name":"Task - clear done date","event":[{"listen":"test","script":{"id":"ec68fc1e-1743-41ff-811a-228c950ca47d","exec":[""],"type":"text/javascript"}}],"id":"12ed92e7-1e8f-4423-8d0a-d4cb441e777d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"PATCH","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"{\r\n \"action\": \"set_not_done_task_action\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{server}}/tasks/54321","description":"

This API allows you to clear the done date of a task.

\n","urlObject":{"path":["tasks","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"12ed92e7-1e8f-4423-8d0a-d4cb441e777d"},{"name":"Task - delete","event":[{"listen":"test","script":{"id":"4656c9a5-dc4c-4107-8a8d-03b14379b0ee","exec":[""],"type":"text/javascript"}}],"id":"e4158102-e9f2-4977-b6b0-3e2ba05d504d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":"{{access_token}}"},"isInherited":false},"method":"DELETE","header":[{"key":"api-version","type":"text","value":"{{api_version}}"},{"key":"CompanyGuid","type":"text","value":"{{company_guid}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{server}}/tasks/54321","description":"

This API allows you to delete a task.

\n","urlObject":{"path":["tasks","54321"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4158102-e9f2-4977-b6b0-3e2ba05d504d"}],"id":"ed572dab-b82c-48ab-90ed-39bcfaa1f97c","description":"

A task is an activity that needs to be accomplished within a defined period of time. Tasks can be organized into task lists and assigned to anyone on the project.

\n","_postman_id":"ed572dab-b82c-48ab-90ed-39bcfaa1f97c"},{"name":"Map Filter Operators","item":[],"id":"ba1dd001-7be4-4659-bdb6-7103868ff05f","description":"

This section shows the proper syntax when using map filter operators in your queries.

\n

Available Operators:

\n

Equal = eq
NotEqual = neq
GreaterThan = gt
LessThan = lt
GreaterThanOrEqual = gte
LessThanOrEqual = lte
Contains = ct
StartsWith = sw
EndsWith = ew

\n

payload example:
filter_rules: [
{ property: 'StartDate', operator: 'gte', value: startDate },
{ property: 'EndDate', operator: 'lte', value: endDate },
],

\n","_postman_id":"ba1dd001-7be4-4659-bdb6-7103868ff05f"}]}