GET api/Phonelists/GetLists/{SessionToken}?Folder={Folder}
Returns the phone lists in the specified folder. If no folder is specified, returns phone lists in the user's root folder.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| SessionToken |
The session token for the current user session |
string |
Required |
| Folder |
The folder to use |
integer |
Default value is 0 |
Body Parameters
None.
Response Information
Resource Description
Collection of phone lists
APIReturnOfPhoneListStatusAndIEnumerableOfPhoneList| Name | Description | Type | Additional information |
|---|---|---|---|
| StatusEnum | PhoneListStatus |
None. |
|
| Status | string |
None. |
|
| Result | Collection of PhoneList |
None. |
Response Formats
application/json, text/json
Sample:
{
"StatusEnum": 0,
"Status": "Success",
"Result": [
{
"ID": 1,
"Creator": 2,
"Company": 3,
"Date": "2025-10-24T15:12:54.0122651+01:00",
"Name": "sample string 5",
"Description": "sample string 6",
"Folder": 7
},
{
"ID": 1,
"Creator": 2,
"Company": 3,
"Date": "2025-10-24T15:12:54.0122651+01:00",
"Name": "sample string 5",
"Description": "sample string 6",
"Folder": 7
}
]
}
application/xml, text/xml
Sample:
<APIReturnOfPhoneListStatusArrayOfPhoneListuO2q6ph3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector">
<Result>
<PhoneList>
<Company>3</Company>
<Creator>2</Creator>
<Date>2025-10-24T15:12:54.0122651+01:00</Date>
<Description>sample string 6</Description>
<Folder>7</Folder>
<ID>1</ID>
<Name>sample string 5</Name>
</PhoneList>
<PhoneList>
<Company>3</Company>
<Creator>2</Creator>
<Date>2025-10-24T15:12:54.0122651+01:00</Date>
<Description>sample string 6</Description>
<Folder>7</Folder>
<ID>1</ID>
<Name>sample string 5</Name>
</PhoneList>
</Result>
<StatusEnum>Success</StatusEnum>
</APIReturnOfPhoneListStatusArrayOfPhoneListuO2q6ph3>