# 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_own_identity Read the caller's own credential, permission split, session, and selected-workspace context. Call first to learn which principal and selected workspace the credential resolves to. Never returns secrets or provider identifiers; do not probe for them. Scopes: workspace:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "whoami" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "session" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaceCount" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listWorkspaces" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "activeWorkspace" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listInvitations" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "invitationPreview" ] } ] }, "token": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "view", "token" ], "patternProperties": { "^(?!(?:view|token)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "token" ] } } ], "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ReadOwnIdentityInput": { "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "whoami" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "session" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaceCount" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listWorkspaces" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "activeWorkspace" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listInvitations" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "invitationPreview" ] } ] }, "token": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "view", "token" ], "patternProperties": { "^(?!(?:view|token)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "token" ] } } ] } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "whoami" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "session" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaceCount" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listWorkspaces" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "activeWorkspace" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listInvitations" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "invitationPreview" ] } ] }, "token": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "view", "token" ], "patternProperties": { "^(?!(?:view|token)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "token" ] } } ], "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ReadOwnIdentityInput": { "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "whoami" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "session" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaceCount" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listWorkspaces" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "activeWorkspace" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listInvitations" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "invitationPreview" ] } ] }, "token": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "view", "token" ], "patternProperties": { "^(?!(?:view|token)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "token" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "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$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "WorkspaceRoleSlug": { "type": "string", "minLength": 1, "maxLength": 128 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "MaskedEmail": { "type": "string", "pattern": "^[a-z]\\*\\*\\*@[^\\s]+$" }, "ReadOwnIdentityOutput": { "anyOf": [ { "type": "object", "properties": { "authMethod": { "type": "string", "enum": [ "api_key", "session", "workos_agent" ] }, "organization": { "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/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "slug", "logo", "createdAt" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt" ] } }, "credential": { "anyOf": [ { "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" }, "permissions": { "type": "object", "additionalProperties": true } }, "required": [ "id", "permissions" ], "patternProperties": { "^(?!(?:id|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "permissions" ] } }, { "type": "null" } ] }, "agent": { "anyOf": [ { "type": "object", "properties": { "registrationId": { "$ref": "#/$defs/OpaqueId" }, "kind": { "$ref": "#/$defs/ShortText" }, "actorUserId": { "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" }, "permissions": { "type": "object", "additionalProperties": true } }, "required": [ "registrationId", "kind", "actorUserId", "permissions" ], "patternProperties": { "^(?!(?:registrationId|kind|actorUserId|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "registrationId", "kind", "actorUserId", "permissions" ] } }, { "type": "null" } ] }, "mcpGrant": { "anyOf": [ { "type": "object", "properties": { "grantId": { "$ref": "#/$defs/OpaqueId" }, "scopes": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "bundles": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } } }, "required": [ "grantId", "scopes", "bundles" ], "patternProperties": { "^(?!(?:grantId|scopes|bundles)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "grantId", "scopes", "bundles" ] } }, { "type": "null" } ] } }, "required": [ "authMethod", "organization", "credential", "agent", "mcpGrant" ], "patternProperties": { "^(?!(?:authMethod|organization|credential|agent|mcpGrant)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authMethod", "organization", "credential", "agent", "mcpGrant" ] } }, { "type": "object", "properties": { "authMethod": { "type": "string", "enum": [ "api_key", "session", "workos_agent" ] }, "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" }, "credentialId": { "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" } ] }, "agentRegistrationId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "selectedPermissions": { "type": "object", "additionalProperties": true }, "unselectedPermissions": { "type": "object", "additionalProperties": true } }, "required": [ "authMethod", "organizationId", "credentialId", "agentRegistrationId", "selectedPermissions", "unselectedPermissions" ], "patternProperties": { "^(?!(?:authMethod|organizationId|credentialId|agentRegistrationId|selectedPermissions|unselectedPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authMethod", "organizationId", "credentialId", "agentRegistrationId", "selectedPermissions", "unselectedPermissions" ] } }, { "type": "object", "properties": { "authMethod": { "type": "string", "enum": [ "api_key", "session", "workos_agent" ] }, "principalKind": { "type": "string", "enum": [ "human", "agent", "personal_api_key" ] }, "user": { "anyOf": [ { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "hasCompletedOnboarding": { "type": "boolean" } }, "required": [ "id", "name", "email", "image", "hasCompletedOnboarding" ], "patternProperties": { "^(?!(?:id|name|email|image|hasCompletedOnboarding)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "email", "image", "hasCompletedOnboarding" ] } }, { "type": "null" } ] }, "activeWorkspaceId": { "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" } ] } }, "required": [ "authMethod", "principalKind", "user", "activeWorkspaceId" ], "patternProperties": { "^(?!(?:authMethod|principalKind|user|activeWorkspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authMethod", "principalKind", "user", "activeWorkspaceId" ] } }, { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } }, { "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/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "role": { "$ref": "#/$defs/WorkspaceRoleSlug" }, "customerOrganizationId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "id", "name", "slug", "logo", "createdAt" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt|role|customerOrganizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt", "role", "customerOrganizationId" ] } } }, { "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/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "enabledFeatures": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "customerOrganizationId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "canManageOrganizationMembers": { "type": "boolean" }, "members": { "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" }, "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" }, "role": { "$ref": "#/$defs/WorkspaceRoleSlug" }, "workspaceAccess": { "type": "string", "enum": [ "selected", "all" ] }, "canWidenToAll": { "type": "boolean" }, "parentMembershipId": { "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" } ] }, "workspaceMembershipId": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "user": { "type": "object", "properties": { "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] } }, "required": [ "name", "email", "image" ], "patternProperties": { "^(?!(?:name|email|image)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "email", "image" ] } } }, "required": [ "id", "userId", "role", "workspaceAccess", "canWidenToAll", "workspaceMembershipId", "createdAt", "user" ], "patternProperties": { "^(?!(?:id|userId|role|workspaceAccess|canWidenToAll|parentMembershipId|workspaceMembershipId|createdAt|user)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "userId", "role", "workspaceAccess", "canWidenToAll", "parentMembershipId", "workspaceMembershipId", "createdAt", "user" ] } } } }, "required": [ "id", "name", "slug", "logo", "createdAt", "enabledFeatures", "customerOrganizationId", "canManageOrganizationMembers", "members" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt|metadata|enabledFeatures|customerOrganizationId|canManageOrganizationMembers|members)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt", "metadata", "enabledFeatures", "customerOrganizationId", "canManageOrganizationMembers", "members" ] } }, { "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" }, "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "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": { "$ref": "#/$defs/ShortText" }, "inviterName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "organization", "allWorkspaces", "workspace" ] }, "name": { "$ref": "#/$defs/ShortText" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "kind", "name", "roles" ], "patternProperties": { "^(?!(?:kind|name|roles)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "name", "roles" ] } } } }, "required": [ "id", "email", "status", "expiresAt", "organizationId", "organizationName", "inviterName", "targets" ], "patternProperties": { "^(?!(?:id|email|status|expiresAt|organizationId|organizationName|inviterName|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "email", "status", "expiresAt", "organizationId", "organizationName", "inviterName", "targets" ] } } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "organizationName": { "$ref": "#/$defs/ShortText" }, "inviterName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "maskedEmail": { "$ref": "#/$defs/MaskedEmail" }, "isExpired": { "type": "boolean" }, "isForCurrentUser": { "type": "boolean" }, "targets": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "organization", "allWorkspaces", "workspace" ] }, "name": { "$ref": "#/$defs/ShortText" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "kind", "name", "roles" ], "patternProperties": { "^(?!(?:kind|name|roles)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "name", "roles" ] } } } }, "required": [ "status", "expiresAt", "organizationName", "inviterName", "maskedEmail", "isExpired", "isForCurrentUser", "targets" ], "patternProperties": { "^(?!(?:status|expiresAt|organizationName|inviterName|maskedEmail|isExpired|isForCurrentUser|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "expiresAt", "organizationName", "inviterName", "maskedEmail", "isExpired", "isForCurrentUser", "targets" ] } } ] } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/ReadOwnIdentityOutput" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/ReadOwnIdentityOutput" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `me.whoami`: `GET /v1/me` - `me.permissions`: `GET /v1/me/permissions` - `me.session`: `GET /v1/me/session` - `me.workspaceCount`: `GET /v1/me/workspace-count` - `me.listWorkspaces`: `GET /v1/me/workspaces` - `me.activeWorkspace`: `GET /v1/me/active-workspace` - `me.listInvitations`: `GET /v1/me/invitations` - `me.invitationPreview`: `GET /v1/me/invitations/preview`