Using Agreements

Get input history

Returns recorded input submissions for the agreement. Use this to inspect what events have been submitted.

get/v0/agreements/{id}/inputs

Request

  • Base URL: https://test-api.shodai.network
  • URL: https://test-api.shodai.network/v0/agreements/{id}/inputs
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

idstring required

Agreement ID or deployed agreement address.

Query parameters

userIdstring

Optional platform user ID filter.

inputIdstring

Optional agreement input ID filter.

status'PENDING' | 'FINALIZED' | 'FAILED'

Optional input submission status filter.

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.

limitinteger

Maximum number of records to return.

cursorstring

Opaque cursor returned by a previous list response.

sort[createdAt]'asc' | 'desc'

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

sort[updatedAt]'asc' | 'desc'

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

Response

Paged cached input records.

Example response

{
  "data": [
    {
      "agreementId": "agr_123",
      "agreementAddress": "0x3333333333333333333333333333333333333333",
      "chainId": 59141,
      "inputId": "submitInitialPaymentProof",
      "txHash": "0x4444444444444444444444444444444444444444444444444444444444444444",
      "payload": "0x...",
      "values": {
        "paymentReference": "wire-2026-04-27-001"
      },
      "status": "FINALIZED",
      "createdAt": "2026-04-27T16:10:00.000Z",
      "updatedAt": "2026-04-27T16:11:00.000Z"
    }
  ],
  "pageInfo": {
    "limit": 25
  },
  "meta": {
    "apiVersion": "v0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.