Répertorier les contacts

  • Article

Espace de noms: microsoft.graph

Obtenir la collection de contacts du dossier de contacts par défaut de l’utilisateur connecté.

Une application peut récupérer les contacts d’un autre utilisateur dans deux cas :

  • Si l’application dispose des autorisations d’application ; ou
  • Si l’application a les autorisations déléguées adéquates d’un utilisateur et si un autre utilisateur a partagé un calendrier avec cet utilisateur, ou s’il a accordé un accès délégué à cet utilisateur. Consultez les détails et un exemple.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Contacts.Read Contacts.ReadWrite
Déléguée (compte Microsoft personnel) Contacts.Read Contacts.ReadWrite
Application Contacts.Read Contacts.ReadWrite

Requête HTTP

Pour obtenir tous les contacts dans le dossier Contacts par défaut d’un utilisateur :

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

Pour obtenir les contacts d’un dossier spécifique de la boîte aux lettres de l’utilisateur :

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

Paramètres facultatifs de la requête

Vous pouvez utiliser le paramètre de requête $filter pour filtrer les contacts en fonction du domaine de leurs adresses e-mail :

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

Vous pouvez utiliser $filter, anyet l’opérateur eq uniquement sur la sous-propriété address des instances d’une collection emailAddresses . Autrement dit, vous ne pouvez pas filtrer sur le nom ou toute autre sous-propriété d’un instance d’emailAddresses, ni appliquer d’autre opérateur ou fonction avec filter, comme ne, leet startswith().

Pour des informations générales sur le$filter paramètre de requête, voir paramètres de la requête OData.

En-têtes de demande

En-tête Valeur
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une collection d’objets contact dans le corps de la réponse.

Exemple

Demande

L’exemple suivant illustre une demande.

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

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

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"
    }
  ]
}