Skip to main content

Task Details

Endpoint​

URL: /api/v6.1/task 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. |
| task_code | string | The task code to retrieve details for. |\

Request Example​

curl --location 'https://xxx.getflycrm.com/api/v6.1/task?fields=id%2Ctask_code%2Ctask_name%2Ctask_start_date%2Ctask_end_date%2Ctask_status%2Ctask_receiver_display_name%2Cproject_name&task_code=CVI%2F2025-02%2F0075' \
--header 'X-API-KEY: <your_api_key>'

Response​

Response Structure​

{
    "task_code": "CVI/2025-02/0075",
    "task_name": "Meeting",
    "task_start_date": "2025-02-20 09:32:35",
    "task_end_date": "2025-02-20 10:32:35",
    "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": "photo_2024-12-13_21-32-10.jpg",
    "task_color": "",
    "project_id": 1,
    "project_name": "Work",
    "task_remain_day": 1,
    "task_emoji": "lbl_emoji_no_feelings",
    "task_creator": 2,
    "left": 172,
    "right": 173,
    "task_object": null,
    "valid": 1,
    "project_status": 2,
    "project_valid": 1,
    "my_level": 0,
    "custom_fields": [],
    "task_status_title": "1 day left",
    "task_accounts": []
}

Description of Fields in Response​

| Field | Data Type | Description |
|--------|-------------|--------|
| 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. |
| 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. |
| project_id | integer | Related project ID. |
| project_name | string | Related project name. |
| task_remain_day | integer | Number of days remaining to complete the task. |
| task_emoji | string | Task status emoji. |
| task_creator | integer | ID of the task creator. |
| left | integer | left value in the task tree. |
| right | integer | right value in the task tree. |
| task_object | object | Object related to the task (if any). |
| valid | integer | Indicates if the task is valid. |
| project_status | integer | Status of the project containing the task. |
| project_valid | integer | Indicates if the project is valid. |
| my_level | integer | User's level for the task. |
| custom_fields | array | List of custom fields. |
| task_status_title | string | Task status title. |
| task_accounts | array | List of accounts related to the task. |\

Notes​

  • This API returns detailed information about a task based on task_code.
  • If the task does not exist, the API will return an error.