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

Danh sách cơ hội

Endpoint​

GET /api/v6.1/opportunities

Dùng API này khi cần lọc danh sách cơ hội theo chiến dịch (theo campaign_id hoặc campaign_code). Không truyền filtering[campaign_code] vào API chi tiết /opportunity.

Ví dụ yêu cầu​

curl --location --globoff 'https://demo.getflycrm.com/api/v6.1/opportunities?fields=id,opportunity_name,opportunity_code,probability,opportunity_status,opportunity_status_name,recipient,rcpt_avatar,rcpt_display_name,rcpt_role_name,rcpt_department_name,created_at,time_registed,responsible,c_display_name,create_user,account_id,account_name,phone_office,account_email,campaign_id,campaign_name&filtering[campaign_code]=CD0008' \
--header 'X-API-KEY: YOUR_API_KEY'

Lọc theo ID chiến dịch:

curl --location --globoff 'https://demo.getflycrm.com/api/v6.1/opportunities?fields=id,opportunity_name,campaign_id,campaign_name&filtering[campaign_id]=25' \
--header 'X-API-KEY: YOUR_API_KEY'

Contains (mã chứa chuỗi):

curl --location --globoff 'https://demo.getflycrm.com/api/v6.1/opportunities?fields=id,opportunity_name,campaign_id&filtering[campaign_code:contains]=CD' \
--header 'X-API-KEY: YOUR_API_KEY'

Tham số truy vấn​

Tham sốKiểuMô tả
fieldsstringDanh sách trường cần lấy (phân tách bằng dấu phẩy)
limit / offsetintegerPhân trang
sort / directionstringSắp xếp (vd id, DESC)

Filtering​

Tham sốToán tửKiểuMô tả
filtering[id]eq, ne, inintegerID cơ hội
filtering[campaign_id]eq, inintegerID chiến dịch
filtering[campaign_code]eq, in, containsstringMã chiến dịch
filtering[opportunity_status]eq, inintegerTrạng thái cơ hội
filtering[opportunity_status_name]eq, containsstringTên trạng thái
filtering[account_id]eq, inintegerID khách hàng
filtering[recipient]eq, inintegerID người xử lý
filtering[create_user]eq, inintegerID người tạo
filtering[valid]is, inintegerBản ghi hợp lệ

Không truyền toán tử (filtering[campaign_code]=CD0008) tương đương eq.

Phản hồi mẫu​

{
"data": [
{
"id": 123456,
"opportunity_name": "Cơ hội ABC",
"opportunity_code": "CH123456",
"probability": 60,
"opportunity_status": 100,
"opportunity_status_name": "Gặp mặt và chăm sóc",
"recipient": 5,
"rcpt_avatar": "https://example.com/avatar.jpg",
"rcpt_display_name": "Người A",
"rcpt_role_name": "Trưởng phòng",
"rcpt_department_name": "Kinh doanh",
"created_at": "2025-05-29 10:00:08",
"time_registed": 0,
"responsible": 5,
"c_display_name": "Người tạo",
"create_user": 3,
"account_id": 7890,
"account_name": "Khách hàng ABC",
"account_email": "",
"campaign_id": 25,
"campaign_name": "Chiến dịch mẫu",
"status": 0,
"status_label": "Đang thực hiện",
"define_fields": {
"text_input": "JPSKW",
"number_input": "12"
}
}
],
"has_more": true,
"offset": 0,
"limited": 20,
"sorted": {
"id": "DESC"
}
}

Mô tả các trường chính​

TrườngKiểuMô tả
idintID cơ hội
opportunity_namestringTên cơ hội
opportunity_codestringMã cơ hội
probabilityintXác suất thành công (%)
opportunity_statusintMã trạng thái cơ hội
opportunity_status_namestringTên trạng thái
recipientintID người nhận xử lý
rcpt_display_namestringTên hiển thị người xử lý
rcpt_avatarstringẢnh đại diện người xử lý
rcpt_role_namestringVai trò người xử lý
rcpt_department_namestringPhòng ban người xử lý
created_atstring (datetime)Ngày tạo cơ hội
time_registedintThời điểm đăng ký (0 nếu không đặt)
responsibleintID người phụ trách
c_display_namestringTên người tạo
create_userintID người tạo
account_idintID khách hàng
account_namestringTên khách hàng
account_emailstringEmail khách hàng
campaign_idintID chiến dịch
campaign_namestringTên chiến dịch
statusintTrạng thái
status_labelstringNhãn trạng thái
define_fieldsobjectTrường định nghĩa dữ liệu

Xử lý lỗi thường gặp​

MãNguyên nhân thường gặp
400 invalid_parameterFiltering field/toán tử không hỗ trợ (vd truyền filter sai API)
401Thiếu hoặc sai X-API-KEY