Chuyển tới nội dung chính

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ệuMô tả
fieldsstringDanh sách các trường cần lấy dữ liệu, phân tách bằng dấu phẩy.
limitintegerSố lượng bản ghi cần lấy.
offsetintegerSố lượng bản ghi cần bỏ qua.
sort_bystringTrường cần sắp xếp (task_start_date, task_end_date, created_at, updated_at).
orderstringThứ tự sắp xếp (asc hoặc desc).
filterobjectBộ 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ườngKiểu dữ liệuMô tả
dataarrayDanh sách các công việc.
idintegerID của công việc.
task_codestringMã công việc.
task_namestringTên công việc.
task_start_datestringNgày và giờ bắt đầu công việc.
task_end_datestringNgày và giờ kết thúc công việc.
notifications_countintegerSố lượng thông báo liên quan đến công việc.
task_statusintegerTrạng thái của công việc.
task_progressintegerTiến độ của công việc (0-100%).
user_importantintegerĐá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_receiverintegerID của người nhận công việc.
task_receiver_display_namestringTên hiển thị của người nhận công việc.
task_receiver_emailstringEmail của người nhận công việc.
task_receiver_phonestringSố điện thoại của người nhận công việc.
task_receiver_avatarstringẢnh đại diện của người nhận công việc.
task_colorstringMàu sắc của công việc (nếu có).
project_idintegerID dự án liên quan.
project_namestringTên dự án liên quan.
task_status_titlestringTiêu đề trạng thái của công việc (ví dụ: "Còn 1 ngày").
task_accountsarrayDanh sách tài khoản liên quan đến công việc.
has_morebooleanXác định có thêm dữ liệu hay không.
offsetintegerGiá trị offset của kết quả hiện tại.
limitedintegerSố lượng bản ghi được trả về.
sortedobjectTrườ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ườngToán tử hỗ trợ
ideq, in
task_statuseq, ne
task_nameeq, contains
project_ideq, in
task_receivereq, in
task_creatoreq, in
task_start_dateeq, between, gte, lte, lt, gt
task_end_dateeq, between, gte, lte, lt, gt
created_timebetween
updated_timebetween

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ệuMô tả
limitintegerSố lượng bản ghi cần lấy.
offsetintegerSố lượng bản ghi cần bỏ qua.

Ghi chú

  • API hỗ trợ phân trang bằng limitoffset.
  • 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.