REST routes overview
This page gives you the list of all REST routes with their short description and links to pages with more details.
Before you dive into each route description, it's recommended to read about Working with Server.
info
For quick navigation you can use either of the two tabs below:
- Routes by data objects to get the idea which routes to use for which operations
- Routes by methods to have a quick grasp of routes by http methods and what the server returns back
- Routes by data objects
- Routes by methods
- tasks
- projects
- users
- tags
Use the next routes to perform operations on tasks:
HTTP method | Route | Description |
---|---|---|
GET | /tasks | Gets data on all tasks and returns a json object with an array of tasks objects |
GET | /project/tasks | Gets data on all tasks of the specified project and returns a json object with an array of all tasks objects for this specified project |
POST | /tasks | Creates a new task and returns a task object with the ID of a new task |
POST | /clone | Creates a copy of a task and returns a json object with the client task ID and duplicated task ID of the server |
PUT | /tasks | Updates data on the specified task(s) and returns an empty json object |
PUT | /move | Moves a task to the specified position and returns an empty json object |
PUT | /sort | Sorts all tasks of an active project by the specified parameters and returns an empty json object |
DELETE | /tasks | Deletes data on a task and returns an empty json object |
Use the next routes to perform operations on projects:
HTTP method | Route | Description |
---|---|---|
GET | /projects | Gets data on all projects and returns a json object with an array of projects objects |
POST | /projects | Creates a new project and returns a project object with the project ID in it |
PUT | /projects | Updates data on a project and returns an empty json object |
DELETE | /projects | Deletes data on a project and returns an empty json object |
Use the next routes to perform operations on users:
HTTP method | Route | Description |
---|---|---|
GET | /users | Gets data on all users and returns a json object with an array of users objects |
Use the next routes to perform operations on tags:
HTTP method | Route | Description |
---|---|---|
GET | /tags | Gets data on all tags and returns a json object with an array of these tags |
- GET
- POST
- PUT
- DELETE
Name | Description |
---|---|
GET /users | Returns a json object with an array of all users objects |
GET /tasks | Returns a json object with an array of all tasks objects |
GET /projects | Returns a json object with an array of all available projects objects |
GET /tags | Returns a json object with an array of all default tags |
GET /project/tasks | Returns a json object with an array of all tasks objects for the specified project |
Name | Description |
---|---|
POST /clone | Returns a json object with the client task ID and duplicated task ID of the server. |
POST /projects | Returns a new project object with the project ID in it |
POST /tasks | Returns a new task object with the ID of a new task |
Name | Description |
---|---|
PUT /move | Returns an empty json object in case tasks are successfully moved as requested |
PUT /sort | Returns an empty json object in case tasks are sorted as requested |
PUT /tasks | Returns an empty json object in case a task is modified as requested |
PUT /projects | Returns an empty json object in case a project is modified as requested |
Name | Description |
---|---|
DELETE /tasks | Returns an empty json object in case a task is successfully removed |
DELETE /projects | Returns an empty json object in case a project is successfully removed |