# 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_api_keys Read the caller's own personal API keys (ADR-075): each key's name, access (full account or per-Organization grants), Organizations that blocked it, last use, and expiry. Use `list` or `get` to review what the person's keys can reach, before narrowing or revoking one. Never returns a secret and never shows other people's keys; for members' keys that can act in an Organization use read_organization_api_key_access. To create a key, hand the person `/account/api-keys` in the Scheduler Zero web app. Scopes: apiKey:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "get" ] }, "apiKeyId": { "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": [ "action" ], "patternProperties": { "^(?!(?:action|apiKeyId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "apiKeyId" ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "get" ] }, "apiKeyId": { "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": [ "action" ], "patternProperties": { "^(?!(?:action|apiKeyId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "apiKeyId" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "apiKeys": { "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": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "access": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "full" ] } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "type" ] } ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "restricted" ] } ] }, "organizations": { "type": "array", "items": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "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/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } } } }, "required": [ "type", "organizations" ], "patternProperties": { "^(?!(?:type|organizations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "organizations" ] } } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedOrganizations": { "type": "array", "items": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "organizationId", "organizationName", "blockedAt" ], "patternProperties": { "^(?!(?:organizationId|organizationName|blockedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "blockedAt" ] } } }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|description|access|prefix|blockedOrganizations|expiresAt|lastUsedAt|lastRotatedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ] } } } }, "required": [ "apiKeys" ], "patternProperties": { "^(?!(?:apiKeys)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "apiKeys" ] } ] } }, { "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": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "access": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "full" ] } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "type" ] } ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "restricted" ] } ] }, "organizations": { "type": "array", "items": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "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/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } } } }, "required": [ "type", "organizations" ], "patternProperties": { "^(?!(?:type|organizations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "organizations" ] } } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedOrganizations": { "type": "array", "items": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "organizationId", "organizationName", "blockedAt" ], "patternProperties": { "^(?!(?:organizationId|organizationName|blockedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "blockedAt" ] } } }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|description|access|prefix|blockedOrganizations|expiresAt|lastUsedAt|lastRotatedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "apiKeys": { "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": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "access": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "full" ] } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "type" ] } ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "restricted" ] } ] }, "organizations": { "type": "array", "items": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "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/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } } } }, "required": [ "type", "organizations" ], "patternProperties": { "^(?!(?:type|organizations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "organizations" ] } } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedOrganizations": { "type": "array", "items": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "organizationId", "organizationName", "blockedAt" ], "patternProperties": { "^(?!(?:organizationId|organizationName|blockedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "blockedAt" ] } } }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|description|access|prefix|blockedOrganizations|expiresAt|lastUsedAt|lastRotatedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ] } } } }, "required": [ "apiKeys" ], "patternProperties": { "^(?!(?:apiKeys)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "apiKeys" ] } ] } }, { "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": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "access": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "full" ] } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "type" ] } ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "restricted" ] } ] }, "organizations": { "type": "array", "items": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "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/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } } } }, "required": [ "type", "organizations" ], "patternProperties": { "^(?!(?:type|organizations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "organizations" ] } } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedOrganizations": { "type": "array", "items": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "organizationId", "organizationName", "blockedAt" ], "patternProperties": { "^(?!(?:organizationId|organizationName|blockedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "blockedAt" ] } } }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|description|access|prefix|blockedOrganizations|expiresAt|lastUsedAt|lastRotatedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `personalApiKeys.list`: `GET /v1/me/api-keys` - `personalApiKeys.get`: `GET /v1/me/api-keys/:apiKeyId`