Microsoft Fabric External Data Shares Recipient API
The ExternalDataSharesRecipient API from Microsoft Fabric — 2 operation(s) for externaldatasharesrecipient.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-fabric:microsoft-fabric-externaldatasharesrecipient-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Microsoft Fabric Platform REST External Data Shares…
version: v1
x-source: 'https://github.com/microsoft/fabric-rest-api-specs (bundled from openapi/_original/fabric-rest-api-specs: platform/swagger.json)'
servers:
- url: https://api.fabric.microsoft.com/v1
security: []
tags:
- name: ExternalDataSharesRecipient
paths:
/externalDataShares/invitations/{invitationId}:
get:
summary: Returns information about an external data share invitation
description: '## Required Delegated Scopes
ExternalDataShare.Accept.All
## Required Tenant Settings
To use this API, enable the *Users can accept external data shares* admin switch for the calling principal.
## Limitations
Maximum 10 requests per minute.
## Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
| Identity | Support |
|-|-|
| User | Yes |
| Service principal and Managed identities | Yes |
## Interface'
tags:
- ExternalDataSharesRecipient
operationId: ExternalDataSharesRecipient_GetExternalDataShareInvitationDetails
parameters:
- in: path
name: invitationId
description: The external data share invitation ID.
required: true
schema:
type: string
format: uuid
- in: query
name: providerTenantId
description: The external data share provider tenant ID.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ExternalDataShareInvitationDetails'
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: 'Common error codes:
* ExternalDataShareCannotBeAcceptedInTheSameTenant - An External Data Share cannot be accepted in the same tenant'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/externalDataShares/invitations/{invitationId}/accept:
post:
summary: Accepts an external data share invitation into a specified data item
description: '## Permissions
The caller must have *write* permissions on the item.
## Required Delegated Scopes
ExternalDataShare.Accept.All and for the specified item, one of the 2 types of scopes:
- Generic scope: Item.ReadWrite.All
- Specific scope: *itemType*.ReadWrite.All (for example: Lakehouse.ReadWrite.All)
For more information about scopes, see scopes article.
## Required Tenant Settings
To use this API, enable the *Users can accept external data shares* admin switch for the calling principal.
## Limitations
Maximum 10 requests per minute.
## Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
| Identity | Support |
|-|-|
| User | Yes |
| Service principal and Managed identities | Yes |
## Interface'
tags:
- ExternalDataSharesRecipient
operationId: ExternalDataSharesRecipient_AcceptExternalDataShareInvitation
parameters:
- in: path
name: invitationId
description: The external data share invitation ID.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Request completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/AcceptExternalDataShareInvitationResponse'
'429':
description: The service rate limit was exceeded. The server returns a `Retry-After` header indicating, in seconds, how long the client must wait before sending additional requests.
x-ms-error-response: true
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
default:
description: 'Common error codes:
* ExternalDataShareCannotBeAcceptedInTheSameTenant - An External Data Share cannot be accepted in the same tenant
* ExternalDataShareOperationNotSupportedForItemType - Item type is not supported for this operation'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AcceptExternalDataShareInvitationRequest'
description: The request payload for accepting an external data share invitation.
required: true
components:
schemas:
ErrorResponse:
description: The error response.
required:
- message
- errorCode
allOf:
- $ref: '#/components/schemas/ErrorResponseDetails'
properties:
requestId:
type: string
format: uuid
description: ID of the request associated with the error.
readOnly: true
moreDetails:
description: List of additional error details.
type: array
items:
$ref: '#/components/schemas/ErrorResponseDetails'
readOnly: true
isRetriable:
type: boolean
description: When true, the request can be retried. Use the `Retry-After` response header to determine the delay, if available.
readOnly: true
ExternalDataShareProviderTenantDetails:
type: object
description: External data share's provider tenant details.
required:
- tenantId
- displayName
- verifiedDomainName
properties:
tenantId:
type: string
format: uuid
description: The provider tenant ID.
readOnly: true
displayName:
type: string
description: The provider tenant display name.
readOnly: true
verifiedDomainName:
type: string
description: The provider tenant verified domain name (in Entra ID).
readOnly: true
ExternalDataSharePathType:
type: string
description: The type of a path in an external data share. Additional `ExternalDataSharePathType` types may be added over time.
enum:
- Folder
- Table
x-ms-enum:
name: ExternalDataSharePathType
modelAsString: true
values:
- value: Folder
description: 'The external data share path is of type: Folder'
- value: Table
description: 'The external data share path is of type: Table'
ExternalDataShareInvitationDetails:
type: object
description: External data share invitation details.
required:
- providerTenantDetails
- pathsDetails
properties:
providerTenantDetails:
$ref: '#/components/schemas/ExternalDataShareProviderTenantDetails'
pathsDetails:
type: array
description: Information about the paths included in the external data share.
items:
$ref: '#/components/schemas/ExternalDataSharePathDetails'
readOnly: true
AcceptExternalDataShareInvitationRequest:
type: object
description: The request payload for accepting an external data share invitation.
required:
- providerTenantId
- workspaceId
- itemId
- payload
properties:
providerTenantId:
type: string
format: uuid
description: The provider tenant ID.
readOnly: false
workspaceId:
type: string
format: uuid
description: The workspace ID.
readOnly: false
itemId:
type: string
format: uuid
description: The item ID.
readOnly: false
payload:
$ref: '#/components/schemas/ExternalDataShareAcceptRequestPayload'
ErrorResponseDetails:
description: The error response details.
type: object
required:
- message
- errorCode
properties:
errorCode:
type: string
description: A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
readOnly: true
message:
type: string
description: A human readable representation of the error.
readOnly: true
relatedResource:
$ref: '#/components/schemas/ErrorRelatedResource'
parameters:
description: Structured parameters providing additional machine-readable context about the error.
type: array
items:
$ref: '#/components/schemas/ErrorParameter'
readOnly: true
ErrorRelatedResource:
description: The error related resource details object.
type: object
required:
- resourceId
- resourceType
properties:
resourceId:
type: string
description: The resource ID that's involved in the error.
readOnly: true
resourceType:
type: string
description: The type of the resource that's involved in the error.
readOnly: true
ExternalDataShareAcceptRequestPayload:
description: Payload for the Accept External Data Share invitation request
type: object
required:
- payloadType
discriminator:
propertyName: payloadType
properties:
payloadType:
description: The external data share acceptance type. Additional types may be added over time.
type: string
enum:
- ShortcutCreation
x-ms-enum:
name: ExternalDataShareAcceptRequestPayloadType
modelAsString: true
values:
- value: ShortcutCreation
description: A OneLake shortcut.
AcceptExternalDataShareInvitationResponse:
type: object
description: The response for accepting an external data share invitation.
required:
- value
properties:
value:
type: array
description: A list of shortcuts that were created by accepting an external data share invitation.
items:
$ref: '#/components/schemas/ExternalDataShareShortcutInfo'
readOnly: true
ErrorParameter:
description: A structured parameter providing additional machine-readable context about an error.
type: object
properties:
name:
type: string
description: The parameter identifier.
readOnly: true
value:
type: string
description: The parameter value.
readOnly: true
message:
type: string
description: A human-readable description of the parameter's meaning.
readOnly: true
ExternalDataSharePathDetails:
type: object
description: Details of a path that was shared as part of external data sharing.
required:
- pathId
- type
- name
properties:
pathId:
type: string
format: uuid
description: Unique identifier of the path.
readOnly: true
type:
$ref: '#/components/schemas/ExternalDataSharePathType'
name:
type: string
description: The name of the content that was shared.
readOnly: true
ExternalDataShareShortcutInfo:
type: object
description: Information about a shortcut that was created by accepting an external data share invitation.
required:
- workspaceId
- itemId
- path
- name
properties:
workspaceId:
type: string
format: uuid
description: The workspace ID.
readOnly: true
itemId:
type: string
format: uuid
description: The item ID.
readOnly: true
path:
type: string
description: The path in which the shortcut was created.
readOnly: true
name:
type: string
description: The name of the shortcut.
readOnly: true