OrganizationConfig endpoint in the Exchange Online Admin API

Note

The features described in this article are currently in Preview, aren't available in all organizations, and are subject to change.

The OrganizationConfig endpoint in the Exchange Online Admin API retrieves organization-wide settings related to MailTips and a few other associated service configurations.

The Exchange Online Admin API provides a REST-based way to execute specific PowerShell cmdlets, replacing legacy Exchange Web Services (EWS) scenarios. For more information, see Overview of the Exchange Online Admin API.

Endpoint URL

POST https://outlook.office365.com/adminapi/v2.0/<TenantID>/OrganizationConfig

Tip

Use the base URL for your environment as described in Supported environments and base URLs.

Request model

Headers

Authorization: Bearer <auth token>
Content-Type: application/json
X-AnchorMailbox: <routing hint>

For X-AnchorMailbox values, see X-AnchorMailbox routing hint.

Body

{
  "CmdletInput": {
    "CmdletName": "Get-OrganizationConfig"
  }
}

Pagination

Pagination isn't available. The Get-OrganizationConfig cmdlet returns a single organization configuration object.

Supported cmdlets and parameters

The supported cmdlet for this endpoint is Get-OrganizationConfig. Any other cmdlet in the body of this endpoint results in an error.

No parameters for the Get-OrganizationConfig cmdlet are available through through the REST endpoint.

Response overview

Note

During Preview, the endpoint includes the full Get-OrganizationConfig cmdlet output in the API response. During the transition to public release, the response will be limited to the core properties listed in this section (properties needed for the EWS‑equivalent scenario). We recommend you use the properties listed in this section only. We'll document any changes to the available properties.

The Get-OrganizationConfig response is a single JSON object that represents the organization-level settings. The following properties are returned:

• Name: Exchange display name for the organization configuration object (there's only one in an organization).
• Identity: Canonical identity used by Exchange (often mirrors the Name value).
• Id: Service identifier for the organization configuration object.
• Guid: Stable GUID of the organization configuration object.
• MailTipsAllTipsEnabled: Indicates whether MailTips are enabled for all tips. The default value is True.
• MailTipsExternalRecipientsTipsEnabled: Indicates whether MailTips are shown for external recipients. The default value is False.
• MailTipsLargeAudienceThreshold: Threshold for large audiences that affects MailTips behavior. The default value is 25.

Examples

• Example 1:

  This example returns the organization-wide configuration, including MailTips settings and core feature flags.

  POST /adminapi/v2.0/<TenantID>/OrganizationConfig HTTP/1.1
  Host: outlook.office365.com
  Authorization: Bearer <auth token>
  Content-Type: application/json
  X-AnchorMailbox: <Routing Hint>
  
  {
    "CmdletInput": {
      "CmdletName": "Get-OrganizationConfig"
    }
  }