list_transaction_documents

List transaction documents

List buyer-visible documents for a saved home or an offer transaction, ended ones included (a listing agent's attachments arrive before any offer exists), including safe citation metadata and extraction status, newest first over the product's window of the 100 most recent. A long transaction outgrows one result, so narrow it: limit (1 to 100), since (an ISO date-time; only documents added from then on), source (one source such as buyer_upload or inbound_attachment), or query (a phrase the filename or label contains); the page block says how many matched and whether older documents may exist beyond the window. It excludes storage paths, download tokens, signing secrets, internal records, and deleted documents.

Effect: Read
Required scopes: documents:read
Workflow stages: closing, offer, transaction
Data classes: documents, 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
`limit`integer	No	Minimum: 1. Maximum: 100.
`query`string	No	Minimum characters: 1. Maximum characters: 120.
`since`string	No	Format: date-time. Pattern validation applies; see the raw schema.
`source`string	No	Pattern validation applies; see the raw schema.
`workspaceId`string	Yes	Pattern validation applies; see the raw schema.

Output fields

Field Required Meaning and constraints

documentsarray<object>

Yes

Maximum items: 100.

documents: nested contract

Array item contract

Extra fields are not allowed.

Field Required Meaning and constraints

citationobject

Yes

Extra fields are not allowed.

citation: nested contract

Field	Required	Meaning and constraints
`documentId`string	Yes	Pattern validation applies; see the raw schema.
`filename`string \| null	Yes	Must match at least one alternative.
filename: nested contract Alternative 1: string Maximum characters: 2000. Alternative 2: null
`label`string \| null	Yes	Must match at least one alternative.
label: nested contract Alternative 1: string Maximum characters: 2000. Alternative 2: null
`pageCount`integer \| null	Yes	Must match at least one alternative.
pageCount: nested contract Alternative 1: integer Maximum: 100000. Greater than: 0. Alternative 2: null

contentTypestring

Yes

Maximum characters: 200.

Pattern validation applies; see the raw schema.

createdAtstring | null

Yes

Must match at least one alternative.

createdAt: nested contract

Alternative 1: string

Format: date-time. Pattern validation applies; see the raw schema.

Alternative 2: null

documentIdstring

Yes

Pattern validation applies; see the raw schema.

extractionobject

Yes

Extra fields are not allowed.

extraction: nested contract

Field	Required	Meaning and constraints
`confidence`number \| null	Yes	Must match at least one alternative.
confidence: nested contract Alternative 1: number Minimum: 0. Maximum: 1. Alternative 2: null
`extractedAt`string \| null	Yes	Must match at least one alternative.
extractedAt: nested contract Alternative 1: string Format: date-time. Pattern validation applies; see the raw schema. Alternative 2: null
`status`string	Yes	Allowed: "completed", "disabled", "failed", "pending", "processing", "queued", "too_large", "unknown", "unsupported".
`textAvailable`boolean	Yes	No additional description in the contract.
`textSource`string \| null	Yes	Must match at least one alternative.
textSource: nested contract Alternative 1: string Allowed: "native_pdf", "native_text", "openai_file", "openai_vision", "unknown". Alternative 2: null
`warning`string \| null	No	Must match at least one alternative.
warning: nested contract Alternative 1: string Maximum characters: 400. Alternative 2: null

sizeBytesinteger | null

Yes

Must match at least one alternative.

sizeBytes: nested contract

Alternative 1: integer

Minimum: 0. Maximum: 1000000000.

Alternative 2: null

sourcestring

Yes

Maximum characters: 120.

Pattern validation applies; see the raw schema.

updatedAtstring | null

Yes

Must match at least one alternative.

updatedAt: nested contract

Alternative 1: string

Format: date-time. Pattern validation applies; see the raw schema.

Alternative 2: null

pageobject

Yes

Extra fields are not allowed.

page: nested contract

Field	Required	Meaning and constraints
`limit`integer	Yes	Minimum: 1. Maximum: 100.
`matched`integer	Yes	Minimum: 0. Maximum: 9007199254740991.
`olderMayExist`boolean	Yes	No additional description in the contract.
`returned`integer	Yes	Minimum: 0. Maximum: 9007199254740991.

schemaVersionstring

Yes

Must be "1".

workspaceIdstring

Yes

Pattern validation applies; see the raw schema.

Raw input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "since": {
      "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)))$"
    },
    "source": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_-]{0,119}$"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "workspaceId"
  ],
  "additionalProperties": false
}

Full output schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "documents": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "citation": {
            "type": "object",
            "properties": {
              "documentId": {
                "type": "string",
                "pattern": "^[A-Za-z0-9_-]{1,200}$"
              },
              "filename": {
                "anyOf": [
                  {
                    "type": "string",
                    "maxLength": 2000
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "label": {
                "anyOf": [
                  {
                    "type": "string",
                    "maxLength": 2000
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "pageCount": {
                "anyOf": [
                  {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 100000
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "documentId",
              "filename",
              "label",
              "pageCount"
            ],
            "additionalProperties": false
          },
          "contentType": {
            "type": "string",
            "maxLength": 200,
            "pattern": "^[a-z0-9.+-]+\\/[a-z0-9.+-]+$"
          },
          "createdAt": {
            "anyOf": [
              {
                "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)))$"
              },
              {
                "type": "null"
              }
            ]
          },
          "documentId": {
            "type": "string",
            "pattern": "^[A-Za-z0-9_-]{1,200}$"
          },
          "extraction": {
            "type": "object",
            "properties": {
              "confidence": {
                "anyOf": [
                  {
                    "type": "number",
                    "minimum": 0,
                    "maximum": 1
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "extractedAt": {
                "anyOf": [
                  {
                    "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)))$"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "status": {
                "type": "string",
                "enum": [
                  "completed",
                  "disabled",
                  "failed",
                  "pending",
                  "processing",
                  "queued",
                  "too_large",
                  "unknown",
                  "unsupported"
                ]
              },
              "textAvailable": {
                "type": "boolean"
              },
              "textSource": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "native_pdf",
                      "native_text",
                      "openai_file",
                      "openai_vision",
                      "unknown"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "warning": {
                "anyOf": [
                  {
                    "type": "string",
                    "maxLength": 400
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "confidence",
              "extractedAt",
              "status",
              "textAvailable",
              "textSource"
            ],
            "additionalProperties": false
          },
          "sizeBytes": {
            "anyOf": [
              {
                "type": "integer",
                "minimum": 0,
                "maximum": 1000000000
              },
              {
                "type": "null"
              }
            ]
          },
          "source": {
            "type": "string",
            "maxLength": 120,
            "pattern": "^[a-z][a-z0-9_-]{0,119}$"
          },
          "updatedAt": {
            "anyOf": [
              {
                "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)))$"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "citation",
          "contentType",
          "createdAt",
          "documentId",
          "extraction",
          "sizeBytes",
          "source",
          "updatedAt"
        ],
        "additionalProperties": false
      }
    },
    "page": {
      "type": "object",
      "properties": {
        "limit": {
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "matched": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "olderMayExist": {
          "type": "boolean"
        },
        "returned": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "limit",
        "matched",
        "olderMayExist",
        "returned"
      ],
      "additionalProperties": false
    },
    "schemaVersion": {
      "type": "string",
      "const": "1"
    },
    "workspaceId": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,200}$"
    }
  },
  "required": [
    "documents",
    "page",
    "schemaVersion",
    "workspaceId"
  ],
  "additionalProperties": false
}

Tool annotations

{
  "destructiveHint": false,
  "idempotentHint": true,
  "openWorldHint": false,
  "readOnlyHint": true
}

Reference 00e5441a095c7e20. Download the full catalog.