Opportunity List

Get a list of opportunities

HTTP Request

[GET] /api/v6/opportunities

Query Parameters

Fields

Fields	Type	Description
id	integer	Identifier
opportunity_name	string	Opportunity name
probability	numeric	Opportunity probability
opportunity_status	integer	Opportunity status
opportunity_status_name	string	Opportunity status name
recipient	integer	Opportunity manager
rcpt_avatar	string	Opportunity manager photo
rcpt_display_name	string	Opportunity manager name
rcpt_role_name	string	Opportunity manager level
rcpt_department_name	string	Opportunity manager department
created_at	timestamp	Creation date
time_registed	string	Opportunity registration time
responsible	timestamp	Campaign manager
c_display_name	string	Creator name
create_user	integer	Creator identifier
account_id	float	Customer identifier
account_name	float	Customer name
phone_office	string	Customer phone number
account_email	float	Customer email
campaign_id	float	Campaign identifier
campaign_name	float	Campaign name

Filtering

Fields	Support	Type	Description
id	eq,in	integer	Identifier
campaign_id	eq,in	integer	Campaign identifier
opportunity_status	eq,in	string	Opportunity status
opportunity_status_name	eq,contains	string	Opportunity status name

Sort

Sort (field)	Direction
id	asc,desc

Limit & Offset

	Type	Description
Limit	integer	Number of records to retrieve
Offset	integer	Number of records to skip

Example

HTTP Request

GET api/v6/opportunities?fields=opportunity_name&filtering[id]=4&limit=1 HTTP/1.1
Host: example.getflycrm.com
Content-Type: application/json

Status

200 OK

Response

{
  "data": [
    {
      "id": 4,
      "opportunity_name": "TEST OPPORTUNITY API"
    }
  ],
  "has_more": false,
  "offset": 0,
  "limited": 1
}