Agreement Records

List agreements

Lists agreement summaries visible to the authenticated Shodai account. Supports pagination, filtering, and sorting.

get/v0/agreements

Request

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

Query parameters

statestring

Optional current agreement state filter.

chainIdinteger

Optional deployed agreement chain filter. Use when the environment contains agreements across more than one supported chain.

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.

sort[displayName]'asc' | 'desc'

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

Response

Paged agreement summaries visible to the authenticated Shodai account.

Example response

{
  "data": [
    {
      "id": "agr_123",
      "address": "0x3333333333333333333333333333333333333333",
      "chainId": 59141,
      "displayName": "Advisory Retainer",
      "status": "Deployed",
      "state": "AWAITING_PAYMENT",
      "templateId": "did:template:service-retainer-v0-1",
      "lastInputId": "submitInitialPaymentProof",
      "lastInputAt": "2026-04-27T16:10:00.000Z",
      "owner": "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "documentId": "7b0f6c2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d",
      "docUri": "https://test-api.shodai.network/v0/agreements/documents/7b0f6c2d-3e4f-4a5b-8c9d-0e1f2a3b4c5d",
      "createdAt": "2026-04-27T16:00:00.000Z",
      "updatedAt": "2026-04-27T16:05:00.000Z"
    }
  ],
  "pageInfo": {
    "limit": 25
  },
  "meta": {
    "apiVersion": "v0"
  }
}

Changes

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