Skype for Business - search Resource

search

  • JSON
  • XML

Provides a way to search for contacts.

Web link

For more on web links, see Web Links.

Name Description
relThe resource that this link points to. In JSON, this is the outer container.
hrefThe location of this resource on the server, and the target of an HTTP operation.

Resource description

This resource is used to search through the address book of the user's organization. The fields searched include name, email, URI, and phone number.

Properties

Name Description
moreResultsAvailable Indicates to clients that more search results are available than the limit set in the search query.

Links

This resource can have the following relationships.

Link Description
selfThe link to the current resource.
contact Represents a person or service that the user can communicate and collaborate with.
distributionGroup Represents a persistent, pre-existing group of contacts.

Operations

  • GET

Returns a representation of search results.

Query parameters

Click here to see the input values.

Name Description Required?
limit The maximum number of search results to return. Optional parameter.

The maximum value is 100 and the minimum value is 1.

No
query The search query string. Required parameter.

The maximum length is 256 characters.

Yes

Request body

None

Response body

The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.

Synchronous errors

The errors below (if any) are specific to this resource. Generic errors that can apply to any resource are covered in Generic synchronous errors.

Error Code Subcode Description
Forbidden403None The user does not have sufficient privileges to search.
Forbidden403None The user does not have sufficient privileges to access the contact list.
ServiceFailure500InvalidExchangeServerVersion
Conflict409AlreadyExists
Conflict409TooManyGroups
Conflict409None

Examples

Only server-supplied query parameters, if any, are shown in the request sample.

Request

Get https://fe1.contoso.com:443//v1/applications/970/search HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json

  

JSON Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 5486
{
  "rel" : "search",
  "moreResultsAvailable" : false,
  "_links" : {
    "self" : {
      "href" : "//v1/applications/970/search"
    }
  },
  "_embedded" : {
    "contact" : [
      {
        "rel" : "contact",
        "company" : "ContosoCorp.",
        "department" : "Engineering",
        "emailAddresses" : [
          "Alex.Doe@contoso.com"
        ],
        "homePhoneNumber" : "tel : +19185550107",
        "sourceNetworkIconUrl" : "https : //images.contoso.com/logo_16x16.png",
        "mobilePhoneNumber" : "tel : 4255551212;phone-context=defaultprofile",
        "name" : "AlexDoe",
        "office" : "tel : +1425554321;ext=54321",
        "otherPhoneNumber" : "tel : +19195558194",
        "sourceNetwork" : "SameEnterprise",
        "title" : "Engineer2",
        "type" : "User",
        "uri" : "sip : alex@contoso.com",
        "workPhoneNumber" : "tel : +1425554321;ext=54321",
        "_links" : {
          "self" : {
            "href" : "//v1/applications/970/people/235"
          },
          "contactLocation" : {
            "href" : "//v1/applications/970/people/235/contactLocation"
          },
          "contactNote" : {
            "href" : "//v1/applications/970/people/235/contactNote"
          },
          "contactPhoto" : {
            "href" : "//v1/applications/970/people/235/contactPhoto"
          },
          "contactPresence" : {
            "href" : "//v1/applications/970/people/235/contactPresence"
          },
          "contactPrivacyRelationship" : {
            "href" : "//v1/applications/970/people/235/contactPrivacyRelationship"
          },
          "contactSupportedModalities" : {
            "href" : "//v1/applications/970/people/235/contactSupportedModalities"
          }
        }
      }
    ],
    "distributionGroup" : [
      {
        "rel" : "distributionGroup",
        "uri" : "sip : mypersonalgroup@contoso.com",
        "id" : "7",
        "name" : "MyPersonalGroup",
        "_links" : {
          "self" : {
            "href" : "//v1/applications/970/groups/distributionGroup"
          },
          "addToContactList" : {
            "href" : "//v1/applications/970/groups/addToContactList"
          },
          "expandDistributionGroup" : {
            "href" : "//v1/applications/970/groups/distributionGroup/expandDistributionGroup"
          },
          "groupContacts" : {
            "href" : "//v1/applications/970/contacts"
          },
          "removeFromContactList" : {
            "href" : "//v1/applications/970/groups/removeFromContactList"
          },
          "subscribeToGroupPresence" : {
            "href" : "//v1/applications/970/groups/group/subscribeToGroupPresence"
          }
        },
        "_embedded" : {
          "contact" : [
            {
              "rel" : "contact",
              "company" : "ContosoCorp.",
              "department" : "Engineering",
              "emailAddresses" : [
                "Alex.Doe@contoso.com"
              ],
              "homePhoneNumber" : "tel : +19185550107",
              "sourceNetworkIconUrl" : "https : //images.contoso.com/logo_16x16.png",
              "mobilePhoneNumber" : "tel : 4255551212;phone-context=defaultprofile",
              "name" : "AlexDoe",
              "office" : "tel : +1425554321;ext=54321",
              "otherPhoneNumber" : "tel : +19195558194",
              "sourceNetwork" : "SameEnterprise",
              "title" : "Engineer2",
              "type" : "User",
              "uri" : "sip : alex@contoso.com",
              "workPhoneNumber" : "tel : +1425554321;ext=54321",
              "_links" : {
                "self" : {
                  "href" : "//v1/applications/970/people/235"
                },
                "contactLocation" : {
                  "href" : "//v1/applications/970/people/235/contactLocation"
                },
                "contactNote" : {
                  "href" : "//v1/applications/970/people/235/contactNote"
                },
                "contactPhoto" : {
                  "href" : "//v1/applications/970/people/235/contactPhoto"
                },
                "contactPresence" : {
                  "href" : "//v1/applications/970/people/235/contactPresence"
                },
                "contactPrivacyRelationship" : {
                  "href" : "//v1/applications/970/people/235/contactPrivacyRelationship"
                },
                "contactSupportedModalities" : {
                  "href" : "//v1/applications/970/people/235/contactSupportedModalities"
                }
              }
            }
          ],
          "distributionGroup" : [
            {
              "rel" : "distributionGroup",
              "uri" : "sip : mypersonalgroup@contoso.com",
              "id" : "7",
              "name" : "MyPersonalGroup",
              "_links" : {
                "self" : {
                  "href" : "//v1/applications/970/groups/distributionGroup"
                },
                "addToContactList" : {
                  "href" : "//v1/applications/970/groups/addToContactList"
                },
                "expandDistributionGroup" : {
                  "href" : "//v1/applications/970/groups/distributionGroup/expandDistributionGroup"
                },
                "groupContacts" : {
                  "href" : "//v1/applications/970/contacts"
                },
                "removeFromContactList" : {
                  "href" : "//v1/applications/970/groups/removeFromContactList"
                },
                "subscribeToGroupPresence" : {
                  "href" : "//v1/applications/970/groups/group/subscribeToGroupPresence"
                }
              },
              "_embedded" : {
                "contact" : [
                  {
                    "rel" : "contact",
                    "company" : "ContosoCorp.",
                    "department" : "Engineering",
                    "emailAddresses" : [
                      "Alex.Doe@contoso.com"
                    ],
                    "homePhoneNumber" : "tel : +19185550107",
                    "sourceNetworkIconUrl" : "https : //images.contoso.com/logo_16x16.png",
                    "mobilePhoneNumber" : "tel : 4255551212;phone-context=defaultprofile",
                    "name" : "AlexDoe",
                    "office" : "tel : +1425554321;ext=54321",
                    "otherPhoneNumber" : "tel : +19195558194",
                    "sourceNetwork" : "SameEnterprise",
                    "title" : "Engineer2",
                    "type" : "User",
                    "uri" : "sip : alex@contoso.com",
                    "workPhoneNumber" : "tel : +1425554321;ext=54321",
                    "_links" : {
                      "self" : {
                        "href" : "//v1/applications/970/people/235"
                      },
                      "contactLocation" : {
                        "href" : "//v1/applications/970/people/235/contactLocation"
                      },
                      "contactNote" : {
                        "href" : "//v1/applications/970/people/235/contactNote"
                      },
                      "contactPhoto" : {
                        "href" : "//v1/applications/970/people/235/contactPhoto"
                      },
                      "contactPresence" : {
                        "href" : "//v1/applications/970/people/235/contactPresence"
                      },
                      "contactPrivacyRelationship" : {
                        "href" : "//v1/applications/970/people/235/contactPrivacyRelationship"
                      },
                      "contactSupportedModalities" : {
                        "href" : "//v1/applications/970/people/235/contactSupportedModalities"
                      }
                    }
                  }
                ],
                "distributionGroup" : [
                  {
                    "rel" : "distributionGroup",
                    "uri" : "sip : mypersonalgroup@contoso.com",
                    "id" : "7",
                    "name" : "MyPersonalGroup",
                    "_links" : {
                      "self" : {
                        "href" : "//v1/applications/970/groups/distributionGroup"
                      },
                      "addToContactList" : {
                        "href" : "//v1/applications/970/groups/addToContactList"
                      },
                      "expandDistributionGroup" : {
                        "href" : "//v1/applications/970/groups/distributionGroup/expandDistributionGroup"
                      },
                      "groupContacts" : {
                        "href" : "//v1/applications/970/contacts"
                      },
                      "removeFromContactList" : {
                        "href" : "//v1/applications/970/groups/removeFromContactList"
                      },
                      "subscribeToGroupPresence" : {
                        "href" : "//v1/applications/970/groups/group/subscribeToGroupPresence"
                      }
                    },
                    "_embedded" : {
                      "contact" : [
                        {
                          "_links" : {
                            "self" : {
                              "href" : "//v1/applications/970/people/235"
                            }
                          }
                        }
                      ],
                      "distributionGroup" : [
                        {
                          "_links" : {
                            "self" : {
                              "href" : "//v1/applications/970/groups/distributionGroup"
                            }
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}
  

Request

Get https://fe1.contoso.com:443//v1/applications/970/search HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml

  

XML Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 7187
<?xml version="1.0" encoding="utf-8"?>
<resource rel="search" href="//v1/applications/970/search" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <property name="rel">search</property>
  <property name="moreResultsAvailable">False</property>
  <resource rel="contact" href="//v1/applications/970/people/235">
    <link rel="contactLocation" href="//v1/applications/970/people/235/contactLocation" />
    <link rel="contactNote" href="//v1/applications/970/people/235/contactNote" />
    <link rel="contactPhoto" href="//v1/applications/970/people/235/contactPhoto" />
    <link rel="contactPresence" href="//v1/applications/970/people/235/contactPresence" />
    <link rel="contactPrivacyRelationship" href="//v1/applications/970/people/235/contactPrivacyRelationship" />
    <link rel="contactSupportedModalities" href="//v1/applications/970/people/235/contactSupportedModalities" />
    <property name="rel">contact</property>
    <property name="company">Contoso Corp.</property>
    <property name="department">Engineering</property>
    <propertyList name="emailAddresses">
      <item>Alex.Doe@contoso.com</item>
    </propertyList>
    <property name="homePhoneNumber">tel:+19185550107</property>
    <property name="sourceNetworkIconUrl">https://images.contoso.com/logo_16x16.png</property>
    <property name="mobilePhoneNumber">tel:4255551212;phone-context=defaultprofile</property>
    <property name="name">Alex Doe</property>
    <property name="office">tel:+1425554321;ext=54321</property>
    <property name="otherPhoneNumber">tel:+19195558194</property>
    <property name="sourceNetwork">SameEnterprise</property>
    <property name="title">Engineer 2</property>
    <property name="type">User</property>
    <property name="uri">sip:alex@contoso.com</property>
    <property name="workPhoneNumber">tel:+1425554321;ext=54321</property>
  </resource>
  <resource rel="distributionGroup" href="//v1/applications/970/groups/distributionGroup">
    <link rel="addToContactList" href="//v1/applications/970/groups/addToContactList" />
    <link rel="expandDistributionGroup" href="//v1/applications/970/groups/distributionGroup/expandDistributionGroup" />
    <link rel="groupContacts" href="//v1/applications/970/contacts" />
    <link rel="removeFromContactList" href="//v1/applications/970/groups/removeFromContactList" />
    <link rel="subscribeToGroupPresence" href="//v1/applications/970/groups/group/subscribeToGroupPresence" />
    <property name="rel">distributionGroup</property>
    <property name="uri">sip:mypersonalgroup@contoso.com</property>
    <property name="id">7</property>
    <property name="name">MyPersonalGroup</property>
    <resource rel="contact" href="//v1/applications/970/people/235">
      <link rel="contactLocation" href="//v1/applications/970/people/235/contactLocation" />
      <link rel="contactNote" href="//v1/applications/970/people/235/contactNote" />
      <link rel="contactPhoto" href="//v1/applications/970/people/235/contactPhoto" />
      <link rel="contactPresence" href="//v1/applications/970/people/235/contactPresence" />
      <link rel="contactPrivacyRelationship" href="//v1/applications/970/people/235/contactPrivacyRelationship" />
      <link rel="contactSupportedModalities" href="//v1/applications/970/people/235/contactSupportedModalities" />
      <property name="rel">contact</property>
      <property name="company">Contoso Corp.</property>
      <property name="department">Engineering</property>
      <propertyList name="emailAddresses">
        <item>Alex.Doe@contoso.com</item>
      </propertyList>
      <property name="homePhoneNumber">tel:+19185550107</property>
      <property name="sourceNetworkIconUrl">https://images.contoso.com/logo_16x16.png</property>
      <property name="mobilePhoneNumber">tel:4255551212;phone-context=defaultprofile</property>
      <property name="name">Alex Doe</property>
      <property name="office">tel:+1425554321;ext=54321</property>
      <property name="otherPhoneNumber">tel:+19195558194</property>
      <property name="sourceNetwork">SameEnterprise</property>
      <property name="title">Engineer 2</property>
      <property name="type">User</property>
      <property name="uri">sip:alex@contoso.com</property>
      <property name="workPhoneNumber">tel:+1425554321;ext=54321</property>
    </resource>
    <resource rel="distributionGroup" href="//v1/applications/970/groups/distributionGroup">
      <link rel="addToContactList" href="//v1/applications/970/groups/addToContactList" />
      <link rel="expandDistributionGroup" href="//v1/applications/970/groups/distributionGroup/expandDistributionGroup" />
      <link rel="groupContacts" href="//v1/applications/970/contacts" />
      <link rel="removeFromContactList" href="//v1/applications/970/groups/removeFromContactList" />
      <link rel="subscribeToGroupPresence" href="//v1/applications/970/groups/group/subscribeToGroupPresence" />
      <property name="rel">distributionGroup</property>
      <property name="uri">sip:mypersonalgroup@contoso.com</property>
      <property name="id">7</property>
      <property name="name">MyPersonalGroup</property>
      <resource rel="contact" href="//v1/applications/970/people/235">
        <link rel="contactLocation" href="//v1/applications/970/people/235/contactLocation" />
        <link rel="contactNote" href="//v1/applications/970/people/235/contactNote" />
        <link rel="contactPhoto" href="//v1/applications/970/people/235/contactPhoto" />
        <link rel="contactPresence" href="//v1/applications/970/people/235/contactPresence" />
        <link rel="contactPrivacyRelationship" href="//v1/applications/970/people/235/contactPrivacyRelationship" />
        <link rel="contactSupportedModalities" href="//v1/applications/970/people/235/contactSupportedModalities" />
        <property name="rel">contact</property>
        <property name="company">Contoso Corp.</property>
        <property name="department">Engineering</property>
        <propertyList name="emailAddresses">
          <item>Alex.Doe@contoso.com</item>
        </propertyList>
        <property name="homePhoneNumber">tel:+19185550107</property>
        <property name="sourceNetworkIconUrl">https://images.contoso.com/logo_16x16.png</property>
        <property name="mobilePhoneNumber">tel:4255551212;phone-context=defaultprofile</property>
        <property name="name">Alex Doe</property>
        <property name="office">tel:+1425554321;ext=54321</property>
        <property name="otherPhoneNumber">tel:+19195558194</property>
        <property name="sourceNetwork">SameEnterprise</property>
        <property name="title">Engineer 2</property>
        <property name="type">User</property>
        <property name="uri">sip:alex@contoso.com</property>
        <property name="workPhoneNumber">tel:+1425554321;ext=54321</property>
      </resource>
      <resource rel="distributionGroup" href="//v1/applications/970/groups/distributionGroup">
        <link rel="addToContactList" href="//v1/applications/970/groups/addToContactList" />
        <link rel="expandDistributionGroup" href="//v1/applications/970/groups/distributionGroup/expandDistributionGroup" />
        <link rel="groupContacts" href="//v1/applications/970/contacts" />
        <link rel="removeFromContactList" href="//v1/applications/970/groups/removeFromContactList" />
        <link rel="subscribeToGroupPresence" href="//v1/applications/970/groups/group/subscribeToGroupPresence" />
        <property name="rel">distributionGroup</property>
        <property name="uri">sip:mypersonalgroup@contoso.com</property>
        <property name="id">7</property>
        <property name="name">MyPersonalGroup</property>
        <resource rel="contact" href="//v1/applications/970/people/235" />
        <resource rel="distributionGroup" href="//v1/applications/970/groups/distributionGroup" />
      </resource>
    </resource>
  </resource>
</resource>