GET api/v1/addressbook/contacts?filter.Firstname={filter.Firstname}&filter.Lastname={filter.Lastname}&filter.MobilePhone={filter.MobilePhone}&filter.EmailAddress={filter.EmailAddress}&paging.Page={paging.Page}&paging.NoOfRecords={paging.NoOfRecords}&Inheritance={Inheritance}

This method returns a list of all the contacts stored on the customer’s account if no parameters are provided. For each contact it will include their first name, last name, mobile number, email address and the type of authentication the contact has chosen if used with an SMS+ message. This method allows the list to be page for large address books and filtered to reduce the size of the data returned.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Firstname

Firstname of the person in addressbook

string

None.

Lastname

Lastname of the person in addressbook

string

None.

MobilePhone

Mobile number of the person in addressbook

string

None.

EmailAddress

Email address of the person in addressbook

string

None.

Page

The Page number for the report.

integer

Required

NoOfRecords

The number of records to return per page.

integer

Required

Inheritance

Flag to include all inherited contacts. Setting to false will result in only account owned contacts (Default : true)

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

List of contacts of the authenticated user.

ResponseOfAddressBookResponse[]
NameDescriptionTypeAdditional information
Error

Error

None.

ResponseData

ResponseDataOfAddressBookResponse[]

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": [
      {
        "PermissionDetails": "sample string 1",
        "PersonNumber": 3,
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "MobilePhone": "sample string 6",
        "EmailAddress": "sample string 7",
        "Password": "sample string 8",
        "LoginType": 9,
        "DateCreated": "2018-06-18T20:53:45.7915582+00:00",
        "DateModified": "2018-06-18T20:53:45.7915582+00:00",
        "LastModifiedBy": "sample string 10",
        "VetoValidation": true
      },
      {
        "PermissionDetails": "sample string 1",
        "PersonNumber": 3,
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "MobilePhone": "sample string 6",
        "EmailAddress": "sample string 7",
        "Password": "sample string 8",
        "LoginType": 9,
        "DateCreated": "2018-06-18T20:53:45.7915582+00:00",
        "DateModified": "2018-06-18T20:53:45.7915582+00:00",
        "LastModifiedBy": "sample string 10",
        "VetoValidation": true
      }
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfArrayOfAddressBookResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>
      <AddressBookResponse>
        <PersonNumber>3</PersonNumber>
        <FirstName>sample string 4</FirstName>
        <LastName>sample string 5</LastName>
        <MobilePhone>sample string 6</MobilePhone>
        <EmailAddress>sample string 7</EmailAddress>
        <Password>sample string 8</Password>
        <LoginType>9</LoginType>
        <DateCreated>2018-06-18T20:53:45.7915582+00:00</DateCreated>
        <DateModified>2018-06-18T20:53:45.7915582+00:00</DateModified>
        <LastModifiedBy>sample string 10</LastModifiedBy>
        <VetoValidation>true</VetoValidation>
        <OwnerAccountID>ae582be3-6fcb-48ad-a3ce-36f6f119dc77</OwnerAccountID>
        <PermissionDetails>sample string 1</PermissionDetails>
        <PermissionLevel>2</PermissionLevel>
      </AddressBookResponse>
      <AddressBookResponse>
        <PersonNumber>3</PersonNumber>
        <FirstName>sample string 4</FirstName>
        <LastName>sample string 5</LastName>
        <MobilePhone>sample string 6</MobilePhone>
        <EmailAddress>sample string 7</EmailAddress>
        <Password>sample string 8</Password>
        <LoginType>9</LoginType>
        <DateCreated>2018-06-18T20:53:45.7915582+00:00</DateCreated>
        <DateModified>2018-06-18T20:53:45.7915582+00:00</DateModified>
        <LastModifiedBy>sample string 10</LastModifiedBy>
        <VetoValidation>true</VetoValidation>
        <OwnerAccountID>ae582be3-6fcb-48ad-a3ce-36f6f119dc77</OwnerAccountID>
        <PermissionDetails>sample string 1</PermissionDetails>
        <PermissionLevel>2</PermissionLevel>
      </AddressBookResponse>
    </Detail>
  </ResponseData>
</ResponseOfArrayOfAddressBookResponse>