Partner API for AI Business Solutions & Security Insights

Overview | API details | Getting started | Authentication | Base URLs | Rate limits & error handling | Sample output | Support | Endpoint Operations

Overview

The Partner API for AI Business Solutions & Security Insights enables partners to integrate their existing CRM systems with Microsoft data, including usage signals, upsell propensity, incentive eligibility, referral opportunities, and other key insights.

Before you begin coding, review the Getting started section for the steps required to onboard and gain access to the API.

Additional resources are available:

• Partner API Integration Guide
• JSON Swagger File

API details

The API is a standard REST formatted API accessible at https://m365partner.microsoft.com. All endpoints are prefixed by a version number. We are currently on versions v1.3, so calls use the following base URL: https://m365partner.microsoft.com/abss/v{version}/api/.

Example: https://m365partner.microsoft.com/abss/v1.3/api/timezones

Getting started

1. Complete the Partner API Onboarding Form.

   • Must be completed by a Partner Center Global Admin
   • You receive a confirmation email from PXPartnerSupport@microsoft.com once your onboarding is complete

2. Have a Global Administrator, Application Developer, Application Administrator, Cloud Application Administrator, or Hybrid Identity Administrator in Azure set up the two required Azure applications needed for API access. For example, with the Graph Explorer:

   

   • 7b388e5c-7dea-4e0b-bc73-415971207918 (Microsoft 365 Partner API)
     • API service principal
   • c584e1eb-b862-4992-b2f7-c2a94b4331a0 (M365-Partner-API-Admin-App)
     • Management portal https://management.m365partner.microsoft.com/; Global tenant admin must add the application Client ID and/or addition user.
   • Under Modify permissions, review and consent to the requested permissions.

3. Register an app in Microsoft Entra ID by following these steps:

   • In the Azure portal, go to Microsoft Entra ID > App registrations > New registration. Create the app, and then complete the registration.

4. Add Microsoft 365 Partner API permissions by following these steps:

   1. Open the app registration, and go to API permissions > Add permissions > APIs my organization uses.
   2. Search for M365 Partner API.
   3. For user access, select Delegated permissions; for application access, select Application permissions.
   4. Select the appropriate permission, select Add permissions, and then grant admin consent if necessary.

5. Configure authentication by following these steps:

   • In the same app registration, open Authentication, add your Redirect URL, and ensure Access tokens are enabled.

Authentication

Access tokens can be retrieved through Microsoft Entra ID.

In Microsoft Entra ID, set up your application with the following permission based on your scenario:

• User Authentication: Api.Access

• Application (Service Principal) Authentication: Api.Access.Application

When requesting a token in your OAuth client of choice, request a token for the following scope (resource):
https://m365partner.microsoft.com/.default.

Once you have the access token, call the API this authorization header: Authorization: Bearer \<Access Token\>

Base URLs

https://m365partner.microsoft.com/abss/v1.3/api/

Rate limits & error handling

Rate limits

The API rate limits activity to 600 calls per minute per identifiable user (or, if no user token is present, per IP address).  

Error Handling

All error responses return an HTTP status code in the header, plus error details in the following format:

{  
ErrorStatus: (400, 500, etc.)  
DependencyErrorCode: Optional structured error code from the dependency.  
Message: A descriptive message about the error that has occurred.  
}

The DependencyErrorCode typically provides more debugging information, usually as a simple string. For 400 (validation) errors, it may contain structured JSON describing which input fields were invalid and why.

Example:

{  
"errors": {  
   "Email": [ "Invalid email address provided" ],  
   "ContactTypeId": [ "Contact Type is Required" ]  
},  
"errorStatus": 400,  
"message": "One or more validation errors occurred."  
}

Sample output

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerTenants

Response Example (HTTP)  
Status: 200 OK  
{  
   "count": 2,  
   "hasMore": false,  
   "items": [  
    {  
      "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",  
      "tpid": 123,  
      "name": "Dummy Tenant 1",  
      "claimedWorkloads": [  
        {"id": 456, "name": "Dummy Workload 1"},  
        {"id": 789, "name": "Dummy Workload 2"}  
      ]  
   },  
   {  
      "tenantId": "bbbbcccc-1111-dddd-2222-eeee3333ffff",  
      "tpid": 456,  
      "name": "Dummy Tenant 2",  
      "claimedWorkloads": [  
        {"id": 123, "name": "Dummy Workload 3"}  
      ]  
     }  
    ]  
   }

Support

If you encounter issues with onboarding or API access, contact our support team at:

AI Business Solutions & Security Insights Partner Support: PXPartnerSupport@microsoft.com

Please include:

• Partner name
• MPN ID(s)
• The Tenant ID of your program membership
• A brief description of your issue

Endpoint Operations

Copilot Opportunities

Opportunities

Referrals

MCI Performance

Contacts

Incentives

Notes

Partner Center Data

Entitlements

Identity

Services & other lookups

Tenants

Current usage and mpnids

Contact Types

Retrieves a list of contact types along with their corresponding IDs.

GET https://m365partner.microsoft.com/abss/v1.3/api/contactTypes

Contact Types: URI parameters

None

Contact Types: Request header

Contact Types: Responses

Contact Types: Definitions

MPNIDs

GET https://m365partner.microsoft.com/abss/v1.3/api/admin/mpnIds

MPNIDs: URI parameters

None

MPNIDs: Request Header

MPNIDs: Responses

MPNIDs: Definitions

Countries/Regions

Retrieves a list of countries/regions along with their corresponding IDs.

GET https://m365partner.microsoft.com/abss/v1.3/api/countryRegions

Countries/Regions: URI parameters

None

Countries/Regions: Request Header

Countries/Regions: Responses

Countries/Regions: Definitions

Current User

Retrieves profile and access details for the currently authenticated Partner Center user. This includes basic identity information (name, email, IDs), partner role details, and flags for specific access permissions

GET https://m365partner.microsoft.com/abss/v1.3/api/currentUser

Current User: URI parameters

None

Current User: Request Header

Current User: Responses

Current User: Definitions

Year Periods

Retrieves a list of available year periods, each with a unique year period ID, a numeric period code, and a human-readable date range.

GET https://m365partner.microsoft.com/abss/v1.3/api/incentives/YearPeriods

Year Periods: URI Parameters

None

Year Periods: Request Header

Year Periods: Responses

Year Periods: Definitions

Programs

Retrieves a list of programs along with their corresponding IDs.

GET https://m365partner.microsoft.com/abss/v1.3/api/incentives/Programs

Programs: URI Parameters

None

Programs: Request Header

Programs: Responses

Programs: Definitions

Workloads

Retrieves a list of workloads, each with ID, display name, and associated program.

GET https://m365partner.microsoft.com/abss/v1.3/api/incentives/Workloads

Workloads: URI Parameters

None

Workloads: Request Header

Workloads: Responses

Workloads: Definitions

Statements

Searches statement data for the Partner.

GET https://m365partner.microsoft.com/abss/v1.3/api/incentives/Statements

Statements: URI Parameters

Statements: Request Header

Statements: Responses

Statements: Definitions

Note Categories

Retrieves a list of note categories with an associated ID.

GET https://m365partner.microsoft.com/abss/v1.3/api/noteCategories

Note Categories: URI parameters

None

Note Categories: Request Header

Note Categories: Responses

Note Categories: Definitions

Categories

Retrieves a list of opportunity categories with their category IDs (for example, E3, E5, E5 Expansion).

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories

Categories: URI parameters

None

Categories: Request Header

Categories: Responses

Categories: Definitions

Opportunity Category ID

Returns category opportunity count, license utilization, whitespace, tenant metrics, potential earnings, and category details for a particular category (for example, E3, E5, E5 Expansion).

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}

Opportunity Category ID: URI Parameters

Opportunity Category ID: Request Header

Opportunity Category ID: Responses

Opportunity Category ID: Definitions

Workload Utilization

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/WorkloadUtilization

Workload Utilization: URI Parameters

Workload Utilization: Request Header

Workload Utilization: Responses

Workload Utilization: Definitions

Workload Whitespace

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/WorkloadWhitespace

Workload Whitespace: URI parameters

Workload Whitespace: Request Header

Workload Whitespace: Responses

Workload Whitespace: Definitions

Workload Health

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/WorkloadHealth

Workload Health: URI parameters

Workload Health: Request Header

Workload Health: Responses

Workload Health: Definitions

Tenant Health

Returns the tenant health distribution within an opportunity category.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/TenantHealth

Tenant Health: URI parameters

Tenant Health: Request Header

Tenant Health: Responses

Tenant Health: Definitions

Workload Recommendations

Returns a list of workload recommendations within the specified opportunity category, with the count of recommendations for each.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/WorkloadRecommendations

Workload Recommendations: URI parameters

Workload Recommendations: Request Header

Workload Recommendations: Responses

Workload Recommendations: Definitions

Potential Earnings

Returns the potential earnings for each workload within a specified opportunity category.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/PotentialEarnings

Potential Earnings: URI parameters

Potential Earnings: Request Header

Potential Earnings: Responses

Potential Earnings: Definitions

Workload opportunities

Retrieves a paged list of workloads for a specific opportunity category, with optional filtering, sorting, and pagination.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/Workloads

Workload opportunities: URI parameters

Workload opportunities: Request Header

Workload opportunities: Responses

Workload opportunities: Definitions

Tenant Countries/Regions – opportunity category

Gets a list of tenant countries/regions relevant for a particular opportunity category.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/filters/tenantCountries

Tenant Countries/Regions – opportunity category: URI parameters

Tenant Countries/Regions – opportunity category: Request Header

Tenant Countries/Regions – opportunity category: Responses

Tenant Countries/Regions – opportunity category: Definitions

Segments

Returns a list of tenant segment names for the specified opportunity category.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/filters/segments

Segments: URI Parameters

Segments: Request Header

Segments: Responses

Segments: Definitions

Potential Workloads – specific opportunity

Returns a list of potential workloads for a specific opportunity category.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/categories/{opportunityCategoryId}/filters/PotentialWorkloads

Potential Workloads – specific opportunity: URI parameters

Potential Workloads – specific opportunity: Request Header

Potential Workloads – specific opportunity: Responses

Potential Workloads – specific opportunity: Definitions

Potential Workloads – workload ID

Gets a list of potential workloads along with the workload ID associated with each.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/PotentialWorkloads

Potential Workloads – workload ID: URI parameters

None

Potential Workloads – workload ID: Request Header

Potential Workloads – workload ID: Responses

Potential Workloads – workload ID: Definitions

MCI Engagements

Gets a list of MCI engagements.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/MciEngagements

MCI Engagements: URI parameters

MCI Engagements: Request Header

MCI Engagements: Responses

MCI Engagements: Definitions

Segments – available filters

Gets a list of segment filters available for the current user's MPN IDs.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/filters/segments

Segments – available filters: URI parameters

None

Segments – available filters: Request Header

Segments – available filters: Responses

Segments – available filters: Definitions

Tenant Countries/Regions – current user MPN IDs

Gets a list of tenant countries/regions available for the current user's MPN IDs.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/filters/tenantCountries

Tenant Countries/Regions – current user MPN IDs: URI parameters

None

Tenant Countries/Regions – current user MPN IDs: Request Header

Tenant Countries/Regions – current user MPN IDs: Responses

Tenant Countries/Regions – current user MPN IDs: Definitions

Summary – Copilot opportunities

Returns a summary of Copilot opportunities for the current user.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/summary

Summary – Copilot opportunities: URI parameters

None

Summary – Copilot opportunities: Request Header

Summary – Copilot opportunities: Responses

Summary – Copilot opportunities: Definitions

Copilot Targeting Scenario Summary

Returns a summary of Copilot opportunities by targeting scenario.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/targetingScenarioSummary

Copilot Targeting Scenario Summary: URI parameters

Copilot Targeting Scenario Summary: Request Header

Copilot Targeting Scenario Summary: Responses

Copilot Targeting Scenario Summary: Definitions

Copilot Tenant Segment

Returns the available tenant segments for Copilot opportunities.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/filters/tenantSegments

Copilot Tenant Segment: URI parameters

Copilot Tenant Segment: Request Header

None

Copilot Tenant Segment: Responses

Copilot Tenant Segment: Definitions

Copilot

Returns a list of copilot opportunities.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot

Copilot: URI parameters

Copilot: Request Header

Copilot: Responses

Copilot: Definitions

Tenant Penetration

Returns the number of tenants with Copilot enabled and the number of tenants without Copilot.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/tenantPenetration

Tenant Penetration: URI parameters

Tenant Penetration: Request Header

Tenant Penetration: Responses

Tenant Penetration: Definitions

Adoption Summary

Returns a health classification summary, showing the number of tenants in each health state.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/adoptionSummary

Adoption Summary: URI parameters

Adoption Summary: Request Header

Adoption Summary: Responses

Adoption Summary: Definitions

MCI Potential Earnings Summary

Returns a list of potential earnings of the specific MCI engagement based on program rates and geography of the partner.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/mciPotentialEarningsSummary

MCI Potential Earnings Summary: URI parameters

MCI Potential Earnings Summary: Request Header

MCI Potential Earnings Summary: Responses

MCI Potential Earnings Summary: Definitions

Usage by Product Monthly Snapshot

Retrieves usage data, broken down by licensed MAU, unlicensed MAU, and all MAU.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/usageByProductMonthlySnapshot

Usage by Product Monthly Snapshot: URI parameters

Usage by Product Monthly Snapshot: Request Header

Usage by Product Monthly Snapshot: Responses

Usage by Product Monthly Snapshot: Definitions

Tenant Countries/Regions - filtering

Retrieves the list of valid tenant countries/regions that can be used for filtering.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/filters/tenantCountries

Tenant Countries/Regions - filtering: URI parameters

None

Tenant Countries/Regions - filtering: Request Header

Tenant Countries/Regions - filtering: Responses

Tenant Countries/Regions - filtering: Definitions

Adoption Statuses

Retrieves the list of valid adoption status values that can be used for filtering.

GET https://m365partner.microsoft.com/abss/v1.3/api/opportunities/copilot/filters/adoptionStatuses

Adoption Statuses: URI parameters

None

Adoption Statuses: Request Header

Adoption Statuses: Responses

Adoption Statuses: Definitions

Customers

This Response provides a comprehensive data model for workloads, customers, and opportunities, including performance, incentive tracking, and adoption metrics.

GET https://m365partner.microsoft.com/abss/v1.3/api/partnerCenter/customers

Customers: URI parameters

None

Customers: Request Header

Customers: Responses

Customers: Definitions