Modifica

List notes

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get a list of the note objects in the user's Notes folder.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) ShortNotes.Read ShortNotes.ReadWrite
Delegated (personal Microsoft account) ShortNotes.Read ShortNotes.ReadWrite
Application ShortNotes.Read.All ShortNotes.ReadWrite.All

HTTP request

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

Optional query parameters

This method supports the $select, $filter, $orderby, $top, $skip, and $count OData query parameters to help customize the response. For general information, see OData query parameters.

The following properties support $filter:

  • subject: eq, ne, startsWith
  • createdDateTime: eq, ge, le, gt, lt
  • lastModifiedDateTime: eq, ge, le, gt, lt
  • hasAttachments: eq

The following properties support $orderby: createdDateTime, lastModifiedDateTime, and subject.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of note objects in the response body.

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/me/notes?$select=id,subject,bodyPreview,lastModifiedDateTime&$orderby=lastModifiedDateTime desc&$top=20

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#users('user-id')/notes(id,subject,bodyPreview,lastModifiedDateTime)",
  "@odata.nextLink": "https://graph.microsoft.com/beta/me/notes?$select=id,subject,bodyPreview,lastModifiedDateTime&$orderby=lastModifiedDateTime+desc&$top=20&$skiptoken=abc123",
  "value": [
    {
      "id": "AAMkAGI2THVSAAA=",
      "subject": "Team Standup - Jan 20",
      "bodyPreview": "Completed tasks: Feature A, Feature B. In progress: Feature C",
      "lastModifiedDateTime": "2024-01-20T09:15:00Z"
    },
    {
      "id": "AAMkAGI2THVSAAB=",
      "subject": "Shopping List",
      "bodyPreview": "Milk, Eggs, Bread, Coffee",
      "lastModifiedDateTime": "2024-01-19T18:30:00Z"
    }
  ]
}
  • Last updated on