Tasks

Manage tasks in Exsited: create, read, update and delete tasks, their checklist items, notes and note files.

Tasks are units of work in Exsited, with a checklist, assignees, notes and attached files. You can create, list, retrieve, update and delete tasks, manage their checklist items, and add, read, change and remove notes and note files. This area has 18 endpoints, each available in all seven SDKs.

Deletes in this area cannot be undone. A deleted task returns 404.

At a glance

Endpoint	Method	Path	What it does
List tasks	GET	/tasks	Lists tasks, one page at a time.
Delete a task	DELETE	/tasks/{task_id}	Deletes a task; the response has no body.
Retrieve a task	GET	/tasks/{task_id}	Retrieves one task, with its checklist, assignees and alerts.
Update a task	PATCH	/tasks/{task_id}	Updates a task and returns it under work_task.
List a task’s checklist items	GET	/tasks/{task_id}/checklist	Lists the checklist items of one task.
Add checklist items to a task	POST	/tasks/{task_id}/checklist	Adds one or more checklist items to a task and returns the whole task.
List a task’s notes	GET	/tasks/{task_code}/notes	Lists the notes on one task, found by the task’s code.
Add a note to a task	POST	/tasks/{task_code}/notes	Adds a note, with an optional file, to a task found by its code.
Retrieve a checklist item	GET	/tasks/{task_id}/checklist/{task_checklist_uuid}	Retrieves one checklist item of a task.
Delete a task note	DELETE	/tasks/{task_code}/notes/{note_id}	Deletes one note from a task found by its code.
Create a task	POST	/tasks	Creates a task and returns it under work_task.
Delete a checklist item	DELETE	/tasks/{task_id}/checklist/{task_checklist_uuid}	Deletes one checklist item from a task; the response has no body.
Update a checklist item	PATCH	/tasks/{task_id}/checklist/{task_checklist_uuid}	Changes one checklist item and returns the task.
Delete a task note file	DELETE	/tasks/{task_code}/notes/{note_id}/files/{file_id}	Deletes one file attached to a task note; the response has no body.
List a task note’s files	GET	/tasks/{task_code}/notes/{note_id}/files	Lists the files attached to one task note.
Retrieve a task note file	GET	/tasks/{task_code}/notes/{note_id}/files/{file_id}	Retrieves the details of one file attached to a task note.
Retrieve a task note	GET	/tasks/{task_code}/notes/{note_id}	Retrieves one note of a task found by its code.
Update a task note	PATCH	/tasks/{task_code}/notes/{note_id}	Changes the text of one task note.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Task bodies go under work_task. The create and the update wrap their fields in work_task, name is required to create, and a key the API does not know is refused.
• The note routes take the task’s code, not its wt_ id. A wt_ id returns 404 on every /notes path; the task, checklist and update calls take the wt_ id.
• Checklist bodies go under checklist. Adding items sends an array of {"name": ...}; updating one item sends a single object. Most checklist calls return the whole task under work_task.
• checklist changes shape. It is an array on the task and on the checklist list, and a single object when you retrieve one checklist item.
• Notes are multipart forms. Send the text as the note field and, optionally, a file. To read an attached file’s details, use the uuid from the note’s file list; the call returns the file’s details, not its contents.
• A COMPLETED checklist item cannot be deleted. The delete returns 409.