Répertorier les contactsList contacts

Obtenir la collection de contacts du dossier de contacts par défaut de l’utilisateur connecté.Get a contact collection from the default contacts folder of the signed-in user.

Une application peut récupérer les contacts d’un autre utilisateur dans deux cas :There are two scenarios where an app can get contacts in another user's contact folder:

  • Si l’application dispose des autorisations d’application ; ouIf the app has application permissions, or,
  • 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.If the app has the appropriate delegated permissions from one user, and another user has shared a contact folder with that user, or, has given delegated access to that user. Consultez les détails et un exemple.See details and an example.

AutorisationsPermissions

L’une des autorisations suivantes est nécessaire pour appeler cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Type d’autorisationPermission type Autorisations (de celle qui offre le plus de privilèges à celle qui en offre le moins)Permissions (from least to most privileged)
Déléguée (compte professionnel ou scolaire)Delegated (work or school account) Contacts.Read, Contacts.ReadWriteContacts.Read, Contacts.ReadWrite
Déléguée (compte Microsoft personnel)Delegated (personal Microsoft account) Contacts.Read, Contacts.ReadWriteContacts.Read, Contacts.ReadWrite
ApplicationApplication Contacts.Read, Contacts.ReadWriteContacts.Read, Contacts.ReadWrite

Requête HTTPHTTP request

Pour obtenir tous les contacts de la boîte aux lettres d’un utilisateur :To get all the contacts in a user's mailbox:

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 :To get contacts in a specific folder in the user's mailbox:

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

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

Paramètres facultatifs de la requêteOptional query parameters

Vous pouvez utiliser le paramètre de requête $filter pour filtrer les contacts en fonction du domaine de leurs adresses e-mail :You can use the $filter query parameter to filter contacts based on their email addresses:

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

Notez que vous pouvez utiliser$filter, anyet l’eq opérateur sur uniquement la sous-propriétéadresse d’instances dans une collection de sitesemailAddresses.Note that you can use $filter, any, and the eq operator on only the address sub-property of instances in an emailAddresses collection. Autrement dit, vous ne pouvez pas filtrer la propriété nom ou toute autre sous-propriété d’une instance de emailAddresses, ni appliquer tout autre opérateur ou fonction avec filter, tel que ne, le, et startswith().That is, you cannot filter on the name or any other sub-property of an instance of emailAddresses, nor can you apply any other operator or function with filter, such as ne, le, and startswith().

Pour des informations générales sur le$filter paramètre de requête, voir paramètres de la requête OData.For general information on the $filter query parameter, see OData query parameters.

En-têtes de demandeRequest headers

En-têteHeader ValeurValue
AutorisationAuthorization Porteur {token}. Obligatoire.Bearer {token}. Required.
Content-TypeContent-Type application/jsonapplication/json

Corps de la demandeRequest body

N’indiquez pas le corps de la demande pour cette méthode.Do not supply a request body for this method.

RéponseResponse

Si elle réussit, cette méthode renvoie un code de réponse 200 OK et la collection d’objets Contact dans le corps de la réponse.If successful, this method returns a 200 OK response code and collection of Contact objects in the response body.

ExempleExample

DemandeRequest

Voici un exemple de demande.Here is an example of the request.

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

Voici un exemple de la réponse. Remarque : L’objet de réponse illustré ici peut être tronqué à des fins de concision. Toutes les propriétés sont renvoyées à partir d’un appel réel.Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call.

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

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