POST api/opportunities/list
Request Information
URI Parameters
None.
Body Parameters
DataSourceRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| page | integer |
None. |
|
| page_size | integer |
None. |
|
| skip | integer |
None. |
|
| take | integer |
None. |
|
| sorts | Collection of SortDescriptor |
None. |
|
| filters | Collection of IFilterDescriptor |
None. |
Request Formats
application/json, text/json
Sample:
{
"page": 1,
"page_size": 2,
"skip": 3,
"take": 4,
"sorts": [
{
"member": "sample string 1",
"sort_direction": 0
},
{
"member": "sample string 1",
"sort_direction": 0
}
],
"filters": null
}
application/xml, text/xml
Sample:
<DataSourceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Infrastructure.DataSource">
<Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<Page>1</Page>
<PageSize>2</PageSize>
<Skip>3</Skip>
<Sorts>
<SortDescriptor>
<Member>sample string 1</Member>
<SortDirection>Ascending</SortDirection>
</SortDescriptor>
<SortDescriptor>
<Member>sample string 1</Member>
<SortDirection>Ascending</SortDirection>
</SortDescriptor>
</Sorts>
<Take>4</Take>
</DataSourceRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
DataSourceResultOfOpportunityListModel| Name | Description | Type | Additional information |
|---|---|---|---|
| data | Collection of OpportunityListModel |
None. |
|
| total | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": [
{
"account_id": "6e6dd8d3-7078-4157-a3fb-ab19d3fafc30",
"account": "sample string 2",
"account_mobile": "sample string 3",
"account_email": "sample string 4",
"lead_status_id": "9b770d1a-1a94-4798-bfcc-4a9f0e19db95",
"lead_status": "sample string 5",
"lead_status_color": "sample string 6",
"opportunity_date": "2026-02-09T19:50:33.5230753+08:00",
"referred_by_id": "fe557fbc-a41f-4684-87a2-ff5b48f3948a",
"referred_by": "sample string 8",
"referred_to_id": "02ed095f-530f-4f26-ae50-64a79db07ece",
"referred_to": "sample string 9",
"home_design": "sample string 10",
"development": "sample string 11",
"syndicate": "sample string 12",
"property": "sample string 13",
"campaign_recipient_id": "12b622c1-c321-4ffd-b010-faabc87c9349",
"campaign": "sample string 14",
"event_id": "098989aa-d65b-4266-85c2-61b8ecffced1",
"event": "sample string 15",
"survey_id": "032aa2b5-c70b-4523-a125-de42af4b15a7",
"survey": "sample string 16",
"opportunity_type_id": "71149b93-fe96-4cee-aaa0-92fe5ce87a76",
"opportunity_type": "sample string 18",
"opportunity_status_id": "9dad9cf4-2970-49f6-9275-4ec2ea94ff3b",
"opportunity_status": "sample string 20",
"opportunity_status_color": "sample string 21",
"source_id": "22bc4a49-9a42-44be-a1fe-a5f6498a6cb0",
"source": "sample string 22",
"source_origin": "sample string 23",
"country": "sample string 24",
"state": "sample string 25",
"city": "sample string 26",
"currency_abbr": "sample string 27",
"currency_culture": "sample string 28",
"referral_fee": 29.0,
"transaction_amount": 30.0,
"can_notify": true,
"can_update": true,
"can_delete": true,
"mark_as_deleted": true,
"id": "d85814b3-9add-41d3-962e-288fe0372840"
},
{
"account_id": "6e6dd8d3-7078-4157-a3fb-ab19d3fafc30",
"account": "sample string 2",
"account_mobile": "sample string 3",
"account_email": "sample string 4",
"lead_status_id": "9b770d1a-1a94-4798-bfcc-4a9f0e19db95",
"lead_status": "sample string 5",
"lead_status_color": "sample string 6",
"opportunity_date": "2026-02-09T19:50:33.5230753+08:00",
"referred_by_id": "fe557fbc-a41f-4684-87a2-ff5b48f3948a",
"referred_by": "sample string 8",
"referred_to_id": "02ed095f-530f-4f26-ae50-64a79db07ece",
"referred_to": "sample string 9",
"home_design": "sample string 10",
"development": "sample string 11",
"syndicate": "sample string 12",
"property": "sample string 13",
"campaign_recipient_id": "12b622c1-c321-4ffd-b010-faabc87c9349",
"campaign": "sample string 14",
"event_id": "098989aa-d65b-4266-85c2-61b8ecffced1",
"event": "sample string 15",
"survey_id": "032aa2b5-c70b-4523-a125-de42af4b15a7",
"survey": "sample string 16",
"opportunity_type_id": "71149b93-fe96-4cee-aaa0-92fe5ce87a76",
"opportunity_type": "sample string 18",
"opportunity_status_id": "9dad9cf4-2970-49f6-9275-4ec2ea94ff3b",
"opportunity_status": "sample string 20",
"opportunity_status_color": "sample string 21",
"source_id": "22bc4a49-9a42-44be-a1fe-a5f6498a6cb0",
"source": "sample string 22",
"source_origin": "sample string 23",
"country": "sample string 24",
"state": "sample string 25",
"city": "sample string 26",
"currency_abbr": "sample string 27",
"currency_culture": "sample string 28",
"referral_fee": 29.0,
"transaction_amount": 30.0,
"can_notify": true,
"can_update": true,
"can_delete": true,
"mark_as_deleted": true,
"id": "d85814b3-9add-41d3-962e-288fe0372840"
}
],
"total": 1
}
application/xml, text/xml
Sample:
<DataSourceResultOfOpportunityListModelihvqq9wh xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Infrastructure.DataSource">
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models">
<d2p1:OpportunityListModel>
<Id xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">d85814b3-9add-41d3-962e-288fe0372840</Id>
<d2p1:Account>sample string 2</d2p1:Account>
<d2p1:AccountEmail>sample string 4</d2p1:AccountEmail>
<d2p1:AccountId>6e6dd8d3-7078-4157-a3fb-ab19d3fafc30</d2p1:AccountId>
<d2p1:AccountMobile>sample string 3</d2p1:AccountMobile>
<d2p1:Campaign>sample string 14</d2p1:Campaign>
<d2p1:CampaignRecipientId>12b622c1-c321-4ffd-b010-faabc87c9349</d2p1:CampaignRecipientId>
<d2p1:CanNotify>true</d2p1:CanNotify>
<d2p1:CanUndelete>true</d2p1:CanUndelete>
<d2p1:CanUpdate>true</d2p1:CanUpdate>
<d2p1:City>sample string 26</d2p1:City>
<d2p1:Country>sample string 24</d2p1:Country>
<d2p1:CurrencyAbbr>sample string 27</d2p1:CurrencyAbbr>
<d2p1:CurrencyCulture>sample string 28</d2p1:CurrencyCulture>
<d2p1:Development>sample string 11</d2p1:Development>
<d2p1:Event>sample string 15</d2p1:Event>
<d2p1:EventId>098989aa-d65b-4266-85c2-61b8ecffced1</d2p1:EventId>
<d2p1:HomeDesign>sample string 10</d2p1:HomeDesign>
<d2p1:LeadStatus>sample string 5</d2p1:LeadStatus>
<d2p1:LeadStatusColor>sample string 6</d2p1:LeadStatusColor>
<d2p1:LeadStatusId>9b770d1a-1a94-4798-bfcc-4a9f0e19db95</d2p1:LeadStatusId>
<d2p1:MarkAsDeleted>true</d2p1:MarkAsDeleted>
<d2p1:OpportunityDate>2026-02-09T19:50:33.5230753+08:00</d2p1:OpportunityDate>
<d2p1:OpportunityStatus>sample string 20</d2p1:OpportunityStatus>
<d2p1:OpportunityStatusColor>sample string 21</d2p1:OpportunityStatusColor>
<d2p1:OpportunityStatusId>9dad9cf4-2970-49f6-9275-4ec2ea94ff3b</d2p1:OpportunityStatusId>
<d2p1:OpportunityType>sample string 18</d2p1:OpportunityType>
<d2p1:OpportunityTypeId>71149b93-fe96-4cee-aaa0-92fe5ce87a76</d2p1:OpportunityTypeId>
<d2p1:Property>sample string 13</d2p1:Property>
<d2p1:ReferralFee>29</d2p1:ReferralFee>
<d2p1:ReferredBy>sample string 8</d2p1:ReferredBy>
<d2p1:ReferredById>fe557fbc-a41f-4684-87a2-ff5b48f3948a</d2p1:ReferredById>
<d2p1:ReferredTo>sample string 9</d2p1:ReferredTo>
<d2p1:ReferredToId>02ed095f-530f-4f26-ae50-64a79db07ece</d2p1:ReferredToId>
<d2p1:Source>sample string 22</d2p1:Source>
<d2p1:SourceId>22bc4a49-9a42-44be-a1fe-a5f6498a6cb0</d2p1:SourceId>
<d2p1:SourceOrigin>sample string 23</d2p1:SourceOrigin>
<d2p1:State>sample string 25</d2p1:State>
<d2p1:Survey>sample string 16</d2p1:Survey>
<d2p1:SurveyId>032aa2b5-c70b-4523-a125-de42af4b15a7</d2p1:SurveyId>
<d2p1:Syndicate>sample string 12</d2p1:Syndicate>
<d2p1:TransactionAmount>30</d2p1:TransactionAmount>
</d2p1:OpportunityListModel>
<d2p1:OpportunityListModel>
<Id xmlns="http://schemas.datacontract.org/2004/07/CompleteEmpireApp.Api.Models.Base">d85814b3-9add-41d3-962e-288fe0372840</Id>
<d2p1:Account>sample string 2</d2p1:Account>
<d2p1:AccountEmail>sample string 4</d2p1:AccountEmail>
<d2p1:AccountId>6e6dd8d3-7078-4157-a3fb-ab19d3fafc30</d2p1:AccountId>
<d2p1:AccountMobile>sample string 3</d2p1:AccountMobile>
<d2p1:Campaign>sample string 14</d2p1:Campaign>
<d2p1:CampaignRecipientId>12b622c1-c321-4ffd-b010-faabc87c9349</d2p1:CampaignRecipientId>
<d2p1:CanNotify>true</d2p1:CanNotify>
<d2p1:CanUndelete>true</d2p1:CanUndelete>
<d2p1:CanUpdate>true</d2p1:CanUpdate>
<d2p1:City>sample string 26</d2p1:City>
<d2p1:Country>sample string 24</d2p1:Country>
<d2p1:CurrencyAbbr>sample string 27</d2p1:CurrencyAbbr>
<d2p1:CurrencyCulture>sample string 28</d2p1:CurrencyCulture>
<d2p1:Development>sample string 11</d2p1:Development>
<d2p1:Event>sample string 15</d2p1:Event>
<d2p1:EventId>098989aa-d65b-4266-85c2-61b8ecffced1</d2p1:EventId>
<d2p1:HomeDesign>sample string 10</d2p1:HomeDesign>
<d2p1:LeadStatus>sample string 5</d2p1:LeadStatus>
<d2p1:LeadStatusColor>sample string 6</d2p1:LeadStatusColor>
<d2p1:LeadStatusId>9b770d1a-1a94-4798-bfcc-4a9f0e19db95</d2p1:LeadStatusId>
<d2p1:MarkAsDeleted>true</d2p1:MarkAsDeleted>
<d2p1:OpportunityDate>2026-02-09T19:50:33.5230753+08:00</d2p1:OpportunityDate>
<d2p1:OpportunityStatus>sample string 20</d2p1:OpportunityStatus>
<d2p1:OpportunityStatusColor>sample string 21</d2p1:OpportunityStatusColor>
<d2p1:OpportunityStatusId>9dad9cf4-2970-49f6-9275-4ec2ea94ff3b</d2p1:OpportunityStatusId>
<d2p1:OpportunityType>sample string 18</d2p1:OpportunityType>
<d2p1:OpportunityTypeId>71149b93-fe96-4cee-aaa0-92fe5ce87a76</d2p1:OpportunityTypeId>
<d2p1:Property>sample string 13</d2p1:Property>
<d2p1:ReferralFee>29</d2p1:ReferralFee>
<d2p1:ReferredBy>sample string 8</d2p1:ReferredBy>
<d2p1:ReferredById>fe557fbc-a41f-4684-87a2-ff5b48f3948a</d2p1:ReferredById>
<d2p1:ReferredTo>sample string 9</d2p1:ReferredTo>
<d2p1:ReferredToId>02ed095f-530f-4f26-ae50-64a79db07ece</d2p1:ReferredToId>
<d2p1:Source>sample string 22</d2p1:Source>
<d2p1:SourceId>22bc4a49-9a42-44be-a1fe-a5f6498a6cb0</d2p1:SourceId>
<d2p1:SourceOrigin>sample string 23</d2p1:SourceOrigin>
<d2p1:State>sample string 25</d2p1:State>
<d2p1:Survey>sample string 16</d2p1:Survey>
<d2p1:SurveyId>032aa2b5-c70b-4523-a125-de42af4b15a7</d2p1:SurveyId>
<d2p1:Syndicate>sample string 12</d2p1:Syndicate>
<d2p1:TransactionAmount>30</d2p1:TransactionAmount>
</d2p1:OpportunityListModel>
</Data>
<Total>1</Total>
</DataSourceResultOfOpportunityListModelihvqq9wh>