Request contacts using properties

You can retrieve contacts using properties (for example, retrieve a user based on their email address and include the preset Details (UserShape) for the contact).

In this example, the response includes one contact and MoreAvailable is false. If the client provides a FolderId, BEMS retrieves the contacts from the specific folder. 
POST https://localhost:8443/api/contact HTTP/1.1
<Content-Type: application/json
X-Good-GD-AuthToken: <GDAuthToken>
{
  "Account": "jamie01@ex365.example.com",
  "ByEmail":"jane_doe@example.com",
  "Offset": 0,
  "UserShape": ["Details"],
  "FolderId": "AQMkADk0YzU4MjdkLWU1YjktNGE0OC1iZDczKI0Kuc7BmRwA..."" (optional)
}
If the request is successful, BEMS returns the following information for contacts with the email address jane_doe@example.com. If a value for the property is not available, BEMS returns a null value. In this example, the following information is displayed for Jane Doe:
  • DisplayName
  • GivenName
  • Surname
  • FullName
  • EmailAddress 
{
  "LookupInfo": {
    "MoreAvailable": false,
    "TotalCount": 1,
    "NextPageOffset": null,
    "Size": 1,
    "Offset": 0
  },
  "Contacts": [{
     "CompleteName": {
        "Title": null,
        "GivenName": "Jane",
        "Surname": Doe,
        "FullName": "Jane Doe",
        "Nickname": null,
        "YomiGivenName": null,
        "YomiSurname": null
        },
     "DisplayName": "Jane Doe",
     "EmailAddress": "jane_doe@example.com",
     "GivenName": "Jane",
     "UniqueId" : "AAMkADg2Y2IxMzAwLWJmZmYtNGJjMi1iN..."
    },
      ]
}