Microsoft Entra ID (formerly Azure AD)

Microsoft Entra ID (formerly Azure AD) Users.outlook User API

The users.outlookUser API from Microsoft Entra ID (formerly Azure AD) — 7 operation(s) for users.outlookuser.

GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /users/{user-id}/outlook Get a user's Outlook settings container · Get outlook from users #
Ask an LLM
“Can I read the Outlook services object for a user in Microsoft Graph?”
“What sits under a user's outlook resource?”
Tell an agent
Get the Outlook object for user {user_id}.
Show the outlook container of {user_id} with its properties.
GET /users/{user-id}/outlook/masterCategories List a user's Outlook categories · Get masterCategories from users #
Ask an LLM
“Which color categories has a user defined in Outlook?”
“How do I see the master category list a user tags mail and events with?”
Tell an agent
List the Outlook master categories for user {user_id}.
Show every category name and color defined by {user_id}.
POST /users/{user-id}/outlook/masterCategories Create an Outlook category for a user · Create new navigation property to masterCategories for users #
Ask an LLM
“Can I add a new color category to a user's Outlook master list?”
“Which color can I assign when creating an Outlook category?”
Tell an agent
Create Outlook category {name} for user {user_id}.
Add category {name} with color {color} to {user_id}'s master list.
GET /users/{user-id}/outlook/masterCategories/{outlookCategory-id} Get one of a user's Outlook categories · Get masterCategories from users #
Ask an LLM
“What name and color does a specific Outlook category of a user have?”
“Can I look up a single master category by its id?”
Tell an agent
Get Outlook category {category_id} of user {user_id}.
Show the name and color of category {category_id} for {user_id}.
PATCH /users/{user-id}/outlook/masterCategories/{outlookCategory-id} Change an existing Outlook category · Update the navigation property masterCategories in users #
Ask an LLM
“Can I change the color of an Outlook category a user already has?”
“Which properties of an existing master category are editable?”
Tell an agent
Change the color of category {category_id} for user {user_id} to {color}.
Update existing Outlook category {category_id} of {user_id}.
DELETE /users/{user-id}/outlook/masterCategories/{outlookCategory-id} Delete one of a user's Outlook categories · Delete navigation property masterCategories for users #
Ask an LLM
“Can I remove a category from a user's Outlook master list?”
“Is deleting an Outlook category something I can undo?”
Tell an agent destructive · confirm first
Delete Outlook category {category_id} from user {user_id}.
Remove category {category_id} from {user_id}'s master list if its ETag is {etag}.
GET /users/{user-id}/outlook/masterCategories/$count Count a user's Outlook categories · Get the number of the resource #
Ask an LLM
“How many Outlook categories has a user defined?”
“Can I get just the total size of a user's master category list?”
Tell an agent
Count the Outlook master categories of user {user_id}.
Return only the category total for {user_id}.
GET /users/{user-id}/outlook/microsoft.graph.supportedLanguages() List languages supported for a user's mailbox · Invoke function supportedLanguages #
Ask an LLM
“Which locales and languages does a user's mailbox server support?”
“What language options can I offer a user for their Outlook settings?”
Tell an agent
List the supported languages for the mailbox of user {user_id}.
Show the locales configured on {user_id}'s mailbox server.
GET /users/{user-id}/outlook/microsoft.graph.supportedTimeZones() List a user's supported time zones in the default format · Invoke function supportedTimeZones #
Ask an LLM
“What time zones does a user's Outlook mailbox support, without picking a naming standard?”
“Can I page through the default list of time zones available to a user's mailbox?”
Tell an agent
List the time zones {user_id}'s mailbox supports, using the default naming.
Show the first {top} supported time zones for {user_id}'s Outlook settings.
GET /users/{user-id}/outlook/microsoft.graph.supportedTimeZones(TimeZoneStandard='{TimeZoneStandard}') List supported time zones in a chosen standard · Invoke function supportedTimeZones #
Ask an LLM
“Can I get a user's supported time zones in Windows or IANA format?”
“Which time zone naming standard can I request for the mailbox's supported list?”
Tell an agent
Return {user_id}'s mailbox-supported time zones named per the {standard} standard, Windows or IANA.
Show {user_id}'s mailbox time zones using naming standard {standard}.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/graph/api/overview
📖
Authentication
https://learn.microsoft.com/en-us/graph/auth/
📖
Documentation
https://learn.microsoft.com/en-us/graph/change-notifications-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/openapi/azure-ad-users-outlookuser-api-openapi.yml

Other Resources

🔗
SDKs
https://learn.microsoft.com/en-us/graph/sdks/sdks-overview
🔗
ChangeLog
https://developer.microsoft.com/en-us/graph/changelog
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/asyncapi/azure-ad-change-notifications-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/azure-ad:azure-ad-users-outlookuser-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

azure-ad-users-outlookuser-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Users.outlook User API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: users.outlookUser
paths:
  /users/{user-id}/outlook:
    get:
      tags:
      - users.outlookUser
      summary: Get outlook from users
      operationId: user_GetOutlook
      parameters:
      - name: user-id
        in: path
        description: The unique identifier of user
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: user
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.outlookUser'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /users/{user-id}/outlook/masterCategories:
    get:
      tags:
      - users.outlookUser
      summary: Get masterCategories from users
      description: A list of categories defined for the user.
      operationId: user.outlook_ListMasterCategory
      parameters:
      - name: user-id
        in: path
        description: The unique identifier of user
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: user
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      - name: $orderby
        in: query
        description: Order items by property values
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          $ref: '#/components/responses/microsoft.graph.outlookCategoryCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
    post:
      tags:
      - users.outlookUser
      summary: Create new navigation property to masterCategories for users
      operationId: user.outlook_CreateMasterCategory
      parameters:
      - name: user-id
        in: path
        description: The unique identifier of user
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: user
      requestBody:
        description: New navigation property
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.outlookCategory'
        required: true
      responses:
        2XX:
          description: Created navigation property.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.outlookCategory'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /users/{user-id}/outlook/masterCategories/{outlookCategory-id}:
    get:
      tags:
      - users.outlookUser
      summary: Get masterCategories from users
      description: A list of categories defined for the user.
      operationId: user.outlook_GetMasterCategory
      parameters:
      - name: user-id
        in: path
        description: The unique identifier of user
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: user
      - name: outlookCategory-id
        in: path
        description: The unique identifier of outlookCategory
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: outlookCategory
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.outlookCategory'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - users.outlookUser
      summary: Update the navigation property masterCategories in users
      operationId: user.outlook_UpdateMasterCategory
      parameters:
      - name: user-id
        in: path
        description: The unique identifier of user
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: user
      - name: outlookCategory-id
        in: path
        description: The unique identifier of outlookCategory
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: outlookCategory
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.outlookCategory'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.outlookCategory'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - users.outlookUser
      summary: Delete navigation property masterCategories for users
      operationId: user.outlook_DeleteMasterCategory
      parameters:
      - name: user-id
        in: path
        description: The unique identifier of user
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: user
      - name: outlookCategory-id
        in: path
        description: The unique identifier of outlookCategory
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: outlookCategory
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /users/{user-id}/outlook/masterCategories/$count:
    get:
      tags:
      - users.outlookUser
      summary: Get the number of the resource
      operationId: user.outlook.masterCategory_GetCount
      parameters:
      - name: user-id
        in: path
        description: The unique identifier of user
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: user
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      responses:
        2XX:
          $ref: '#/components/responses/ODataCountResponse'
        default:
          $ref: '#/components/responses/error'
  /users/{user-id}/outlook/microsoft.graph.supportedLanguages():
    get:
      tags:
      - users.outlookUser
      summary: Invoke function supportedLanguages
      description: 'Get the list of locales and languages that are supported for the user, as configured on the user''s mailbox server. When setting up an Outlook client, the user selects the preferred language from this supported list. You can subsequently get the preferred language by

        getting the user''s mailbox settings.'
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/outlookuser-supportedlanguages?view=graph-rest-1.0
      operationId: user.outlook_supportedLanguage
      parameters:
      - name: user-id
        in: path
        description: The unique identifier of user
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: user
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/microsoft.graph.localeInfo'
                  '@odata.nextLink':
                    type:
                    - string
                    - 'null'
                additionalProperties:
                  type: object
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: function
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
  /users/{user-id}/outlook/microsoft.graph.supportedTimeZones():
    get:
      tags:
      - users.outlookUser
      summary: Invoke function supportedTimeZones
      operationId: user.outlook_supportedTimeZone
      parameters:
      - name: user-id
        in: path
        description: The unique identifier of user
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: user
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/microsoft.graph.timeZoneInformation'
                  '@odata.nextLink':
                    type:
                    - string
                    - 'null'
                additionalProperties:
                  type: object
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: function
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
  /users/{user-id}/outlook/microsoft.graph.supportedTimeZones(TimeZoneStandard='{TimeZoneStandard}'):
    get:
      tags:
      - users.outlookUser
      summary: Invoke function supportedTimeZones
      operationId: getUsersByUserIdOutlookMicrosoftGraphSupportedTimeZones(TimeZoneStandard='{TimeZoneStandard}')
      parameters:
      - name: user-id
        in: path
        description: The unique identifier of user
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: user
      - name: TimeZoneStandard
        in: path
        description: 'Usage: TimeZoneStandard=''{TimeZoneStandard}'''
        required: true
        style: simple
        schema:
          $ref: '#/components/schemas/microsoft.graph.timeZoneStandard'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/microsoft.graph.timeZoneInformation'
                  '@odata.nextLink':
                    type:
                    - string
                    - 'null'
                additionalProperties:
                  type: object
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: function
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-operation-id-source: normalized
      x-operation-id-original: user.outlook_supportedTimeZone
components:
  responses:
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
    microsoft.graph.outlookCategoryCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.outlookCategoryCollectionResponse'
    ODataCountResponse:
      description: The count of the resource
      content:
        text/plain:
          schema:
            $ref: '#/components/schemas/ODataCountResponse'
  schemas:
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type:
          - string
          - 'null'
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
      additionalProperties:
        type: object
    microsoft.graph.timeZoneInformation:
      title: timeZoneInformation
      type: object
      properties:
        alias:
          type:
          - string
          - 'null'
          description: An identifier for the time zone.
        displayName:
          type:
          - string
          - 'null'
          description: A display string that represents the time zone.
      additionalProperties:
        type: object
    microsoft.graph.outlookCategory:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: outlookCategory
        type: object
        properties:
          color:
            $ref: '#/components/schemas/microsoft.graph.categoryColor'
          displayName:
            type:
            - string
            - 'null'
            description: A unique name that identifies a category in the user's mailbox. After a category is created, the name cannot be changed. Read-only.
        additionalProperties:
          type: object
    microsoft.graph.outlookUser:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: outlookUser
        type: object
        properties:
          masterCategories:
            type: array
            items:
              $ref: '#/components/schemas/microsoft.graph.outlookCategory'
            description: A list of categories defined for the user.
            x-ms-navigationProperty: true
        additionalProperties:
          type: object
    microsoft.graph.outlookCategoryCollectionResponse:
      title: Collection of outlookCategory
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.outlookCategory'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.timeZoneStandard:
      title: timeZoneStandard
      enum:
      - windows
      - iana
      type: string
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.categoryColor:
      title: categoryColor
      enum:
      - none
      - preset0
      - preset1
      - preset2
      - preset3
      - preset4
      - preset5
      - preset6
      - preset7
      - preset8
      - preset9
      - preset10
      - preset11
      - preset12
      - preset13
      - preset14
      - preset15
      - preset16
      - preset17
      - preset18
      - preset19
      - preset20
      - preset21
      - preset22
      - preset23
      - preset24
      type: string
    microsoft.graph.localeInfo:
      title: localeInfo
      type: object
      properties:
        displayName:
          type:
          - string
          - 'null'
          description: A name representing the user's locale in natural language, for example, 'English (United States)'.
        locale:
          type:
          - string
          - 'null'
          description: A locale representation for the user, which includes the user's preferred language and country/region. For example, 'en-us'. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.entity:
      title: entity
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for an entity. Read-only.
      additionalProperties:
        type: object
    ODataCountResponse:
      type: integer
      format: int32
  parameters:
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
  securitySchemes:
    azureaadv2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}