API

CRM APIs

GET sales/opportunities

Gets a list of opportunities

HTTP method GET
URI https://api.rambase.net/sales/opportunities
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 2773, version 32

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
1

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

ActiveAndOnHold() Named filter Lists a combination of opportunities on hold and active
ActiveOpportunities() Named filter All active opportunities
AssignedToMe() Named filter All opportunities assigned to me
ClosedOpportunities() Named filter All closed opportunities
CreatedByMe() Named filter All opportunities created by me
ExtendedValue() Named filter All opportunities having extended values
LostOpportunities() Named filter All lost opportunities
MyOpportunities() Named filter Lists active opportunities I have created or assigned to.
OpportunitiesOnHold() Named filter Opportunities that is on hold
WonOpportunities() Named filter All won opportunities
WonOrActive() Named filter Shows active or won opportunity
AssigneeId Integer Employee identifier. Available macros: currentUser()
AssigneeLastName String Last name of employee.
ContactId Integer Contact identifier.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CustomerId Integer Customer identifier.
ExpectedCloseDate Date The date when you expect the deal to be closed. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
OneTimeRevenueAmount Integer The value of startup/creation of the opportunity.
OpportunityStageChangedAt Datetime The date the opportunity entered the stage. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
OpportunityStageId Integer Opportunity stage identifier.
OpportunityStatusChangedDate Date The date when the status was last changed. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
OwnerId Integer Employee identifier. Available macros: currentUser()
Probability Integer The probability of winning this opportunity in percentage.
RecurringRevenueAmount Integer Monthly reccuring value of the opportunity.
SalesOpportunityId Integer Sales opportunity identifier.
Source Integer The source of this Opportunity/lead (website, conference, marketing campaign....).
Status Integer The current status of an opportunity..
Title String The title of the opportunity.
Value Integer The unweighted value of this opportunity (amount).
WeightedValue Integer The value of this opportunity weighted against the probability.

Read more about filters and sorting on how to use sortable parameters

AssigneeId Integer Employee identifier
AssigneeLastName String Last name of employee
ContactId Integer Contact identifier
CreatedAt Datetime Date and time of creation
CustomerId Integer Customer identifier
ExpectedCloseDate Date The date when you expect the deal to be closed.
OneTimeRevenueAmount Integer The value of startup/creation of the opportunity
OpportunityStageChangedAt Datetime The date the opportunity entered the stage
OpportunityStageId Integer Opportunity stage identifier
OpportunityStatusChangedDate Date The date when the status was last changed
OwnerId Integer Employee identifier
Probability Integer The probability of winning this opportunity in percentage.
RecurringRevenueAmount Integer Monthly reccuring value of the opportunity
SalesOpportunityId Integer Sales opportunity identifier
Source Integer The source of this Opportunity/lead (website, conference, marketing campaign....)
Status Integer The current status of an opportunity.
Title String The title of the opportunity
Value Integer The unweighted value of this opportunity (amount)
WeightedValue Integer The value of this opportunity weighted against the probability

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<SalesOpportunities>
2
     <SalesOpportunity>
3
          <SalesOpportunityId
SalesOpportunityId

Sales opportunity identifier

>{Integer}</SalesOpportunityId>
4
          <Status
Status

The current status of an opportunity.

Possible domain values can be found here

>{Integer}</Status>
5
          <Title
Title

The title of the opportunity

>{String}</Title>
6
          <Source
Source

The source of this Opportunity/lead (website, conference, marketing campaign....)

Possible domain values can be found here

>{Integer}</Source>
7
          <ExpectedCloseDate
ExpectedCloseDate

The date when you expect the deal to be closed.

>{Date}</ExpectedCloseDate>
8
          <Probability
Probability

The probability of winning this opportunity in percentage.

>{Integer}</Probability>
9
          <OpportunityStageChangedAt
OpportunityStageChangedAt

The date the opportunity entered the stage

>{Datetime}</OpportunityStageChangedAt>
10
          <OpportunityStatusChangedDate
OpportunityStatusChangedDate

The date when the status was last changed

>{Date}</OpportunityStatusChangedDate>
11
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
12
          <Value>
13
               <Currency
Currency

Currencies used by the customer

Possible domain values can be found here

>{String}</Currency>
14
               <UnweightedAmount
UnweightedAmount

The unweighted value of this opportunity (amount)

>{Integer}</UnweightedAmount>
15
               <WeightedAmount
WeightedAmount

The value of this opportunity weighted against the probability

>{Integer}</WeightedAmount>
16
               <OneTimeRevenueAmount
OneTimeRevenueAmount

The value of startup/creation of the opportunity

>{Integer}</OneTimeRevenueAmount>
17
               <RecurringRevenueAmount
RecurringRevenueAmount

Monthly reccuring value of the opportunity

>{Integer}</RecurringRevenueAmount>
18
               <ContractMonths
ContractMonths

Number of months with recurring value

>{Integer}</ContractMonths>
19
          </Value>
20
          <Contact
Contact

Contact reference

>
21
               <ContactId
ContactId

Contact identifier

>{Integer}</ContactId>
22
               <FirstName
FirstName

Firstname/givenname of the contact

>{String}</FirstName>
23
               <LastName
LastName

Surname/familyname/lastname of the contact

>{String}</LastName>
24
               <ContactLink
ContactLink

Contact reference

>{String}</ContactLink>
25
          </Contact>
26
          <Customer
Customer

Customer reference

>
27
               <CustomerId
CustomerId

Customer identifier

>{Integer}</CustomerId>
28
               <Name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

>{String}</Name>
29
               <FirstName
FirstName

Secondary name of a company or firstname of a person

>{String}</FirstName>
30
               <Phone
Phone

Customers main phone number

This field is greyed out because it is an expandable field. You have to add $expand=SalesOpportunity.Customer.Phone in your request URI to get this field

>{String}</Phone>
31
               <Email
Email

Customers main email

This field is greyed out because it is an expandable field. You have to add $expand=SalesOpportunity.Customer.Email in your request URI to get this field

>{String}</Email>
32
               <Sales>
33
                    <SalesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

>{String}</SalesDistrict>
34
                    <MarketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

>{String}</MarketSegment>
35
               </Sales>
36
               <CustomerLink
CustomerLink

Customer reference

>{String}</CustomerLink>
37
          </Customer>
38
          <Owner
Owner

PID reference to the owner of the opportunity

>
39
               <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
40
               <LastName
LastName

Last name of employee

>{String}</LastName>
41
               <FirstName
FirstName

First name of employee

>{String}</FirstName>
42
               <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
43
          </Owner>
44
          <Assignee
Assignee

The employee the opportunity is assigned to.

>
45
               <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
46
               <LastName
LastName

Last name of employee

>{String}</LastName>
47
               <FirstName
FirstName

First name of employee

>{String}</FirstName>
48
               <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
49
          </Assignee>
50
          <OpportunityStage
OpportunityStage

The stage this opportunity is currently in.

>
51
               <OpportunityStageId
OpportunityStageId

Opportunity stage identifier

>{Integer}</OpportunityStageId>
52
               <Name
Name

The name of the stage

>{String}</Name>
53
               <Probability
Probability

The probability of winning the opportunity when it is in this stage. In percentage.

>{Integer}</Probability>
54
               <DaysBeforeWarning
DaysBeforeWarning

The number of days the opportunity can stay in this stage without causing a warning.

>{Integer}</DaysBeforeWarning>
55
               <OpportunityStageLink
OpportunityStageLink

Opportunity stage reference

>{String}</OpportunityStageLink>
56
          </OpportunityStage>
57
          <SalesOpportunityLink
SalesOpportunityLink

Sales opportunity reference

>{String}</SalesOpportunityLink>
58
     </SalesOpportunity>
59
     <Paging
Paging

Detailed paging information for this list.

>
60
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
61
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
62
          <Page
Page

Page index

>{Integer}</Page>
63
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
64
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
65
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
66
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
67
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
68
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
69
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
70
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
71
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
72
     </Paging>
73
</SalesOpportunities>
1
{
2
     "salesOpportunities": [
3
          {
4
               "salesOpportunityId
SalesOpportunityId

Sales opportunity identifier

": "{Integer}",
5
               "status
Status

The current status of an opportunity.

Possible domain values can be found here

": "{Integer}",
6
               "title
Title

The title of the opportunity

": "{String}",
7
               "source
Source

The source of this Opportunity/lead (website, conference, marketing campaign....)

Possible domain values can be found here

": "{Integer}",
8
               "expectedCloseDate
ExpectedCloseDate

The date when you expect the deal to be closed.

": "{Date}",
9
               "probability
Probability

The probability of winning this opportunity in percentage.

": "{Integer}",
10
               "opportunityStageChangedAt
OpportunityStageChangedAt

The date the opportunity entered the stage

": "{Datetime}",
11
               "opportunityStatusChangedDate
OpportunityStatusChangedDate

The date when the status was last changed

": "{Date}",
12
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
13
               "value": {
14
                    "currency
Currency

Currencies used by the customer

Possible domain values can be found here

": "{String}",
15
                    "unweightedAmount
UnweightedAmount

The unweighted value of this opportunity (amount)

": "{Integer}",
16
                    "weightedAmount
WeightedAmount

The value of this opportunity weighted against the probability

": "{Integer}",
17
                    "oneTimeRevenueAmount
OneTimeRevenueAmount

The value of startup/creation of the opportunity

": "{Integer}",
18
                    "recurringRevenueAmount
RecurringRevenueAmount

Monthly reccuring value of the opportunity

": "{Integer}",
19
                    "contractMonths
ContractMonths

Number of months with recurring value

": "{Integer}"
20
               },
21
               "contact
Contact

Contact reference

": {
22
                    "contactId
ContactId

Contact identifier

": "{Integer}",
23
                    "firstName
FirstName

Firstname/givenname of the contact

": "{String}",
24
                    "lastName
LastName

Surname/familyname/lastname of the contact

": "{String}",
25
                    "contactLink
ContactLink

Contact reference

": "{String}"
26
               },
27
               "customer
Customer

Customer reference

": {
28
                    "customerId
CustomerId

Customer identifier

": "{Integer}",
29
                    "name
Name

Name of customer (name of company or surname/familyname/lastname of a person)

": "{String}",
30
                    "firstName
FirstName

Secondary name of a company or firstname of a person

": "{String}",
31
                    "phone
Phone

Customers main phone number

This field is greyed out because it is an expandable field. You have to add $expand=SalesOpportunity.Customer.Phone in your request URI to get this field

": "{String}",
32
                    "email
Email

Customers main email

This field is greyed out because it is an expandable field. You have to add $expand=SalesOpportunity.Customer.Email in your request URI to get this field

": "{String}",
33
                    "sales": {
34
                         "salesDistrict
SalesDistrict

A geographic district for which an individual salesperson or sales team holds responsibility

Possible domain values can be found here

": "{String}",
35
                         "marketSegment
MarketSegment

Market segment of the customer

Possible domain values can be found here

": "{String}"
36
                    },
37
                    "customerLink
CustomerLink

Customer reference

": "{String}"
38
               },
39
               "owner
Owner

PID reference to the owner of the opportunity

": {
40
                    "employeeId
EmployeeId

Employee identifier

": "{Integer}",
41
                    "lastName
LastName

Last name of employee

": "{String}",
42
                    "firstName
FirstName

First name of employee

": "{String}",
43
                    "employeeLink
EmployeeLink

Employee reference

": "{String}"
44
               },
45
               "assignee
Assignee

The employee the opportunity is assigned to.

": {
46
                    "employeeId
EmployeeId

Employee identifier

": "{Integer}",
47
                    "lastName
LastName

Last name of employee

": "{String}",
48
                    "firstName
FirstName

First name of employee

": "{String}",
49
                    "employeeLink
EmployeeLink

Employee reference

": "{String}"
50
               },
51
               "opportunityStage
OpportunityStage

The stage this opportunity is currently in.

": {
52
                    "opportunityStageId
OpportunityStageId

Opportunity stage identifier

": "{Integer}",
53
                    "name
Name

The name of the stage

": "{String}",
54
                    "probability
Probability

The probability of winning the opportunity when it is in this stage. In percentage.

": "{Integer}",
55
                    "daysBeforeWarning
DaysBeforeWarning

The number of days the opportunity can stay in this stage without causing a warning.

": "{Integer}",
56
                    "opportunityStageLink
OpportunityStageLink

Opportunity stage reference

": "{String}"
57
               },
58
               "salesOpportunityLink
SalesOpportunityLink

Sales opportunity reference

": "{String}"
59
          }
60
     ],
61
     "paging
Paging

Detailed paging information for this list.

": {
62
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
63
          "position
Position

Position of the first element in the list

": "{Integer}",
64
          "page
Page

Page index

": "{Integer}",
65
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
66
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
67
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
68
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
69
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
70
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
71
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
72
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
73
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
74
     }
75
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 102738 HTTP 404 Price list not found
Error 100055 HTTP 403 You have only admittance to your own objects