get_integration_share_options
Show whether a connection can be shared and which sibling workspaces can receive it.
# MCP tool reference
1 callable tools.
Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.
Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.
[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)
## get_integration_share_options
Show whether a connection can be shared and which sibling workspaces can receive it.
Call before share_integration_connection to pick eligible workspaceIds and see existing targets.
Ineligible workspaces (no permission, or already their own connection) are listed with a reason; do not retry them.
Scopes: integration:read
Risk: read; confirmation: none; idempotency: none.
### Input schema (personal API key)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"adapter": {
"$ref": "#/$defs/IntegrationShareAdapter"
},
"connectionId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"workspaceId",
"adapter",
"connectionId"
],
"patternProperties": {
"^(?!(?:workspaceId|adapter|connectionId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"adapter",
"connectionId"
]
},
"$defs": {
"IntegrationShareAdapter": {
"type": "string",
"enum": [
"apollo",
"prospeo",
"conductor",
"mxtoolbox",
"clay",
"floqer",
"heyreach",
"getleads",
"plusvibe",
"calendly",
"cal_com",
"attio",
"email_verifier",
"phone_verifier",
"warmup_provider",
"mcp_server",
"app_connection"
]
}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"adapter": {
"$ref": "#/$defs/IntegrationShareAdapter"
},
"connectionId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"workspaceId",
"adapter",
"connectionId"
],
"patternProperties": {
"^(?!(?:workspaceId|adapter|connectionId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"adapter",
"connectionId"
]
},
"$defs": {
"IntegrationShareAdapter": {
"type": "string",
"enum": [
"apollo",
"prospeo",
"conductor",
"mxtoolbox",
"clay",
"floqer",
"heyreach",
"getleads",
"plusvibe",
"calendly",
"cal_com",
"attio",
"email_verifier",
"phone_verifier",
"warmup_provider",
"mcp_server",
"app_connection"
]
}
}
}
```
### Output schema (structuredContent)
```json
{
"type": "object",
"properties": {
"adapter": {
"$ref": "#/$defs/IntegrationShareAdapter"
},
"provider": {
"type": "string",
"pattern": "^[a-z][a-z0-9_-]{0,63}$"
},
"displayName": {
"$ref": "#/$defs/ShortText"
},
"connectionId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"shareable": {
"type": "boolean"
},
"reason": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"existingShareId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"includeFutureWorkspaces": {
"type": "boolean"
},
"candidates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"workspaceName": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"eligible": {
"type": "boolean"
},
"reason": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"attaching",
"attached",
"detached",
"failed"
]
},
{
"type": "null"
}
]
}
},
"required": [
"workspaceId",
"workspaceName",
"eligible",
"reason",
"state"
],
"patternProperties": {
"^(?!(?:workspaceId|workspaceName|eligible|reason|state)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"workspaceName",
"eligible",
"reason",
"state"
]
}
},
"maxItems": 500
}
},
"required": [
"adapter",
"provider",
"displayName",
"connectionId",
"shareable",
"reason",
"existingShareId",
"includeFutureWorkspaces",
"candidates"
],
"patternProperties": {
"^(?!(?:adapter|provider|displayName|connectionId|shareable|reason|existingShareId|includeFutureWorkspaces|candidates)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"adapter",
"provider",
"displayName",
"connectionId",
"shareable",
"reason",
"existingShareId",
"includeFutureWorkspaces",
"candidates"
]
},
"$defs": {
"IntegrationShareAdapter": {
"type": "string",
"enum": [
"apollo",
"prospeo",
"conductor",
"mxtoolbox",
"clay",
"floqer",
"heyreach",
"getleads",
"plusvibe",
"calendly",
"cal_com",
"attio",
"email_verifier",
"phone_verifier",
"warmup_provider",
"mcp_server",
"app_connection"
]
},
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
```
### Underlying API operations
- `integrationShares.options`: `GET /v1/workspaces/:workspaceId/integration-shares/options`