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>'
{
  "data": [
    {
      "agreementId": "agr_123",
      "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"
    }
  ],
  "pageInfo": {
    "limit": 25,
    "nextCursor": null,
    "totalCount": 1
  },
  "meta": {
    "apiVersion": "v0",
    "requestId": "req_123"
  }
}
Use client.listAgreementInputs(...) to inspect submitted events before deciding the next lifecycle action.

Authorizations

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

Canonical API-key credential. Send X-API-Key: cns_pk_..., or Authorization: Bearer cns_pk_... only as an API-key compatibility alias. OAuth and JWT bearer tokens are not supported.

Path Parameters

​
id
string
required

Agreement ID or deployed agreement address.

Query Parameters

​
userId
string

Optional platform user ID filter.

​
inputId
string

Optional agreement input ID filter.

​
status
enum<string>

Optional input submission status filter.

Available options:
PENDING,
MINED,
FAILED
​
createdAt[gt]
string<date-time>

Include records with createdAt greater than this timestamp.

​
createdAt[gte]
string<date-time>

Include records with createdAt greater than or equal to this timestamp.

​
createdAt[lt]
string<date-time>

Include records with createdAt less than this timestamp.

​
createdAt[lte]
string<date-time>

Include records with createdAt less than or equal to this timestamp.

​
updatedAt[gt]
string<date-time>

Include records with updatedAt greater than this timestamp.

​
updatedAt[gte]
string<date-time>

Include records with updatedAt greater than or equal to this timestamp.

​
updatedAt[lt]
string<date-time>

Include records with updatedAt less than this timestamp.

​
updatedAt[lte]
string<date-time>

Include records with updatedAt less than or equal to this timestamp.

​
limit
integer
default:25

Maximum number of records to return.

Required range: 1 <= x <= 100
​
cursor
string

Opaque cursor returned by a previous list response.

​
sort[createdAt]
enum<string>
default:desc

Sort by createdAt. Only one sort field may be supplied.

Available options:
asc,
desc
​
sort[updatedAt]
enum<string>

Sort by updatedAt. Only one sort field may be supplied.

Available options:
asc,
desc

Response

Paged cached input records.

​
data
object[]
required
​
pageInfo
object
required
​
meta
object
required