GET api/PortalUsers?SearchStr={SearchStr}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SearchStr | string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of PortalUsers| Name | Description | Type | Additional information |
|---|---|---|---|
| PortalUsersId | string |
None. |
|
| PortalCustomersId | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| UserName | string |
None. |
|
| string |
None. |
||
| statusLogin | integer |
None. |
|
| statusActive | integer |
None. |
|
| Validated | integer |
None. |
|
| CreatedById | string |
None. |
|
| CreatedDate | date |
None. |
|
| UpdatedById | string |
None. |
|
| UpdatedDate | date |
None. |
|
| _Name | string |
None. |
|
| _LastNameFirst | string |
None. |
|
| _tzOffset | decimal number |
None. |
|
| Website | string |
None. |
|
| Phone | string |
None. |
|
| Company | string |
None. |
|
| Timezone | integer |
None. |
|
| Address1 | string |
None. |
|
| Address2 | string |
None. |
|
| City | string |
None. |
|
| Status | integer |
None. |
|
| PostalCode | string |
None. |
|
| Country | integer |
None. |
|
| Marketing | string |
None. |
|
| Sales | string |
None. |
|
| SalesManager | string |
None. |
|
| Administrator | string |
None. |
|
| CRMRole | string |
None. |
|
| CRMID | string |
None. |
|
| DesignerPreference | string |
None. |
|
| UrlCode | string |
None. |
|
| MeetingURL | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"PortalUsersId": "sample string 1",
"PortalCustomersId": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"UserName": "sample string 5",
"Email": "sample string 6",
"statusLogin": 7,
"statusActive": 8,
"Validated": 9,
"CreatedById": "sample string 10",
"CreatedDate": "2025-12-14T21:01:41.8197064+00:00",
"UpdatedById": "sample string 12",
"UpdatedDate": "2025-12-14T21:01:41.8197064+00:00",
"_Name": "sample string 14",
"_LastNameFirst": "sample string 15",
"_tzOffset": 16.0,
"Website": "sample string 17",
"Phone": "sample string 18",
"Company": "sample string 19",
"Timezone": 20,
"Address1": "sample string 21",
"Address2": "sample string 22",
"City": "sample string 23",
"Status": 24,
"PostalCode": "sample string 25",
"Country": 26,
"Marketing": "sample string 27",
"Sales": "sample string 28",
"SalesManager": "sample string 29",
"Administrator": "sample string 30",
"CRMRole": "sample string 31",
"CRMID": "sample string 32",
"DesignerPreference": "sample string 33",
"UrlCode": "sample string 34",
"MeetingURL": "sample string 35"
},
{
"PortalUsersId": "sample string 1",
"PortalCustomersId": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"UserName": "sample string 5",
"Email": "sample string 6",
"statusLogin": 7,
"statusActive": 8,
"Validated": 9,
"CreatedById": "sample string 10",
"CreatedDate": "2025-12-14T21:01:41.8197064+00:00",
"UpdatedById": "sample string 12",
"UpdatedDate": "2025-12-14T21:01:41.8197064+00:00",
"_Name": "sample string 14",
"_LastNameFirst": "sample string 15",
"_tzOffset": 16.0,
"Website": "sample string 17",
"Phone": "sample string 18",
"Company": "sample string 19",
"Timezone": 20,
"Address1": "sample string 21",
"Address2": "sample string 22",
"City": "sample string 23",
"Status": 24,
"PostalCode": "sample string 25",
"Country": 26,
"Marketing": "sample string 27",
"Sales": "sample string 28",
"SalesManager": "sample string 29",
"Administrator": "sample string 30",
"CRMRole": "sample string 31",
"CRMID": "sample string 32",
"DesignerPreference": "sample string 33",
"UrlCode": "sample string 34",
"MeetingURL": "sample string 35"
}
]
application/xml, text/xml
Sample:
<ArrayOfPortalUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
<PortalUsers>
<Address1>sample string 21</Address1>
<Address2>sample string 22</Address2>
<Administrator>sample string 30</Administrator>
<CRMID>sample string 32</CRMID>
<CRMRole>sample string 31</CRMRole>
<City>sample string 23</City>
<Company>sample string 19</Company>
<Country>26</Country>
<CreatedById>sample string 10</CreatedById>
<CreatedDate>2025-12-14T21:01:41.8197064+00:00</CreatedDate>
<DesignerPreference>sample string 33</DesignerPreference>
<Email>sample string 6</Email>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Marketing>sample string 27</Marketing>
<MeetingURL>sample string 35</MeetingURL>
<Phone>sample string 18</Phone>
<PortalCustomersId>sample string 2</PortalCustomersId>
<PortalUsersId>sample string 1</PortalUsersId>
<PostalCode>sample string 25</PostalCode>
<Sales>sample string 28</Sales>
<SalesManager>sample string 29</SalesManager>
<Status>24</Status>
<Timezone>20</Timezone>
<UpdatedById>sample string 12</UpdatedById>
<UpdatedDate>2025-12-14T21:01:41.8197064+00:00</UpdatedDate>
<UrlCode>sample string 34</UrlCode>
<UserName>sample string 5</UserName>
<Validated>9</Validated>
<Website>sample string 17</Website>
<_LastNameFirst>sample string 15</_LastNameFirst>
<_Name>sample string 14</_Name>
<_tzOffset>16</_tzOffset>
<statusActive>8</statusActive>
<statusLogin>7</statusLogin>
</PortalUsers>
<PortalUsers>
<Address1>sample string 21</Address1>
<Address2>sample string 22</Address2>
<Administrator>sample string 30</Administrator>
<CRMID>sample string 32</CRMID>
<CRMRole>sample string 31</CRMRole>
<City>sample string 23</City>
<Company>sample string 19</Company>
<Country>26</Country>
<CreatedById>sample string 10</CreatedById>
<CreatedDate>2025-12-14T21:01:41.8197064+00:00</CreatedDate>
<DesignerPreference>sample string 33</DesignerPreference>
<Email>sample string 6</Email>
<FirstName>sample string 3</FirstName>
<LastName>sample string 4</LastName>
<Marketing>sample string 27</Marketing>
<MeetingURL>sample string 35</MeetingURL>
<Phone>sample string 18</Phone>
<PortalCustomersId>sample string 2</PortalCustomersId>
<PortalUsersId>sample string 1</PortalUsersId>
<PostalCode>sample string 25</PostalCode>
<Sales>sample string 28</Sales>
<SalesManager>sample string 29</SalesManager>
<Status>24</Status>
<Timezone>20</Timezone>
<UpdatedById>sample string 12</UpdatedById>
<UpdatedDate>2025-12-14T21:01:41.8197064+00:00</UpdatedDate>
<UrlCode>sample string 34</UrlCode>
<UserName>sample string 5</UserName>
<Validated>9</Validated>
<Website>sample string 17</Website>
<_LastNameFirst>sample string 15</_LastNameFirst>
<_Name>sample string 14</_Name>
<_tzOffset>16</_tzOffset>
<statusActive>8</statusActive>
<statusLogin>7</statusLogin>
</PortalUsers>
</ArrayOfPortalUsers>