read_organizations
List the caller's Organizations and read one Organization's details, permissions, Workspaces, transfers, or deletion impact.
# 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)
## read_organizations
List the caller's Organizations and read one Organization's details, permissions, Workspaces, transfers, or deletion impact.
Call to learn which Organizations and Workspaces the user can see before managing members, roles, or Workspaces.
Invisible Organizations and Workspaces answer not found; do not probe ids.
Scopes: org:read
Risk: read; confirmation: none; idempotency: none.
### Input schema (personal API key)
```json
{
"type": "object",
"anyOf": [
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"list"
]
}
]
}
},
"required": [
"view"
],
"patternProperties": {
"^(?!(?:view)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"view"
]
}
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"get"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"permissions"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaces"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"transfers"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"deletionPreview"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
}
],
"$defs": {
"ReadOrganizationsInput": {
"anyOf": [
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"list"
]
}
]
}
},
"required": [
"view"
],
"patternProperties": {
"^(?!(?:view)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"view"
]
}
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"get"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"permissions"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaces"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"transfers"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"deletionPreview"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
}
]
}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"anyOf": [
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"list"
]
}
]
}
},
"required": [
"view"
],
"patternProperties": {
"^(?!(?:view)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"view"
]
}
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"get"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"permissions"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaces"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"transfers"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"deletionPreview"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
}
],
"$defs": {
"ReadOrganizationsInput": {
"anyOf": [
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"list"
]
}
]
}
},
"required": [
"view"
],
"patternProperties": {
"^(?!(?:view)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"view"
]
}
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"get"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"permissions"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaces"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"transfers"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
},
{
"type": "object",
"properties": {
"view": {
"anyOf": [
{
"type": "string",
"enum": [
"deletionPreview"
]
}
]
},
"organizationId": {
"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": [
"view",
"organizationId"
],
"patternProperties": {
"^(?!(?:view|organizationId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"view",
"organizationId"
]
}
}
]
}
}
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"HttpUrl": {
"type": "string",
"minLength": 1,
"maxLength": 2048,
"pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$"
},
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"ReadOrganizationsOutput": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"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"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"logo": {
"anyOf": [
{
"$ref": "#/$defs/HttpUrl"
},
{
"type": "null"
}
]
},
"isOwner": {
"type": "boolean"
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"audit:read",
"billing:manage",
"billing:read",
"org:delete",
"orgAnalytics:read",
"orgAnalytics:manage",
"org:read",
"org:update",
"orgApiKey:manage",
"orgMember:invite",
"orgMember:read",
"orgMember:remove",
"orgMember:update",
"role:manage",
"role:read",
"usage:read",
"workspace:create",
"workspace:delete",
"workspace:transfer"
]
}
},
"visibleWorkspaceCount": {
"type": "integer"
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"name",
"logo",
"isOwner",
"permissions",
"visibleWorkspaceCount",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|name|logo|isOwner|permissions|visibleWorkspaceCount|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"logo",
"isOwner",
"permissions",
"visibleWorkspaceCount",
"createdAt"
]
}
}
},
{
"type": "object",
"properties": {
"id": {
"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"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"logo": {
"anyOf": [
{
"$ref": "#/$defs/HttpUrl"
},
{
"type": "null"
}
]
},
"isOwner": {
"type": "boolean"
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"audit:read",
"billing:manage",
"billing:read",
"org:delete",
"orgAnalytics:read",
"orgAnalytics:manage",
"org:read",
"org:update",
"orgApiKey:manage",
"orgMember:invite",
"orgMember:read",
"orgMember:remove",
"orgMember:update",
"role:manage",
"role:read",
"usage:read",
"workspace:create",
"workspace:delete",
"workspace:transfer"
]
}
},
"visibleWorkspaceCount": {
"type": "integer"
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"slug": {
"$ref": "#/$defs/ShortText"
},
"owner": {
"anyOf": [
{
"type": "object",
"properties": {
"userId": {
"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"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"userId",
"name",
"email"
],
"patternProperties": {
"^(?!(?:userId|name|email)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"userId",
"name",
"email"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"logo",
"isOwner",
"permissions",
"visibleWorkspaceCount",
"createdAt",
"slug",
"owner"
],
"patternProperties": {
"^(?!(?:id|name|logo|isOwner|permissions|visibleWorkspaceCount|createdAt|slug|owner)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"logo",
"isOwner",
"permissions",
"visibleWorkspaceCount",
"createdAt",
"slug",
"owner"
]
}
},
{
"type": "object",
"properties": {
"organizationId": {
"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"
},
"isOwner": {
"type": "boolean"
},
"organization": {
"type": "array",
"items": {
"type": "string",
"enum": [
"audit:read",
"billing:manage",
"billing:read",
"org:delete",
"orgAnalytics:read",
"orgAnalytics:manage",
"org:read",
"org:update",
"orgApiKey:manage",
"orgMember:invite",
"orgMember:read",
"orgMember:remove",
"orgMember:update",
"role:manage",
"role:read",
"usage:read",
"workspace:create",
"workspace:delete",
"workspace:transfer"
]
}
},
"allWorkspaces": {
"type": "array",
"items": {
"type": "string",
"enum": [
"analytics:export",
"analytics:read",
"apiKey:create",
"apiKey:delete",
"apiKey:read",
"apiKey:update",
"blocklist:create",
"blocklist:delete",
"blocklist:read",
"campaign:archive",
"campaign:create",
"campaign:delete",
"campaign:launch",
"campaign:pause",
"campaign:read",
"campaign:update",
"dialer:assign_numbers",
"dialer:assign_seats",
"dialer:create",
"dialer:delete",
"dialer:dial",
"dialer:manage_billing",
"dialer:manage_number_health",
"dialer:manage_numbers",
"dialer:manage_numbers_self",
"dialer:manage_voicemails",
"dialer:read",
"dialer:read_analytics",
"dialer:read_numbers_all",
"dialer:release_numbers",
"dialer:update",
"domain:manage_dns",
"domain:purchase",
"domain:read",
"domain:transfer",
"emailVerification:manage_credits",
"emailVerification:manage_keys",
"emailVerification:manage_sharing",
"emailVerification:read",
"emailVerification:verify",
"inbox:connect",
"inbox:create",
"inbox:delete",
"inbox:read",
"inbox:update",
"inbox:warmup_manage",
"integration:create",
"integration:delete",
"integration:read",
"integration:update",
"lead:create",
"lead:delete",
"lead:export",
"lead:import",
"lead:read",
"lead:update",
"leadList:create",
"leadList:delete",
"leadList:read",
"leadList:update",
"phoneVerification:manage_keys",
"phoneVerification:read",
"phoneVerification:verify",
"replyLabel:create",
"replyLabel:delete",
"replyLabel:read",
"replyLabel:update",
"sequence:create",
"sequence:delete",
"sequence:read",
"sequence:update",
"sql:manage_dashboards",
"sql:query",
"support:create",
"support:read",
"support:update",
"tag:create",
"tag:delete",
"tag:read",
"tag:update",
"task:create",
"task:delete",
"task:read",
"task:update",
"template:create",
"template:delete",
"template:read",
"template:update",
"unibox:archive",
"unibox:label",
"unibox:read",
"unibox:reply",
"webhook:create",
"webhook:delete",
"webhook:read",
"webhook:update",
"whiteLabel:read",
"whiteLabel:update",
"workflow:create",
"workflow:delete",
"workflow:publish",
"workflow:read",
"workflow:run",
"workflow:update",
"workspace:read",
"workspace:update",
"workspaceMember:invite",
"workspaceMember:read",
"workspaceMember:remove",
"workspaceMember:update"
]
}
},
"canDelete": {
"type": "boolean"
},
"canTransferOwnership": {
"type": "boolean"
}
},
"required": [
"organizationId",
"isOwner",
"organization",
"allWorkspaces",
"canDelete",
"canTransferOwnership"
],
"patternProperties": {
"^(?!(?:organizationId|isOwner|organization|allWorkspaces|canDelete|canTransferOwnership)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"organizationId",
"isOwner",
"organization",
"allWorkspaces",
"canDelete",
"canTransferOwnership"
]
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"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"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"slug": {
"$ref": "#/$defs/ShortText"
},
"logo": {
"anyOf": [
{
"$ref": "#/$defs/HttpUrl"
},
{
"type": "null"
}
]
},
"access": {
"type": "string",
"enum": [
"data",
"metadata"
]
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"analytics:export",
"analytics:read",
"apiKey:create",
"apiKey:delete",
"apiKey:read",
"apiKey:update",
"blocklist:create",
"blocklist:delete",
"blocklist:read",
"campaign:archive",
"campaign:create",
"campaign:delete",
"campaign:launch",
"campaign:pause",
"campaign:read",
"campaign:update",
"dialer:assign_numbers",
"dialer:assign_seats",
"dialer:create",
"dialer:delete",
"dialer:dial",
"dialer:manage_billing",
"dialer:manage_number_health",
"dialer:manage_numbers",
"dialer:manage_numbers_self",
"dialer:manage_voicemails",
"dialer:read",
"dialer:read_analytics",
"dialer:read_numbers_all",
"dialer:release_numbers",
"dialer:update",
"domain:manage_dns",
"domain:purchase",
"domain:read",
"domain:transfer",
"emailVerification:manage_credits",
"emailVerification:manage_keys",
"emailVerification:manage_sharing",
"emailVerification:read",
"emailVerification:verify",
"inbox:connect",
"inbox:create",
"inbox:delete",
"inbox:read",
"inbox:update",
"inbox:warmup_manage",
"integration:create",
"integration:delete",
"integration:read",
"integration:update",
"lead:create",
"lead:delete",
"lead:export",
"lead:import",
"lead:read",
"lead:update",
"leadList:create",
"leadList:delete",
"leadList:read",
"leadList:update",
"phoneVerification:manage_keys",
"phoneVerification:read",
"phoneVerification:verify",
"replyLabel:create",
"replyLabel:delete",
"replyLabel:read",
"replyLabel:update",
"sequence:create",
"sequence:delete",
"sequence:read",
"sequence:update",
"sql:manage_dashboards",
"sql:query",
"support:create",
"support:read",
"support:update",
"tag:create",
"tag:delete",
"tag:read",
"tag:update",
"task:create",
"task:delete",
"task:read",
"task:update",
"template:create",
"template:delete",
"template:read",
"template:update",
"unibox:archive",
"unibox:label",
"unibox:read",
"unibox:reply",
"webhook:create",
"webhook:delete",
"webhook:read",
"webhook:update",
"whiteLabel:read",
"whiteLabel:update",
"workflow:create",
"workflow:delete",
"workflow:publish",
"workflow:read",
"workflow:run",
"workflow:update",
"workspace:read",
"workspace:update",
"workspaceMember:invite",
"workspaceMember:read",
"workspaceMember:remove",
"workspaceMember:update"
]
}
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"name",
"slug",
"logo",
"access",
"permissions",
"createdAt"
],
"patternProperties": {
"^(?!(?:id|name|slug|logo|access|permissions|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"slug",
"logo",
"access",
"permissions",
"createdAt"
]
}
}
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"workspace": {
"type": "object",
"properties": {
"id": {
"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"
},
"name": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"id",
"name"
],
"patternProperties": {
"^(?!(?:id|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name"
]
}
},
"from": {
"type": "object",
"properties": {
"id": {
"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"
},
"name": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"id",
"name"
],
"patternProperties": {
"^(?!(?:id|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name"
]
}
},
"to": {
"type": "object",
"properties": {
"id": {
"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"
},
"name": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"id",
"name"
],
"patternProperties": {
"^(?!(?:id|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name"
]
}
},
"direction": {
"type": "string",
"enum": [
"outgoing",
"incoming"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"accepted",
"cancelled"
]
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"resolvedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"workspace",
"from",
"to",
"direction",
"status",
"createdAt",
"resolvedAt"
],
"patternProperties": {
"^(?!(?:id|workspace|from|to|direction|status|createdAt|resolvedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"workspace",
"from",
"to",
"direction",
"status",
"createdAt",
"resolvedAt"
]
}
}
},
{
"type": "object",
"properties": {
"organizationId": {
"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"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"workspaces": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"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"
},
"name": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"id",
"name"
],
"patternProperties": {
"^(?!(?:id|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name"
]
}
}
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"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"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
}
},
"required": [
"userId",
"name",
"email"
],
"patternProperties": {
"^(?!(?:userId|name|email)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"userId",
"name",
"email"
]
}
}
},
"blockedReason": {
"anyOf": [
{
"type": "string",
"enum": [
"only_owned_organization",
"active_subscription",
"purchased_resources"
]
},
{
"type": "null"
}
]
}
},
"required": [
"organizationId",
"name",
"workspaces",
"members",
"blockedReason"
],
"patternProperties": {
"^(?!(?:organizationId|name|workspaces|members|blockedReason)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"organizationId",
"name",
"workspaces",
"members",
"blockedReason"
]
}
}
]
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"$ref": "#/$defs/ReadOrganizationsOutput"
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"$ref": "#/$defs/ReadOrganizationsOutput"
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `organizations.list`: `GET /v1/organizations`
- `organizations.get`: `GET /v1/organizations/:organizationId`
- `organizations.myPermissions`: `GET /v1/organizations/:organizationId/permissions`
- `organizationWorkspaces.list`: `GET /v1/organizations/:organizationId/workspaces`
- `organizationWorkspaces.listTransfers`: `GET /v1/organizations/:organizationId/workspace-transfers`
- `organizations.deletionPreview`: `GET /v1/organizations/:organizationId/deletion-preview`
Scheduler Zero