API - Tasks

API gateway

https://app.boostramp.com/api/task.php?token=%token%&func=%function%


Required GET fields 

token - Your API session token. Learn how to log in and obtain your session token

func - The API function you wish to call

For guidance on how to use the Boostramp API, refer to our API usage example article 


Endpoints

1. getTasks

get project tasks

Endpoint 

https://app.boostramp.com/api/task.php?func=getTasks

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (GET) sort (string, optional): , "favorites", "date_added", "page-error", "page-content", default "date_added"
  • (GET) order (optional): ASC or DESC, default DESC
  • (GET) limit (int, optional): lines in the report, default 50
  • (GET) start (int, optional): line to start from, default 0


2. getTotalTasks

Get total project tasks

Endpoint 

https://app.boostramp.com/api/task.php?func=getTotalTasks

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)


3. removeTask

Delete task

Endpoint 

https://app.boostramp.com/api/task.php?func=removeTask

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (GET) task_id (int, required): Task ID


4. removeAllTasks

Delete all tasks

Endpoint 

https://app.boostramp.com/api/task.php?func=removeAllTasks

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)


5. addToFavorites

Add the task to Favorites

Endpoint 

https://app.boostramp.com/api/task.php?func=addToFavorites

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (GET) task_id (int, required): TaskID


6. removeFromFavorites

Delete the task from Favorites

Endpoint 

https://app.boostramp.com/api/task.php?func=removeFromFavorites

Parameters

  • (GET) token (int, required): Your API session token.
  • (GET) project_id (int, required): The ID of the project you want to retrieve information for (You can obtain the project ID by making a call to the 'listProjects' function or by finding it in the project details URL)
  • (GET) task_id (int, required): Task ID