Danh Sách Dự Án

Endpoint

URL: /api/v6.1/projects
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, phân tách bằng dấu phẩy. Chỉ hỗ trợ id và project_name. Nếu không truyền, API mặc định trả về cả hai trường.
limit	integer	Số lượng bản ghi cần lấy. Mặc định là 20.
offset	integer	Số lượng bản ghi cần bỏ qua. Mặc định là 0.
sort	string	Trường cần sắp xếp. Public API hỗ trợ id.
direction	string	Thứ tự sắp xếp: asc hoặc desc.
search	string	Tìm kiếm theo tên dự án (project_name).
filtering	object	Bộ lọc dữ liệu theo danh sách trường hỗ trợ lọc.

Ví dụ Request

curl --location --get 'https://xxxx.getflycrm.com/api/v6.1/projects' \
--header 'X-API-KEY: <API_KEY>' \
--data-urlencode 'fields=id,project_name' \
--data-urlencode 'limit=5' \
--data-urlencode 'offset=0' \
--data-urlencode 'sort=id' \
--data-urlencode 'direction=desc'

Request tương đương:

GET /api/v6.1/projects?fields=id%2Cproject_name&limit=5&offset=0&sort=id&direction=desc

Phản hồi (Response)

Cấu trúc Response

{
  "data": [
    {
      "id": 1,
      "project_name": "Dự án CRM"
    }
  ],
  "has_more": true,
  "offset": 0,
  "limited": 5,
  "sorted": {
    "id": "DESC"
  }
}

Mô tả Các Trường Trong Response

Trường	Kiểu dữ liệu	Mô tả
data	array	Danh sách dự án.
id	integer	ID của dự án.
project_name	string	Tên dự án.
has_more	boolean	Xác định còn dữ liệu ở trang tiếp theo 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 tối đa được yêu cầu trả về.
sorted	object	Trường và thứ tự sắp xếp đang áp dụng.

Các Trường Có Thể Lấy (Fields)

Trường	Kiểu dữ liệu	Mô tả
id	integer	ID của dự án.
project_name	string	Tên dự án.

Mọi field ngoài danh sách trên đều không hợp lệ.

Các Trường Hỗ Trợ Lọc (Filtering Options)

Trường	Toán tử hỗ trợ	Mô tả
id	eq, in	Lọc theo một hoặc nhiều ID dự án.

Ví dụ lọc theo ID

curl --location --get 'https://xxxx.getflycrm.com/api/v6.1/projects' \
--header 'X-API-KEY: <API_KEY>' \
--data-urlencode 'fields=id,project_name' \
--data-urlencode 'filtering[id:eq]=1'

Tìm kiếm (Search)

Tham số search tìm kiếm theo tên dự án.

curl --location --get 'https://xxxx.getflycrm.com/api/v6.1/projects' \
--header 'X-API-KEY: <API_KEY>' \
--data-urlencode 'fields=id,project_name' \
--data-urlencode 'search=CRM'

Các Trường Hỗ Trợ Sắp Xếp (Sorting Options)

Trường	Thứ tự hỗ trợ
id	asc, desc

Nếu không truyền sort và direction, API mặc định sắp xếp theo id giảm dần (DESC).

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. Mặc định là 20.
offset	integer	Số lượng bản ghi cần bỏ qua. Mặc định là 0.

API lấy thêm một bản ghi nội bộ để xác định has_more, nhưng chỉ trả về tối đa số lượng bản ghi được chỉ định bởi limit.

Ghi chú

• API yêu cầu public API key hợp lệ trong header X-API-KEY.
• API mặc định chỉ lấy các dự án đang hợp lệ (valid = 1).
• Nếu không truyền fields, response vẫn mặc định gồm id và project_name.
• Tên query parameter đúng là filtering, sort và direction.
• Khi truyền field không được hỗ trợ, API trả về lỗi field không hợp lệ.