mailboxImportRequests

PST Import Requests. Jobs that import PST files into a mailbox. The mailboxImportRequests entity set lives under /exchange/v1.0/mailboxImportRequests in the Migration & jobs category.

Fact	Value
Path	/exchange/v1.0/mailboxImportRequests
Category	Migration & jobs
Tier	Tier 6, Mailbox jobs
Read role	MailboxJobs.Read.All (Community)
Write role	none (read-only)
Backing cmdlets	Get-MailboxImportRequest, Set-MailboxImportRequest, Get-MailboxImportRequestStatistics

Routes

Method	Path	Synopsis	Role	Plan
GET	/exchange/v1.0/mailboxImportRequests	List mailboxImportRequests entries.	MailboxJobs.Read	Community
GET	/exchange/v1.0/mailboxImportRequests/{key}	Get a single mailboxImportRequests entry by Identity.	MailboxJobs.Read	Community
GET	/exchange/v1.0/mailboxImportRequests/{key}/statistics	Get-MailboxImportRequestStatistics - per-import-request progress.	MailboxJobs.Read	Community

GET /exchange/v1.0/mailboxImportRequests

List mailboxImportRequests entries.

Backing cmdlet: Get-MailboxImportRequest. Role: MailboxJobs.Read (Community).

Parameter	In	Type	Required	Description
status	query	string		Filter requests by status (Get-MailboxImportRequest -Status). One of: AutoSuspended, Completed, CompletedWithWarning, CompletionInProgress, Failed, InProgress, Queued, Retrying, Suspended, Synced.
all	query	bool (switch)		Return all results instead of the EXO default of 1000. Maps -ResultSize Unlimited on Get-MailboxImportRequest; prevents silent truncation in large tenants.
batchName	query	string
name	query	string
suspend	query	bool (switch)

List mailboxImportRequests

Stub auto-generated example for the mailboxImportRequests collection. Backing cmdlet: Get-MailboxImportRequest. Live-verify with ?$top=3&$select=Id,Name and replace the synthetic body before promoting to Tier 1.

GET /exchange/v1.0/mailboxImportRequests?$top=3 HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 200 OK

{
  "@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mailboxImportRequests",
  "value": []
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/mailboxImportRequests/{key}

GET /exchange/v1.0/mailboxImportRequests/{key}

Get a single mailboxImportRequests entry by Identity.

Backing cmdlet: Get-MailboxImportRequest. Role: MailboxJobs.Read (Community).

Get a single mailboxImportRequests entry

Stub auto-generated example for GET /mailboxImportRequests/{key}. Backing cmdlet: Get-MailboxImportRequest with -Identity {key}. Returns the full entity body; 404 if the identity doesn’t resolve.

GET /exchange/v1.0/mailboxImportRequests/{key} HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 200 OK

{
  "@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mailboxImportRequests/$entity"
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/mailboxImportRequests

GET /exchange/v1.0/mailboxImportRequests/{key}/statistics

Get-MailboxImportRequestStatistics - per-import-request progress.

Backing cmdlet: Get-MailboxImportRequestStatistics. Role: MailboxJobs.Read (Community).

Parameter	In	Type	Required	Description
includeReport	query	bool (switch)		Return additional troubleshooting detail in the Report field (Get-MailboxImportRequestStatistics -IncludeReport).
includeSkippedItems	query	bool (switch)		Include skipped items for the request in the statistics (Get-MailboxImportRequestStatistics -IncludeSkippedItems).