POST api/people/searchcontacts

Search contacts based on the phone number provided

Request Information

URI Parameters

None.

Body Parameters

Search data contract

CTISearchCommandDataContract
NameDescriptionTypeAdditional information
PhoneNumber

string

None.

Id

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "PhoneNumber": "sample string 1",
  "Id": 2
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

All matched contacts

Collection of CTIContactDataContract
NameDescriptionTypeAdditional information
ContactCardUrl

string

None.

Title

string

None.

FirstName

string

None.

LastName

string

None.

Telephones

Collection of ContactItemDataContract

None.

Emails

Collection of ContactItemDataContract

None.

GroupCount

integer

None.

Address

AddressDataContract

None.

Gender

EnumDataContract

None.

LastUpdated

date

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ContactCardUrl": "sample string 1",
    "Title": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Telephones": [
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      }
    ],
    "Emails": [
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      }
    ],
    "GroupCount": 5,
    "Address": {
      "Location": {
        "CenterPoint": {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        },
        "Extent": [
          {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          }
        ],
        "ViewPoints": [
          {
            "Point": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            "Pitch": 1.1,
            "Heading": 2.1,
            "FieldOfVision": 3.1,
            "Zoom": 4.1,
            "Label": "sample string 5",
            "Id": 6
          },
          {
            "Point": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            "Pitch": 1.1,
            "Heading": 2.1,
            "FieldOfVision": 3.1,
            "Zoom": 4.1,
            "Label": "sample string 5",
            "Id": 6
          }
        ],
        "Id": 1
      },
      "AddressSource": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SourceId": "sample string 1",
      "OrganizationName": "sample string 2",
      "Number": "sample string 3",
      "BuildingName": "sample string 4",
      "Street": "sample string 5",
      "Town": "sample string 6",
      "Locality": "sample string 7",
      "County": "sample string 8",
      "Postcode": "sample string 9",
      "CreatedDate": "2020-07-02T15:20:20.0390548Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 11
    },
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "LastUpdated": "2020-07-02T15:20:20.0390548Z",
    "Id": 6
  },
  {
    "ContactCardUrl": "sample string 1",
    "Title": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Telephones": [
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      }
    ],
    "Emails": [
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      },
      {
        "Type": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Value": "sample string 1",
        "Notes": "sample string 2",
        "ContactOrder": 3,
        "AllowContact": true,
        "MarketingContactStatus": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Name": "sample string 5",
        "Id": 6
      }
    ],
    "GroupCount": 5,
    "Address": {
      "Location": {
        "CenterPoint": {
          "Latitude": 1.1,
          "Longitude": 2.1,
          "Altitude": 3.1,
          "Order": 4,
          "Id": 5
        },
        "Extent": [
          {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          },
          {
            "Latitude": 1.1,
            "Longitude": 2.1,
            "Altitude": 3.1,
            "Order": 4,
            "Id": 5
          }
        ],
        "ViewPoints": [
          {
            "Point": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            "Pitch": 1.1,
            "Heading": 2.1,
            "FieldOfVision": 3.1,
            "Zoom": 4.1,
            "Label": "sample string 5",
            "Id": 6
          },
          {
            "Point": {
              "Latitude": 1.1,
              "Longitude": 2.1,
              "Altitude": 3.1,
              "Order": 4,
              "Id": 5
            },
            "Pitch": 1.1,
            "Heading": 2.1,
            "FieldOfVision": 3.1,
            "Zoom": 4.1,
            "Label": "sample string 5",
            "Id": 6
          }
        ],
        "Id": 1
      },
      "AddressSource": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "SourceId": "sample string 1",
      "OrganizationName": "sample string 2",
      "Number": "sample string 3",
      "BuildingName": "sample string 4",
      "Street": "sample string 5",
      "Town": "sample string 6",
      "Locality": "sample string 7",
      "County": "sample string 8",
      "Postcode": "sample string 9",
      "CreatedDate": "2020-07-02T15:20:20.0390548Z",
      "CreatedBy": {
        "Initials": "sample string 1",
        "ContactName": "sample string 2",
        "Gender": {
          "Id": 1,
          "Name": "sample string 2",
          "SystemName": "sample string 3"
        },
        "Title": "sample string 3",
        "FirstName": "sample string 4",
        "LastName": "sample string 5",
        "PrimaryTelephone": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "PrimaryEmail": {
          "Type": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Value": "sample string 1",
          "Notes": "sample string 2",
          "ContactOrder": 3,
          "AllowContact": true,
          "MarketingContactStatus": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "Name": "sample string 5",
          "Id": 6
        },
        "JobTitle": "sample string 6",
        "Id": 7
      },
      "Id": 11
    },
    "Gender": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "LastUpdated": "2020-07-02T15:20:20.0390548Z",
    "Id": 6
  }
]