LMS Collaborator knowledge base

Home/Technical requirements/API/API - List of tasks

API – List of tasks

See API – Authorization

  • To get the list of tasks you need to send GET request to the following URI http://localhost:8080/api/v2/tasks/get-list
  • The request must contain the headings Content-Type: application/json;charset=UTF-8 and Authorization: Bearer xxxxxx.

Request example:
curl 'http://localhost:8080/api/v2/tasks/get-list' -H 'Authorization: Bearer xxxxxx' -H 'Content-Type: application/json;charset=UTF-8'


Answer

  • In case of successful request (HTTP response code - 200), the following result will be returned:
    data -task array
    pager - pagination object (information about the number of pages, the current page, the number of tasks)
    counts - counter object (information about the number of tasks grouped by statuses)

The query supports filtering by the following fields:

   title - Title
   type - Type
   tags - Tags
   created_at - Date of creation
   date_start - Start Date
   date_finish - Completion date

Example of a query with an title search:
curl 'http://localhost:8080/api/v2/tasks/get-list?filter[title]=foo

  • In case of error (HTTP response code - 400) it returns JSON object with error information
Still have questions?
Our technical support team is always happy to help!
Write to us at technical support [email protected]. If you are registered on our Helpdesk - send request button below.
Send request