get_co_buyer_signing_state
Check co-buyer signing status
Read where the co-buyer's signature stands on whatever document is waiting for them: the document, the co-buyer's name and email, whether they have viewed, verified, signed, declined, or let the link expire, when they were last invited, when the link expires, and whether another invite can be sent. Reports 'none' when the offer has no co-buyer or nothing awaits them.
- Effect
- Read
- Required scopes
workspace:read- Workflow stages
- closing, offer, transaction
- Data classes
- contacts, documents, offer, signing
- 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 | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
coBuyerobject | Yes | Extra fields are not allowed. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
coBuyer: nested contract
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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": {
"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": {
"coBuyer": {
"type": "object",
"properties": {
"canResend": {
"type": "boolean"
},
"coBuyerEmail": {
"anyOf": [
{
"type": "string",
"maxLength": 320,
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$"
},
{
"type": "null"
}
]
},
"coBuyerName": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"documentKind": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"documentLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"envelopeStatus": {
"anyOf": [
{
"type": "string",
"enum": [
"awaiting_co_buyer",
"completing",
"completed",
"voided"
]
},
{
"type": "null"
}
]
},
"inviteSendCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"inviteSendLimit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"lastInviteAt": {
"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"
}
]
},
"linkExpiresAt": {
"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"
}
]
},
"signerStatus": {
"type": "string",
"enum": [
"none",
"sent",
"viewed",
"verified",
"signed",
"declined",
"expired"
]
}
},
"required": [
"canResend",
"coBuyerEmail",
"coBuyerName",
"documentKind",
"documentLabel",
"envelopeStatus",
"inviteSendCount",
"inviteSendLimit",
"lastInviteAt",
"linkExpiresAt",
"signerStatus"
],
"additionalProperties": false
},
"schemaVersion": {
"type": "string",
"const": "1"
},
"workspaceId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,200}$"
}
},
"required": [
"coBuyer",
"schemaVersion",
"workspaceId"
],
"additionalProperties": false
}Tool annotations
{
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": true
}Reference 00e5441a095c7e20. Download the full catalog.