Skip to main content
GET
/
v0
/
agreements
/
{id}
/
inputs
cURL
curl --request GET \
  --url https://test-api.shodai.network/v0/agreements/{id}/inputs \
  --header 'X-API-Key: <api-key>'
[
  {
    "agreementAddress": "0x3333333333333333333333333333333333333333",
    "chainId": 59141,
    "inputId": "submitInitialPaymentProof",
    "txHash": "0x4444444444444444444444444444444444444444444444444444444444444444",
    "payload": "0x...",
    "values": {
      "paymentReference": "wire-2026-04-27-001"
    },
    "status": "MINED",
    "createdAt": "2026-04-27T16:10:00.000Z",
    "updatedAt": "2026-04-27T16:11:00.000Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.shodai.network/llms.txt

Use this file to discover all available pages before exploring further.

Use client.listAgreementInputs(...) to inspect submitted events before deciding the next lifecycle action.

Authorizations

​
X-API-Key
string
header
default:YOUR_API_KEY
required

API key. Send this value in the X-API-Key request header.

Path Parameters

​
id
string
required

Agreement ID or deployed agreement address.

Query Parameters

​
userId
string

Optional platform user ID filter.

Response

Cached input records.

​
agreementAddress
string
required

Deployed agreement address associated with this input.

​
chainId
integer
required

Chain ID for the deployed agreement.

​
inputId
string
required

Input ID submitted to the agreement.

​
payload
string
required

Encoded input payload retained by the API.

​
values
object
required

Business values submitted with the input.

​
txHash
string
required

Transaction hash for the input submission.

​
createdAt
string<date-time>
required

Input record creation timestamp.

​
updatedAt
string<date-time>
required

Input record update timestamp.

​
status
enum<string>
required

Input submission status.

Available options:
PENDING,
MINED,
FAILED
​
userId
string

Platform user ID associated with the submission, when available.

​
blockNumber
integer

Block number for the mined input transaction, when available.

​
error
string

Error message when the input submission failed.