Danh Sách Công Việc
Endpoint
URL: /api/v6.1/tasks
Phương thức: GET
Tiêu đề yêu cầu (Request Headers)
X-API-KEY: <your_api_key>
Tham số yêu cầu (Query Parameters)
Tham số | Kiểu dữ liệu | Mô tả |
---|---|---|
fields | string | Danh sách các trường cần lấy dữ liệu, phân tách bằng dấu phẩy. |
limit | integer | Số lượng bản ghi cần lấy. |
offset | integer | Số lượng bản ghi cần bỏ qua. |
sort_by | string | Trường cần sắp xếp (task_start_date , task_end_date , created_at , updated_at ). |
order | string | Thứ tự sắp xếp (asc hoặc desc ). |
filter | object | Bộ lọc dữ liệu theo danh sách các trường hỗ trợ lọc. |
Ví dụ Request
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>'
Phản hồi (Response)
Cấu trúc Response
{
"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": "Người nhận công việc",
"task_receiver_email": "[email protected]",
"task_receiver_phone": "",
"task_receiver_avatar": "https://example.com/avatar.png...",
"task_color": "",
"project_id": 1,
"project_name": "Công việc",
"task_status_title": "Còn 1 ngày",
"task_accounts": []
}
],
"has_more": true,
"offset": 0,
"limited": 5,
"sorted": {
"task_start_date": "DESC"
}
}
Mô tả Các Trường Trong Response
Trường | Kiểu dữ liệu | Mô tả |
---|---|---|
data | array | Danh sách các công việc. |
id | integer | ID của công việc. |
task_code | string | Mã công việc. |
task_name | string | Tên công việc. |
task_start_date | string | Ngày và giờ bắt đầu công việc. |
task_end_date | string | Ngày và giờ kết thúc công việc. |
notifications_count | integer | Số lượng thông báo liên quan đến công việc. |
task_status | integer | Trạng thái của công việc. |
task_progress | integer | Tiến độ của công việc (0-100%). |
user_important | integer | Đánh dấu mức độ quan trọng của công việc (0: không quan trọng, 1: quan trọng). |
task_receiver | integer | ID của người nhận công việc. |
task_receiver_display_name | string | Tên hiển thị của người nhận công việc. |
task_receiver_email | string | Email của người nhận công việc. |
task_receiver_phone | string | Số điện thoại của người nhận công việc. |
task_receiver_avatar | string | Ảnh đại diện của người nhận công việc. |
task_color | string | Màu sắc của công việc (nếu có). |
project_id | integer | ID dự án liên quan. |
project_name | string | Tên dự án liên quan. |
task_status_title | string | Tiêu đề trạng thái của công việc (ví dụ: "Còn 1 ngày"). |
task_accounts | array | Danh sách tài khoản liên quan đến công việc. |
has_more | boolean | Xác định có thêm dữ liệu hay không. |
offset | integer | Giá trị offset của kết quả hiện t ại. |
limited | integer | Số lượng bản ghi được trả về. |
sorted | object | Trường dữ liệu được sắp xếp và thứ tự sắp xếp. |
Các Trường Hỗ Trợ Lọc (Filtering Options)
Danh sách các trường có thể lọc:
Trường | Toán tử hỗ trợ |
---|---|
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 |
Các Trường Hỗ Trợ Sắp Xếp (Sorting Options)
Hỗ trợ sắp xếp theo các trường:
task_start_date
task_end_date
created_at
updated_at
Phân Trang (Pagination)
Tham số | Kiểu dữ liệu | Mô tả |
---|---|---|
limit | integer | Số lượng bản ghi cần lấy. |
offset | integer | Số lượng bản ghi cần bỏ qua. |
Ghi chú
- API hỗ trợ phân trang bằng
limit
vàoffset
. - Trả về tối đa 5 bản ghi theo request.
- Nếu có thêm bản ghi,
has_more
sẽ làtrue
. task_accounts
chứa danh sách các tài khoản liên quan đến công việc nếu có.notifications_count
là số lượng thông báo liên quan đến công việc.task_receiver_avatar
là đường dẫn ảnh đại diện của người nhận công việc.