Skip to main content
GET
/
v0
/
agreements
cURL
curl --request GET \
  --url https://test-api.shodai.network/v0/agreements \
  --header 'X-API-Key: <api-key>'
{
  "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,
    "nextCursor": null,
    "totalCount": 1
  },
  "meta": {
    "apiVersion": "v0",
    "requestId": "req_123"
  }
}
Use client.listAgreements(...) when integrating with the TypeScript SDK.

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.

Query Parameters

​
state
string

Optional current agreement state filter.

​
chainId
integer

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.

​
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
​
sort[displayName]
enum<string>

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

Available options:
asc,
desc

Response

Paged agreement summaries visible to the current API key.

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