Opportunity Details

Endpoint

GET /api/v6.1/opportunity

Request Example

curl --location 'https://demo.getflycrm.com/api/v6.1/opportunity?fields=id%2Copportunity_name%2Cprobability%2Copportunity_code%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&opportunity_code=CH2284' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Cookie: v6_getflycrm_session=YOUR_SESSION_TOKEN'

Query Parameters

Name	Type	Required	Description
fields	string	✔️	List of fields to retrieve (comma-separated, URL encoded)
opportunity_code	string	✔️	Opportunity code to query

Sample Response

{
  "id": 4404,
  "opportunity_name": "Demo Opportunity",
  "probability": 0,
  "opportunity_code": "CH2284",
  "opportunity_status": 37,
  "opportunity_status_name": "Customer Information",
  "recipient": 2,
  "rcpt_avatar": "https://example.com/avatar.jpg",
  "rcpt_display_name": "Handler",
  "rcpt_role_name": "Manager",
  "rcpt_department_name": "Sales Department",
  "created_at": "2025-01-13 10:46:47",
  "time_registed": 0,
  "responsible": 2,
  "c_display_name": "Creator",
  "create_user": 2,
  "account_id": 11970,
  "account_name": "Demo Customer",
  "account_email": "[email protected]",
  "campaign_id": 10,
  "campaign_name": "Sample Campaign"
}

Key Field Descriptions

Field	Type	Description
id	int	Opportunity ID
opportunity_name	string	Opportunity name
opportunity_code	string	Opportunity code
probability	int	Success probability (%)
opportunity_status	int	Opportunity status code
opportunity_status_name	string	Status name
recipient	int	Handler ID
rcpt_avatar	string	Handler avatar
rcpt_display_name	string	Handler name
rcpt_role_name	string	Handler role
rcpt_department_name	string	Handler department
created_at	datetime	Opportunity creation time
time_registed	int	Registration time (if any)
responsible	int	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	Linked campaign ID
campaign_name	string	Campaign name