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": "c2ddbf66-f2ec-46c8-ae59-b6add2f6abe8",
"account": "sample string 2",
"account_mobile": "sample string 3",
"account_email": "sample string 4",
"lead_status_id": "3c0111bb-4159-4c7a-abb2-412c57e363aa",
"lead_status": "sample string 5",
"lead_status_color": "sample string 6",
"opportunity_date": "2026-04-10T20:18:04.4362702+08:00",
"referred_by_id": "6948b115-0cff-4db3-bb20-d22287ca8188",
"referred_by": "sample string 8",
"referred_to_id": "717128a8-4199-43d0-b5c0-535acd7de6ac",
"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": "ab1a372b-3d1d-49e8-8028-f4cf35590240",
"campaign": "sample string 14",
"event_id": "b2fe11c9-bbe4-4310-b5c5-f18988bcbd3c",
"event": "sample string 15",
"survey_id": "0fa7eeee-86af-4617-91f1-00377d1af384",
"survey": "sample string 16",
"opportunity_type_id": "947418af-310c-4152-82e2-e8f9c06952d4",
"opportunity_type": "sample string 18",
"opportunity_status_id": "4757cb78-bb86-41c6-bb11-484b6305bcdb",
"opportunity_status": "sample string 20",
"opportunity_status_color": "sample string 21",
"source_id": "f7f74d2c-0328-46fe-9b83-2e0ad9e727d5",
"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": "0df76505-c6f8-418f-a6b3-40057db163a3"
},
{
"account_id": "c2ddbf66-f2ec-46c8-ae59-b6add2f6abe8",
"account": "sample string 2",
"account_mobile": "sample string 3",
"account_email": "sample string 4",
"lead_status_id": "3c0111bb-4159-4c7a-abb2-412c57e363aa",
"lead_status": "sample string 5",
"lead_status_color": "sample string 6",
"opportunity_date": "2026-04-10T20:18:04.4362702+08:00",
"referred_by_id": "6948b115-0cff-4db3-bb20-d22287ca8188",
"referred_by": "sample string 8",
"referred_to_id": "717128a8-4199-43d0-b5c0-535acd7de6ac",
"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": "ab1a372b-3d1d-49e8-8028-f4cf35590240",
"campaign": "sample string 14",
"event_id": "b2fe11c9-bbe4-4310-b5c5-f18988bcbd3c",
"event": "sample string 15",
"survey_id": "0fa7eeee-86af-4617-91f1-00377d1af384",
"survey": "sample string 16",
"opportunity_type_id": "947418af-310c-4152-82e2-e8f9c06952d4",
"opportunity_type": "sample string 18",
"opportunity_status_id": "4757cb78-bb86-41c6-bb11-484b6305bcdb",
"opportunity_status": "sample string 20",
"opportunity_status_color": "sample string 21",
"source_id": "f7f74d2c-0328-46fe-9b83-2e0ad9e727d5",
"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": "0df76505-c6f8-418f-a6b3-40057db163a3"
}
],
"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">0df76505-c6f8-418f-a6b3-40057db163a3</Id>
<d2p1:Account>sample string 2</d2p1:Account>
<d2p1:AccountEmail>sample string 4</d2p1:AccountEmail>
<d2p1:AccountId>c2ddbf66-f2ec-46c8-ae59-b6add2f6abe8</d2p1:AccountId>
<d2p1:AccountMobile>sample string 3</d2p1:AccountMobile>
<d2p1:Campaign>sample string 14</d2p1:Campaign>
<d2p1:CampaignRecipientId>ab1a372b-3d1d-49e8-8028-f4cf35590240</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>b2fe11c9-bbe4-4310-b5c5-f18988bcbd3c</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>3c0111bb-4159-4c7a-abb2-412c57e363aa</d2p1:LeadStatusId>
<d2p1:MarkAsDeleted>true</d2p1:MarkAsDeleted>
<d2p1:OpportunityDate>2026-04-10T20:18:04.4362702+08:00</d2p1:OpportunityDate>
<d2p1:OpportunityStatus>sample string 20</d2p1:OpportunityStatus>
<d2p1:OpportunityStatusColor>sample string 21</d2p1:OpportunityStatusColor>
<d2p1:OpportunityStatusId>4757cb78-bb86-41c6-bb11-484b6305bcdb</d2p1:OpportunityStatusId>
<d2p1:OpportunityType>sample string 18</d2p1:OpportunityType>
<d2p1:OpportunityTypeId>947418af-310c-4152-82e2-e8f9c06952d4</d2p1:OpportunityTypeId>
<d2p1:Property>sample string 13</d2p1:Property>
<d2p1:ReferralFee>29</d2p1:ReferralFee>
<d2p1:ReferredBy>sample string 8</d2p1:ReferredBy>
<d2p1:ReferredById>6948b115-0cff-4db3-bb20-d22287ca8188</d2p1:ReferredById>
<d2p1:ReferredTo>sample string 9</d2p1:ReferredTo>
<d2p1:ReferredToId>717128a8-4199-43d0-b5c0-535acd7de6ac</d2p1:ReferredToId>
<d2p1:Source>sample string 22</d2p1:Source>
<d2p1:SourceId>f7f74d2c-0328-46fe-9b83-2e0ad9e727d5</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>0fa7eeee-86af-4617-91f1-00377d1af384</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">0df76505-c6f8-418f-a6b3-40057db163a3</Id>
<d2p1:Account>sample string 2</d2p1:Account>
<d2p1:AccountEmail>sample string 4</d2p1:AccountEmail>
<d2p1:AccountId>c2ddbf66-f2ec-46c8-ae59-b6add2f6abe8</d2p1:AccountId>
<d2p1:AccountMobile>sample string 3</d2p1:AccountMobile>
<d2p1:Campaign>sample string 14</d2p1:Campaign>
<d2p1:CampaignRecipientId>ab1a372b-3d1d-49e8-8028-f4cf35590240</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>b2fe11c9-bbe4-4310-b5c5-f18988bcbd3c</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>3c0111bb-4159-4c7a-abb2-412c57e363aa</d2p1:LeadStatusId>
<d2p1:MarkAsDeleted>true</d2p1:MarkAsDeleted>
<d2p1:OpportunityDate>2026-04-10T20:18:04.4362702+08:00</d2p1:OpportunityDate>
<d2p1:OpportunityStatus>sample string 20</d2p1:OpportunityStatus>
<d2p1:OpportunityStatusColor>sample string 21</d2p1:OpportunityStatusColor>
<d2p1:OpportunityStatusId>4757cb78-bb86-41c6-bb11-484b6305bcdb</d2p1:OpportunityStatusId>
<d2p1:OpportunityType>sample string 18</d2p1:OpportunityType>
<d2p1:OpportunityTypeId>947418af-310c-4152-82e2-e8f9c06952d4</d2p1:OpportunityTypeId>
<d2p1:Property>sample string 13</d2p1:Property>
<d2p1:ReferralFee>29</d2p1:ReferralFee>
<d2p1:ReferredBy>sample string 8</d2p1:ReferredBy>
<d2p1:ReferredById>6948b115-0cff-4db3-bb20-d22287ca8188</d2p1:ReferredById>
<d2p1:ReferredTo>sample string 9</d2p1:ReferredTo>
<d2p1:ReferredToId>717128a8-4199-43d0-b5c0-535acd7de6ac</d2p1:ReferredToId>
<d2p1:Source>sample string 22</d2p1:Source>
<d2p1:SourceId>f7f74d2c-0328-46fe-9b83-2e0ad9e727d5</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>0fa7eeee-86af-4617-91f1-00377d1af384</d2p1:SurveyId>
<d2p1:Syndicate>sample string 12</d2p1:Syndicate>
<d2p1:TransactionAmount>30</d2p1:TransactionAmount>
</d2p1:OpportunityListModel>
</Data>
<Total>1</Total>
</DataSourceResultOfOpportunityListModelihvqq9wh>