Get filtered opportunities
GET /api/2.0/crm/opportunity/filter
Request
Returns a list of all the opportunities matching the parameters specified in the request.
Authorization
An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization
.
Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436
.
Headers
- Accept
enum of string
Can be one of:
application/json
.- Content-Type
enum of string
Can be one of:
application/json
.
Body
- responsibleid
string
Opportunity responsible ID
- opportunityStagesid
integer
Opportunity stage ID
- tags
array of string
Opportunity tags
- contactid
integer
Contact ID
- stageType
array of integer
Opportunity stage type
- contactAlsoIsParticipant
array of boolean
Participation status: take into account opportunities where the contact is a participant or not
- fromDate
string
Start date
- toDate
string
End date
Examples
GET /api/2.0/crm/opportunity/filter HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request GET \
--url https://example.com/api/2.0/crm/opportunity/filter \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
List of opportunities
- CreateBy
object
- Id
string
uuid - DisplayName
string
- Title
string
- AvatarSmall
string
- ProfileUrl
string
- Created
string
- Members
array of object
- SmallFotoUrl
string
- MediumFotoUrl
string
- DisplayName
string
- IsCompany
boolean
- AccessList
array of object
- Id
string
uuid - DisplayName
string
- Title
string
- AvatarSmall
string
- ProfileUrl
string
- IsPrivate
boolean
- IsShared
boolean
- ShareType
enum of integer
int32 [0 - None, 1 - ReadWrite, 2 - Read]
Can be one of:
None
,ReadWrite
,Read
.- Currency
object
- Title
string
- Symbol
string
- Abbreviation
string
- CultureName
string
- IsConvertable
boolean
- IsBasic
boolean
- CanEdit
boolean
- CanDelete
boolean
- ID
integer
int32
- Contact
object
- SmallFotoUrl
string
- MediumFotoUrl
string
- DisplayName
string
- IsCompany
boolean
- AccessList
array of object
- Id
string
uuid - DisplayName
string
- Title
string
- AvatarSmall
string
- ProfileUrl
string
- IsPrivate
boolean
- IsShared
boolean
- ShareType
enum of integer
int32 [0 - None, 1 - ReadWrite, 2 - Read]
Can be one of:
None
,ReadWrite
,Read
.- Currency
object
- Title
string
- Symbol
string
- Abbreviation
string
- CultureName
string
- IsConvertable
boolean
- IsBasic
boolean
- CanEdit
boolean
- CanDelete
boolean
- ID
integer
int32
- Title
string
- Description
string
- Responsible
object
- Id
string
uuid - DisplayName
string
- Title
string
- AvatarSmall
string
- ProfileUrl
string
- BidType
enum of integer
int32 [0 - FixedBid, 1 - PerHour, 2 - PerDay, 3 - PerWeek, 4 - PerMonth, 5 - PerYear]
Can be one of:
FixedBid
,PerHour
,PerDay
,PerWeek
,PerMonth
,PerYear
.- BidValue
number
double - BidCurrency
object
- Title
string
- Symbol
string
- Abbreviation
string
- CultureName
string
- IsConvertable
boolean
- IsBasic
boolean
- PerPeriodValue
integer
int32 - Stage
object
- SuccessProbability
integer
int32 - StageType
enum of integer
int32 [0 - Open, 1 - ClosedAndWon, 2 - ClosedAndLost]
Can be one of:
Open
,ClosedAndWon
,ClosedAndLost
.- Title
string
- Description
string
- Color
string
- SortOrder
integer
int32 - ID
integer
int32
- SuccessProbability
integer
int32 - ActualCloseDate
string
- ExpectedCloseDate
string
- IsPrivate
boolean
- AccessList
array of object
- Id
string
uuid - DisplayName
string
- Title
string
- AvatarSmall
string
- ProfileUrl
string
- CanEdit
boolean
- CustomFields
array of object
- EntityId
integer
int32 - Label
string
- FieldValue
string
- FieldType
enum of integer
int32 [0 - TextField, 1 - TextArea, 2 - SelectBox, 3 - CheckBox, 4 - Heading, 5 - Date]
Can be one of:
TextField
,TextArea
,SelectBox
,CheckBox
,Heading
,Date
.- Position
integer
int32 - Mask
string
- ID
integer
int32
- ID
integer
int32
401
Unauthorized