API reference
This reference is generated from the running API’s own manifests, so it matches the shipped surface exactly: 124 live entity sets, 601 documented routes backed by 476 distinct cmdlets, and 30 least-privilege roles across 15 categories. 94 further entity sets are declared in the catalogue and answer 501 Not Implemented until they ship.
How to read a page
Section titled “How to read a page”Every entity-set page has the same shape: a facts table (path, category, tier, read role, write role with its plan, backing cmdlets linked to Microsoft Learn), a routes table, and one section per route with its description, parameters and examples. Examples are captured requests and responses with mock contoso data. Roles are the API’s narrow application roles; the plan column says which licence plan the operation needs. Reads are always Community. ?dryRun=true previews of any write stay on Community.
Categories
Section titled “Categories”| Category | Live | Declared |
|---|---|---|
| Recipients | 9 | 4 |
| Mailbox settings | 3 | 1 |
| Mail flow | 10 | 9 |
| Address book | 4 | 0 |
| Threat protection | 29 | 5 |
| Governance & protection | 21 | 2 |
| eDiscovery & audit | 9 | 3 |
| Roles & access | 8 | 5 |
| Encryption & rights | 6 | 3 |
| Sharing & federation | 3 | 6 |
| Devices & mobile | 5 | 2 |
| Organization | 5 | 17 |
| Migration & jobs | 6 | 4 |
| Public folders | 4 | 4 |
| Reports & insights | 2 | 29 |
Errors
Section titled “Errors”Every failure uses one canonical envelope; the errors page lists each status with when it occurs and a captured example.