Get contactFolder

Get a contact folder by using the contact folder ID.

Get another user's contact folder

If you have application permissions, or if you have the appropriate delegated permissions from one user, it's possible to a get contact folder of another user's. This section focuses on scenarios that involve delegated permissions.

For example, your app has acquired delegated permissions from the user, John. Suppose another user, Garth, has shared a contact folder with John. You can get that shared folder by specifying Garth’s user ID (or user principal name) in the example query shown below.

GET /users/{Garth-id | Garth-userPrincipalName}/contactFolders/{id}

This capability applies to all GET contact folder operations for an individual user, as described in the HTTP request section below. It also applies if Garth has delegated his entire mailbox to John.

If Garth has not shared his contact folder with John, nor has he delegated his mailbox to John, specifying Garth’s user ID or user principal name in those GET operations will return an error. In such cases, specifying a user ID or user principal name only works for getting a contact folder of the signed-in user’s, and the query is equivalent to using the /me shortcut:

GET /me/contactFolders/{id}

This capability is available in only GET operations of:

  • Shared contact folders
  • Shared calendars
  • Contacts and events in shared folders
  • The above resources in delegated mailboxes

This capability is not available in other operations for contacts, events, and their folders.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Contacts.Read, Contacts.ReadWrite
Delegated (personal Microsoft account) Contacts.Read, Contacts.ReadWrite
Application Contacts.Read, Contacts.ReadWrite

HTTP request

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

Optional query parameters

This method supports the OData Query Parameters to help customize the response.

Request headers

Name Type Description
Authorization string Bearer {token}. Required.

Request body

Do not supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and contactFolder object in the response body.

Example

Request

Here is an example of the request.

GET https://graph.microsoft.com/v1.0/me/contactFolders/{id}
Response

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: 104

{
  "displayName": "Finance",
  "id": "AAMkAGI2TKI5AAA=",
  "parentFolderId": "AAMkAGI2AAEOAAA="
}