---
title: "Get input history"
method: GET
path: "/v0/agreements/{id}/inputs"
tags: ["Using Agreements"]
---

# Get input history

`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

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

## Path parameters

- `id` string, required

## Query parameters

- `userId` string
- `inputId` string
- `status` 'PENDING' | 'FINALIZED' | 'FAILED'
- `createdAt[gt]` string, date-time
- `createdAt[gte]` string, date-time
- `createdAt[lt]` string, date-time
- `createdAt[lte]` string, date-time
- `updatedAt[gt]` string, date-time
- `updatedAt[gte]` string, date-time
- `updatedAt[lt]` string, date-time
- `updatedAt[lte]` string, date-time
- `limit` integer
- `cursor` string
- `sort[createdAt]` 'asc' | 'desc'
- `sort[updatedAt]` 'asc' | 'desc'

## Response `200`

Paged cached input records.

- object
  - `data` AgreementInputRecord[], required
    - `submissionId` string: Stable API submission identity, when CNS submitted the transaction.
    - `operationLifecycle` 'intent_recorded' | 'transaction_ready' | 'confirmed' | 'completed' | 'failed': Durable permit-operation lifecycle.
    - `agreementId` string, required: Hosted agreement record ID associated with this input.
    - `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.
    - `userId` string: Platform user ID associated with the submission, when available.
    - `blockNumber` integer: Block number for the mined input transaction, when available.
    - `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.
    - `error` string: Error message when the input submission failed.
    - `createdAt` string, date-time, required: Input record creation timestamp.
    - `updatedAt` string, date-time, required: Input record update timestamp.
    - `status` 'PENDING' | 'FINALIZED' | 'FAILED', required: Input submission status.
  - `pageInfo` PageInfo, required
    - `limit` integer, required
    - `nextCursor` string, nullable, required
    - `totalCount` integer: Total number of matching records when available.
  - `meta` ResponseMeta, required
    - `apiVersion` string, required
    - `requestId` string, required: Correlation ID for support and debugging.

## Other responses

- `401`: Missing or invalid API credential.
- `402`: The authenticated Shodai account has paid_required entitlement mode for the requested scope. Per-call x402 settlement is not implemented. Treat this as an entitlement/operator issue.
- `403`: The credential lacks the required OAuth scope, the account lacks entitlement, or the account cannot access the resource.
- `404`: Agreement not found.

---

[API](https://skmtc.dev/shodai/apis/agreements-api.md) · [All operations](https://skmtc.dev/shodai/apis/agreements-api/llms.txt) · [OpenAPI document](https://skmtc.dev/shodai/apis/agreements-api/revisions/0ac329d0e9a0?raw)