Opportunity List

Endpoint

GET /api/v6.1/opportunities

Request Example

curl --location --globoff 'https://demo.getflycrm.com/api/v6.1/opportunities?fields=id%2Copportunity_name%2Copportunity_code%2Cprobability%2Copportunity_status%2Copportunity_status_name%2Crecipient%2Crcpt_avatar%2Crcpt_display_name%2Crcpt_role_name%2Crcpt_department_name%2Ccreated_at%2Ctime_registed%2Cresponsible%2Cc_display_name%2Ccreate_user%2Caccount_id%2Caccount_name%2Cphone_office%2Caccount_email%2Ccampaign_id%2Ccampaign_name&filtering[campaign_code]=CD0008' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Cookie: v6_getflycrm_session=YOUR_SESSION_TOKEN'

Query Parameters

Parameter	Type	Description
fields	string	List of fields to retrieve (comma-separated, URL encoded)
filtering[campaign_code]	string	Campaign code to filter opportunities

Sample Response

{
  "data": [
    {
      "id": 123456,
      "opportunity_name": "Opportunity ABC",
      "opportunity_code": "CH123456",
      "probability": 60,
      "opportunity_status": 100,
      "opportunity_status_name": "Meeting and Care",
      "recipient": 5,
      "rcpt_avatar": "https://example.com/avatar.jpg",
      "rcpt_display_name": "Person A",
      "rcpt_role_name": "Manager",
      "rcpt_department_name": "Sales",
      "created_at": "2025-05-29 10:00:08",
      "time_registed": 0,
      "responsible": 5,
      "c_display_name": "Creator",
      "create_user": 3,
      "account_id": 7890,
      "account_name": "Customer ABC",
      "account_email": "",
      "campaign_id": 25,
      "campaign_name": "Sample Campaign"
    }
  ],
  "has_more": true,
  "offset": 0,
  "limited": 20,
  "sorted": {
    "id": "DESC"
  }
}

Key Field Descriptions

Field	Type	Description
id	int	Opportunity ID
opportunity_name	string	Opportunity name
opportunity_code	string	Opportunity code (auto-generated)
probability	int	Success probability (%)
opportunity_status	int	Opportunity status code
opportunity_status_name	string	Status name
recipient	int	Handler ID
rcpt_display_name	string	Handler display name
rcpt_avatar	string	Handler avatar
rcpt_role_name	string	Handler role
rcpt_department_name	string	Handler department
created_at	string (datetime)	Opportunity creation date
time_registed	int	Opportunity registration time (0 if not set)
responsible	int	Opportunity responsible person ID
c_display_name	string	Opportunity creator name
create_user	int	Creator ID
account_id	int	Related customer ID
account_name	string	Customer name
account_email	string	Customer email
campaign_id	int	Campaign ID
campaign_name	string	Campaign name