GET api/Phonelists/GetNumberDetail/{SessionToken}/{List}/{PhoneNumber}

Returns details of a number in the phone list

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SessionToken

The session token for the current user session

string

Required

List

The list to use

integer

Required

PhoneNumber

The number to get information about

string

Required

Body Parameters

None.

Response Information

Resource Description

Details of list

APIReturnOfPhoneListStatusAndPhoneListEntry
NameDescriptionTypeAdditional information
StatusEnum

PhoneListStatus

None.

Status

string

None.

Result

PhoneListEntry

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusEnum": 0,
  "Status": "Success",
  "Result": {
    "ListID": 1,
    "PhoneNumber": "sample string 2",
    "Title": "sample string 3",
    "FirstName": "sample string 4",
    "Surname": "sample string 5",
    "Address1": "sample string 6",
    "Address2": "sample string 7",
    "Address3": "sample string 8",
    "City": "sample string 9",
    "County": "sample string 10",
    "Postcode": "sample string 11",
    "Gender": "sample string 12",
    "DateOfBirth": "2025-08-29T11:54:21.7746341+01:00",
    "Reference": "sample string 13",
    "SourceTag": "sample string 14",
    "Email": "sample string 15",
    "Status": 16,
    "User1": "sample string 17",
    "User2": "sample string 18",
    "User3": "sample string 19"
  }
}

application/xml, text/xml

Sample:
<APIReturnOfPhoneListStatusPhoneListEntryuO2q6ph3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSConnector">
  <Result>
    <Address1>sample string 6</Address1>
    <Address2>sample string 7</Address2>
    <Address3>sample string 8</Address3>
    <City>sample string 9</City>
    <County>sample string 10</County>
    <DateOfBirth>2025-08-29T11:54:21.7746341+01:00</DateOfBirth>
    <Email>sample string 15</Email>
    <FirstName>sample string 4</FirstName>
    <Gender>sample string 12</Gender>
    <ListID>1</ListID>
    <PhoneNumber>sample string 2</PhoneNumber>
    <Postcode>sample string 11</Postcode>
    <Reference>sample string 13</Reference>
    <SourceTag>sample string 14</SourceTag>
    <Status>16</Status>
    <Surname>sample string 5</Surname>
    <Title>sample string 3</Title>
    <User1>sample string 17</User1>
    <User2>sample string 18</User2>
    <User3>sample string 19</User3>
  </Result>
  <StatusEnum>Success</StatusEnum>
</APIReturnOfPhoneListStatusPhoneListEntryuO2q6ph3>