Kontakte auflisten

Namespace: microsoft.graph

Ruft eine Kontaktsammlung aus dem Standardkontaktordner des angemeldeten Benutzers ab.

Es gibt zwei Szenarien, in denen eine App Kontakte im Kontaktordner eines anderen Benutzers abrufen kann:

  • Wenn die App Anwendungsberechtigungen besitzt oder
  • Wenn die App die entsprechenden delegierten Berechtigungen von einem Benutzer besitzt und ein anderer Benutzer einen Kontaktordner für diesen Benutzer freigegeben hat oder diesem Benutzer delegierten Zugriff erteilt hat. Hier finden Sie weitere Informationen und ein Beispiel.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Contacts.Read Contacts.ReadWrite
Delegiert (persönliches Microsoft-Konto) Contacts.Read Contacts.ReadWrite
Anwendung Contacts.Read Contacts.ReadWrite

HTTP-Anforderung

So rufen Sie alle Kontakte im Standardordner „Kontakte“ eines Benutzers ab:

GET /me/contacts
GET /users/{id | userPrincipalName}/contacts

So rufen Sie Kontakte in einem spezifischen Ordner in einem Benutzerpostfach ab:

GET /me/contactfolders/{Id}/contacts
GET /users/{id | userPrincipalName}/contactfolders/{id}/contacts

GET /me/contactFolders/{id}/childFolders/{id}/.../contacts
GET /users/{id | userPrincipalName}/contactFolders/{id}/childFolders/{id}/contacts

Optionale Abfrageparameter

Sie können den $filter-Abfrageparameter verwenden, um Kontakte anhand der E-Mail-Adressen zu filtern:

GET https://graph.microsoft.com/v1.0/me/contacts?$filter=emailAddresses/any(a:a/address eq 'garth@contoso.com')

Sie können , anyund den eq Operator nur für die Address-Untereigenschaft von Instanzen in einer emailAddresses-Auflistung verwenden.$filter Das heißt, Sie können nicht nach dem Namen oder einer anderen Untereigenschaft einer instance von emailAddresses filtern, noch können Sie einen anderen Operator oder eine andere Funktion mit filteranwenden, zne. B. , leund startswith().

Allgemeine Informationen zu dem $filter-Abfrageparameter finden Sie unter OData-Abfrageparameter.

Anforderungsheader

Kopfzeile Wert
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung.

Anforderungstext

Geben Sie keinen Anforderungstext für diese Methode an.

Antwort

Bei erfolgreicher Ausführung gibt die Methode den 200 OK Antwortcode und eine Auflistung von Kontaktobjekten im Antworttext zurück.

Beispiel

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

GET https://graph.microsoft.com/v1.0/me/contacts

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "parentFolderId": "parentFolderId-value",
      "birthday": "datetime-value",
      "fileAs": "fileAs-value",
      "displayName": "displayName-value",
      "givenName": "givenName-value",
      "initials": "initials-value"
    }
  ]
}