Lists agreement records visible to the current API key. Supports an optional status filter.
UseDocumentation Index
Fetch the complete documentation index at: https://docs.shodai.network/llms.txt
Use this file to discover all available pages before exploring further.
client.listAgreements(...) when integrating with the TypeScript SDK.API key. Send this value in the X-API-Key request header.
Optional agreement status filter.
Draft, Deployed Agreement records visible to the current API key.
Agreement record ID.
Chain ID for the deployed agreement.
Agreement record status.
Draft, Deployed Authored agreement JSON.
Record update timestamp.
Record creation timestamp.
Human-readable record label.
Deployed agreement address, when deployed.
Most recent submitted input ID, when available.
Time of the most recent submitted input, when available.
Cached agreement state, when available.
Current stored agreement values.
Wallet address associated with hosted record ownership.
Optional document URI associated with the deployed agreement.
Wallet addresses associated with agreement activity.
Participants associated with agreement participant variables.
Observer email addresses associated with the agreement record.
On-chain agreement data when available.