Skip to main content

Task List

Endpoint​

URL: /api/v6.1/tasks Method: GET

Request Headers​

X-API-KEY: <your_api_key>

Query Parameters​

| Parameter | Data Type | Description |
|-----------|---------|-------------|
| fields | string | List of data fields to retrieve, comma-separated. |
| limit | integer | Number of records to retrieve. |
| offset | integer | Number of records to skip. |
| sort_by | string | Field to sort by (task_start_date, task_end_date, created_at, updated_at). |
| order | string | Sort order (asc or desc). |
| filter | object | Data filter based on the list of supported filter fields. |\

Request Example​

curl --location 'https://xxxx.getflycrm.com/api/v6.1/tasks?fields=id%2Ctask_code%2Ctask_name%2Ctask_start_date%2Ctask_end_date%2Ctask_status%2Ctask_receiver_display_name%2Cproject_name&limit=5&offset=0&sort_by=task_start_date&order=desc' \
--header 'X-API-KEY: <API_KEY>'

Response​

Response Structure​

{
  "data": [
    {
      "id": 92,
      "task_code": "CVI/2025-02/0076",
      "task_name": "aaa",
      "task_start_date": "2025-02-25 09:33:50",
      "task_end_date": "2025-02-25 10:33:50",
      "notifications_count": 0,
      "task_status": 11,
      "task_progress": 0,
      "user_important": 0,
      "task_receiver": 2,
      "task_receiver_display_name": "Task Receiver",
      "task_receiver_email": "[email protected]",
      "task_receiver_phone": "",
      "task_receiver_avatar": "https://example.com/avatar.png...",
      "task_color": "",
      "project_id": 1,
      "project_name": "Work",
      "task_status_title": "1 day left",
      "task_accounts": []
    }
  ],
  "has_more": true,
  "offset": 0,
  "limited": 5,
  "sorted": {
    "task_start_date": "DESC"
  }
}

Description of Fields in Response​

| Field | Data Type | Description |
|--------|-------------|--------|
| data | array | List of tasks. |
| id | integer | Task ID. |
| task_code | string | Task code. |
| task_name | string | Task name. |
| task_start_date | string | Task start date and time. |
| task_end_date | string | Task end date and time. |
| notifications_count | integer | Number of notifications related to the task. |
| task_status | integer | Task status. |
| task_progress | integer | Task progress (0-100%). |
| user_important | integer | Marks the importance level of the task (0: not important, 1: important). |
| task_receiver | integer | ID of the person assigned the task. |
| task_receiver_display_name | string | Display name of the person assigned the task. |
| task_receiver_email | string | Email of the person assigned the task. |
| task_receiver_phone | string | Phone number of the person assigned the task. |
| task_receiver_avatar | string | Avatar of the person assigned the task. |
| task_color | string | Task color (if any). |
| project_id | integer | Related project ID. |
| project_name | string | Related project name. |
| task_status_title | string | Task status title (e.g., "1 day left"). |
| task_accounts | array | List of accounts related to the task. |
| has_more | boolean | Indicates if there is more data. |
| offset | integer | Current offset value of the result. |
| limited | integer | Number of records returned. |
| sorted | object | Sorted data field and sort order. |\

Supported Filter Fields​

List of filterable fields:

| Field | Supported Operators |
|------------|------------|
| id | eq, in |
| task_status | eq, ne |
| task_name | eq, contains |
| project_id | eq, in |
| task_receiver | eq, in |
| task_creator | eq, in |
| task_start_date | eq, between, gte, lte, lt, gt |
| task_end_date | eq, between, gte, lte, lt, gt |
| created_time | between |
| updated_time | between |\

Supported Sorting Options​

Supports sorting by the following fields:

  • task_start_date
  • task_end_date
  • created_at
  • updated_at

Pagination​

| Parameter | Data Type | Description |
|-----------|---------|-------------|
| limit | integer | Number of records to retrieve. |
| offset | integer | Number of records to skip. |\

Notes​

  • The API supports pagination using limit and offset.
  • Returns a maximum of 5 records per request.
  • If there are more records, has_more will be true.
  • task_accounts contains a list of accounts related to the task if any.
  • notifications_count is the number of notifications related to the task.
  • task_receiver_avatar is the avatar URL of the task receiver.