get_workspace
Get buyer workspace
Get an active buyer workspace, its next buyer-visible task, its continuation path, and the immutable listing receipt needed for later comp or draft actions.
- Effect
- Read
- Required scopes
workspace:read- Workflow stages
- closing, discovery, offer, research, transaction
- Data classes
- transaction
- Operation cost
- 1 weighted units; additional domain limits may apply.
- Configurations
- Standard, Buyer UI v2
- Muse proposal
- Read. Retrieves or computes authorized information; consult the tool contract for its scopes and result. Meta makes the final classification during review.
Buyer approval and signing controls apply in addition to the scopes above. Read error and retry guidance before implementing recovery.
Input and output contracts
Returns structured content and a JSON text content block. Live discovery may compact a large output schema; execution validates the full contract below.
Input fields
Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.
| Field | Required | Meaning and constraints |
|---|---|---|
workspaceIdstring | Yes | Format: uuid. Pattern validation applies; see the raw schema. |
Output fields
Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.
| Field | Required | Meaning and constraints | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
schemaVersionstring | Yes | Must be "1". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
workspaceobject | Yes | Extra fields are not allowed. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
workspace: nested contract
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Raw input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"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|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"workspaceId"
],
"additionalProperties": false
}Full output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"schemaVersion": {
"type": "string",
"const": "1"
},
"workspace": {
"type": "object",
"properties": {
"address": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "null"
}
]
},
"city": {
"anyOf": [
{
"type": "string",
"maxLength": 300
},
{
"type": "null"
}
]
},
"lifecycle": {
"type": "string",
"enum": [
"research",
"offer_draft"
]
},
"listPrice": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"revision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"const": "active"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"workspaceId": {
"type": "string",
"format": "uuid",
"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|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"applicableActions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"effect": {
"type": "string",
"enum": [
"read",
"write"
]
},
"operation": {
"type": "string",
"enum": [
"analyze_comps",
"create_initial_offer_draft",
"create_transaction_contact",
"create_transaction_custom_task",
"get_offer_draft",
"get_transaction_document_text",
"get_transaction_email_draft",
"get_transaction_context",
"inspect_offer_package",
"list_transaction_contacts",
"list_transaction_counters",
"list_transaction_documents",
"list_transaction_email_drafts",
"list_transaction_events",
"list_transaction_messages",
"save_home",
"update_transaction_contact",
"update_transaction_custom_task",
"update_transaction_email_draft",
"update_offer_package",
"update_offer_draft_terms"
]
},
"requiredScope": {
"type": "string",
"enum": [
"workspace:read",
"research:read",
"documents:read",
"documents:write",
"workspace:write",
"offers:confirm",
"communications:send",
"transaction:confirm"
]
}
},
"required": [
"effect",
"operation",
"requiredScope"
],
"additionalProperties": false
}
},
"compResearch": {
"anyOf": [
{
"type": "object",
"properties": {
"selectedCompCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"supportedValue": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"verifiedCompCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"selectedCompCount",
"supportedValue",
"verifiedCompCount"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"continuationPath": {
"type": "string",
"maxLength": 1000,
"pattern": "^\\/(?!\\/)"
},
"currentStep": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"listingId": {
"type": "string",
"format": "uuid",
"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|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"needsBuyerAction": {
"type": "boolean"
},
"nextTask": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"title": {
"type": "string",
"maxLength": 500
}
},
"required": [
"id",
"title"
],
"additionalProperties": false
},
{
"type": "null"
}
]
}
},
"required": [
"address",
"city",
"lifecycle",
"listPrice",
"revision",
"status",
"updatedAt",
"workspaceId",
"applicableActions",
"compResearch",
"continuationPath",
"currentStep",
"listingId",
"needsBuyerAction",
"nextTask"
],
"additionalProperties": false
}
},
"required": [
"schemaVersion",
"workspace"
],
"additionalProperties": false
}Tool annotations
{
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": true
}Reference 00e5441a095c7e20. Download the full catalog.