List anniversaries
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.
Retrieve a list of personAnniversary objects for the given user from their profile.
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) | User.Read, User.ReadWrite, User.ReadBasic.All, User.Read.All, User.ReadWrite.All |
Delegated (personal Microsoft account) | User.Read, User.ReadWrite, User.ReadBasic.All, User.Read.All, User.ReadWrite.All |
Application | User.Read.All, User.ReadWrite.All |
HTTP request
GET /me/profile/anniversaries
GET /users/{id | userPrincipalName}/profile/anniversaries
Optional query parameters
This method supports the following OData query parameters to help customize the response. For general information, see OData query parameters.
Name | Value | Description |
---|---|---|
$filter | string | Limits the response to only those objects which contain the specified criteria. |
$orderby | string | By default the objects in the response are sorted by their createdDateTime value in a query. You can change the order of the of the response using the $orderby parameter. |
$select | string | Comma-separated list of properties to include in the response. For optimal performance, only select the subset of properties needed. |
$skip | int | Skip the first n results, useful for paging. |
$top | int | Number of results to be returned. |
Request headers
Name | Description |
---|---|
Authorization | 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 a collection of personAnniversary objects in the response body.
Examples
Request
The following is an example of the request.
GET https://graph.microsoft.com/beta/me/profile/anniversaries
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": [
{
"id": "0fb4c1e3-c1e3-0fb4-e3c1-b40fe3c1b40f",
"allowedAudiences": "organization",
"inference": null,
"createdDateTime": "2020-07-06T06:34:12.2294868Z",
"createdBy": {
"application": null,
"device": null,
"user": {
"displayName": "Innocenty Popov",
"id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
}
},
"lastModifiedDateTime": "2020-07-06T06:34:12.2294868Z",
"lastModifiedBy": {
"application": null,
"device": null,
"user": {
"displayName": "Innocenty Popov",
"id": "db789417-4ccb-41d1-a0a9-47b01a09ea49"
}
},
"type": "birthday",
"date": "Date"
}
]
}
Feedback
Submit and view feedback for