Use client.listAgreements(...) when integrating with the TypeScript SDK.
Authorizations
ApiKeyAuthOAuthBearerAuth
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.
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 authenticated Shodai account.
data
object[]
required
Show child attributes
pageInfo
object
required
Show child attributes
meta
object
required
Show child attributes
Was this page helpful?
⌘I
{"docsConfig":{"theme":"linden","$schema":"https://mintlify.com/docs.json","name":"Shodai Developer Documentation","description":"Agreements API documentation for first-run TypeScript SDK and MCP integrations, agreement JSON authoring, deployment preflight, EIP-712 signing, deployment, and signed input submission.","colors":{"primary":"#73766C","light":"#DAE5C5","dark":"#73766C"},"logo":{"light":"https://mintcdn.com/cnslabs/QoBo9wst-a7Wya5g/images/shodai-logo-light.svg?fit=max\u0026auto=format\u0026n=QoBo9wst-a7Wya5g\u0026q=85\u0026s=3bb56ed1b8eacd010dd50bd09c6da976","dark":"https://mintcdn.com/cnslabs/QoBo9wst-a7Wya5g/images/shodai-logo-dark.svg?fit=max\u0026auto=format\u0026n=QoBo9wst-a7Wya5g\u0026q=85\u0026s=913c7e9ced0751b39a48765a8554748b","href":"https://docs.shodai.network/"},"favicon":"https://mintcdn.com/cnslabs/QoBo9wst-a7Wya5g/images/shodai-favicon.png?fit=max\u0026auto=format\u0026n=QoBo9wst-a7Wya5g\u0026q=85\u0026s=37c6c88456d7a0af5bb167ae052cb28c","api":{"openapi":"openapi.json","params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript"],"prefill":true,"autogenerate":true},"url":"full"},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FAFFEF","dark":"#000000"}},"navbar":{"links":[{"href":"https://docs.shodai.network/","label":"Docs"},{"href":"https://docs.shodai.network/reference/api/system/get-the-openapi-document-for-the-agreements-api","label":"API Reference"},{"href":"https://developers.shodai.network/api-playground/","label":"API Playground"},{"href":"https://app.shodai.network/agreements","label":"Demo App"},{"href":"https://developers.shodai.network","label":"Dev Portal"},{"href":"https://github.com/CNSLabs","label":"GitHub"}]},"seo":{"metatags":{"og:image":"https://docs.shodai.network/images/shodai-og.png","twitter:image":"https://docs.shodai.network/images/shodai-og.png","twitter:card":"summary_large_image"}},"fonts":{"family":"Aeonik Pro","weight":400},"styling":{"eyebrows":"section","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"integrations":{"ga4":{"measurementId":"G-FYXLLRMJG0"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","grok","aistudio","devin","windsurf","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cnslabs","hasAudioNarration":false,"actualSubdomain":"cnslabs","customDomains":["docs.shodai.network"],"gitSource":{"type":"github","owner":"cnslabs","repo":"cns-service","deployBranch":"master","contentDirectory":"backend/apps/external-api/src/external-api/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"agentFeedback":false,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae955ae2422c68a7df46aff:success","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Reference","count":25},{"language":"default","tag":"API Reference","count":19},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Start","count":6},{"language":"default","tag":"Architecture","count":6},{"language":"default","tag":"Workflow","count":5},{"language":"default","tag":"Examples","count":3},{"language":"default","tag":"Using Agreements","count":3},{"language":"default","tag":"Migration guides","count":2},{"language":"default","tag":"Agreement Records","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Aeonik Pro\";src:url(\"/fonts/aeonikpro-regular.woff2\") format(\"woff2\"),\n url(\"/fonts/aeonikpro-regular.woff\") format(\"woff\");font-style:normal;font-weight:400;font-display:swap}@font-face{font-family:\"Aeonik Pro\";src:url(\"/fonts/aeonikpro-regularitalic.woff2\") format(\"woff2\"),\n url(\"/fonts/aeonikpro-regularitalic.woff\") format(\"woff\");font-style:italic;font-weight:400;font-display:swap}@font-face{font-family:\"Aeonik Pro\";src:url(\"/fonts/aeonikpro-medium.woff2\") format(\"woff2\"),\n url(\"/fonts/aeonikpro-medium.woff\") format(\"woff\");font-style:normal;font-weight:500;font-display:swap}@font-face{font-family:\"Aeonik Pro\";src:url(\"/fonts/aeonikpro-mediumitalic.woff2\") format(\"woff2\"),\n url(\"/fonts/aeonikpro-mediumitalic.woff\") format(\"woff\");font-style:italic;font-weight:500;font-display:swap}@font-face{font-family:\"Aeonik Pro\";src:url(\"/fonts/aeonikpro-semibold.woff2\") format(\"woff2\"),\n url(\"/fonts/aeonikpro-semibold.woff\") format(\"woff\");font-style:normal;font-weight:600;font-display:swap}@font-face{font-family:\"Aeonik Pro\";src:url(\"/fonts/aeonikpro-semibolditalic.woff2\") format(\"woff2\"),\n url(\"/fonts/aeonikpro-semibolditalic.woff\") format(\"woff\");font-style:italic;font-weight:600;font-display:swap}@font-face{font-family:\"Aeonik Pro\";src:url(\"/fonts/aeonikpro-semibold.woff2\") format(\"woff2\"),\n url(\"/fonts/aeonikpro-semibold.woff\") format(\"woff\");font-style:normal;font-weight:700;font-display:swap}@font-face{font-family:\"Aeonik Pro\";src:url(\"/fonts/aeonikpro-semibolditalic.woff2\") format(\"woff2\"),\n url(\"/fonts/aeonikpro-semibolditalic.woff\") format(\"woff\");font-style:italic;font-weight:700;font-display:swap}:root{--shodai-black: #000000;--shodai-canvas: #faffef;--shodai-ink-2: #575a51;--shodai-ink-3: #73766c;--shodai-section-label: #8a927d;--shodai-line: #dee6cf;--shodai-dark-ink: #dae5c5;--shodai-dark-section-label: #9aa587}[data-docs-theme=\"linden\"]{--shodai-diagram-bg: var(--shodai-canvas);--shodai-diagram-surface: color-mix(in srgb, var(--shodai-canvas) 92%, white);--shodai-diagram-surface-alt: color-mix(in srgb, var(--shodai-canvas) 86%, var(--shodai-line));--shodai-diagram-ink: var(--shodai-black);--shodai-diagram-muted: var(--shodai-ink-2);--shodai-diagram-accent: rgb(var(--primary));--shodai-diagram-line: var(--shodai-line);--shodai-diagram-connector: color-mix(in srgb, var(--shodai-ink-3) 44%, var(--shodai-line));--shodai-diagram-grid: color-mix(in srgb, var(--shodai-line) 42%, transparent);--shodai-diagram-tint-soft: color-mix(in srgb, var(--shodai-line) 28%, transparent);--shodai-diagram-tint: color-mix(in srgb, var(--shodai-line) 45%, transparent);--shodai-diagram-tint-strong: color-mix(in srgb, var(--shodai-line) 58%, transparent);--shodai-diagram-tint-stronger: color-mix(in srgb, var(--shodai-line) 70%, transparent)}.dark [data-docs-theme=\"linden\"]{--shodai-diagram-bg: var(--shodai-black);--shodai-diagram-surface: color-mix(in srgb, var(--shodai-black) 92%, var(--shodai-dark-ink));--shodai-diagram-surface-alt: color-mix(in srgb, var(--shodai-black) 88%, var(--shodai-dark-ink));--shodai-diagram-ink: var(--shodai-canvas);--shodai-diagram-muted: var(--shodai-dark-ink);--shodai-diagram-accent: rgb(var(--primary-light));--shodai-diagram-line: color-mix(in srgb, var(--shodai-dark-ink) 36%, transparent);--shodai-diagram-connector: color-mix(in srgb, var(--shodai-dark-ink) 62%, transparent);--shodai-diagram-grid: color-mix(in srgb, var(--shodai-dark-ink) 16%, transparent);--shodai-diagram-tint-soft: color-mix(in srgb, var(--shodai-dark-ink) 12%, transparent);--shodai-diagram-tint: color-mix(in srgb, var(--shodai-dark-ink) 16%, transparent);--shodai-diagram-tint-strong: color-mix(in srgb, var(--shodai-dark-ink) 20%, transparent);--shodai-diagram-tint-stronger: color-mix(in srgb, var(--shodai-dark-ink) 26%, transparent)}.shodai-diagram-frame{background:var(--shodai-diagram-bg);border-color:var(--shodai-diagram-line)}.shodai-architecture-svg{display:block;height:auto;width:100%}.shodai-state-machine-frame{color:var(--shodai-diagram-muted);background:var(--shodai-diagram-bg);border-color:var(--shodai-diagram-line)}.shodai-state-machine-shell{background:var(--shodai-diagram-surface)}.shodai-state-machine-header{color:var(--shodai-diagram-ink);background:var(--shodai-diagram-bg);border-color:var(--shodai-diagram-line)}.shodai-state-machine-title{color:var(--shodai-diagram-ink)}.shodai-state-machine-meta{color:var(--shodai-diagram-muted)}.shodai-state-machine-count{color:var(--shodai-diagram-accent);background:var(--shodai-diagram-tint-soft);border-color:var(--shodai-diagram-line)}.shodai-state-machine-canvas-bg{background:var(--shodai-diagram-surface)}.shodai-state-machine-grid-dot{fill:var(--shodai-diagram-line)}.shodai-state-machine-connector{color:var(--shodai-diagram-connector)}.shodai-state-machine-label-bg{fill:var(--shodai-diagram-bg);stroke:var(--shodai-diagram-line)}.shodai-state-machine-label-text,.shodai-state-machine-node-id{fill:var(--shodai-diagram-ink)}.shodai-state-machine-start-node{fill:var(--shodai-diagram-tint-stronger)}.shodai-state-machine-node{fill:var(--shodai-diagram-bg);color:var(--shodai-diagram-line)}.shodai-state-machine-node-name{fill:var(--shodai-diagram-muted)}.shodai-state-machine-controls{background:var(--shodai-diagram-bg);border-color:var(--shodai-diagram-line)}.shodai-state-machine-control{color:var(--shodai-diagram-ink);border-color:var(--shodai-diagram-line)}.shodai-state-machine-control:hover,.shodai-state-machine-control:focus{background:var(--shodai-diagram-tint-soft)}[data-docs-theme=\"linden\"] .navbar-link a{color:var(--shodai-ink-2)!important;font-weight:400!important}[data-docs-theme=\"linden\"] .navbar-link a:hover{color:var(--shodai-black)!important}.dark [data-docs-theme=\"linden\"] .navbar-link a{color:var(--shodai-dark-ink)!important}.dark [data-docs-theme=\"linden\"] .navbar-link a:hover{color:var(--shodai-canvas)!important}[data-docs-theme=\"linden\"] :is(h1,h2,h3,h4,h5,h6),[data-docs-theme=\"linden\"] [id=\"sidebar\"] :is(a,button,div),[data-docs-theme=\"linden\"] [id=\"sidebar-content\"] :is(a,button,div),[data-docs-theme=\"linden\"] :is(.sidebar-group,.sidebar-group-header) :is(a,button,div,h5){font-weight:400!important}[data-docs-theme=\"linden\"] :is(h1,h2,h3,h4,h5,h6),[data-docs-theme=\"linden\"] [id=\"sidebar\"] :is([class*=\"text-gray-900\"],[class*=\"text-gray-950\"]),[data-docs-theme=\"linden\"] [id=\"sidebar-content\"] :is([class*=\"text-gray-900\"],[class*=\"text-gray-950\"]),[data-docs-theme=\"linden\"] .sidebar-group-header{color:var(--shodai-black)!important}.dark [data-docs-theme=\"linden\"] :is(h1,h2,h3,h4,h5,h6),.dark [data-docs-theme=\"linden\"] [id=\"sidebar\"] :is([class*=\"text-gray-900\"],[class*=\"text-gray-950\"],[class*=\"text-gray-200\"]),.dark [data-docs-theme=\"linden\"] [id=\"sidebar-content\"] :is([class*=\"text-gray-900\"],[class*=\"text-gray-950\"],[class*=\"text-gray-200\"]),.dark [data-docs-theme=\"linden\"] .sidebar-group-header{color:var(--shodai-dark-ink)!important}[data-docs-theme=\"linden\"] :is([id=\"sidebar\"],[id=\"sidebar-content\"],.sidebar-group) :is(a,button){color:var(--shodai-ink-2)!important}[data-docs-theme=\"linden\"] :is([id=\"sidebar\"],[id=\"sidebar-content\"],.sidebar-group) :is(a,button):hover,[data-docs-theme=\"linden\"] :is([id=\"sidebar\"],[id=\"sidebar-content\"],.sidebar-group) a[aria-current=\"page\"]{color:var(--shodai-black)!important}[data-docs-theme=\"linden\"] .chat-assistant-floating-input,[data-docs-theme=\"linden\"] .chat-assistant-input,[data-docs-theme=\"linden\"] .chat-assistant-send-button{display:none!important}.dark [data-docs-theme=\"linden\"] :is([id=\"sidebar\"],[id=\"sidebar-content\"],.sidebar-group) :is(a,button){color:var(--shodai-dark-ink)!important}.dark [data-docs-theme=\"linden\"] :is([id=\"sidebar\"],[id=\"sidebar-content\"],.sidebar-group) :is(a,button):hover,.dark [data-docs-theme=\"linden\"] :is([id=\"sidebar\"],[id=\"sidebar-content\"],.sidebar-group) a[aria-current=\"page\"]{color:var(--shodai-canvas)!important}[data-docs-theme=\"linden\"] :is(a,button)[class*=\"text-gray-600\"],[data-docs-theme=\"linden\"] :is(a,button)[class*=\"text-gray-700\"]{color:var(--shodai-ink-2)!important}[data-docs-theme=\"linden\"] :is(a,button)[class*=\"hover:text-gray\"]:hover{color:var(--shodai-black)!important}[data-docs-theme=\"linden\"] :is(button,.group) svg[class*=\"bg-gray\"]{background-color:var(--shodai-ink-2)!important}[data-docs-theme=\"linden\"] :is(button,.group):hover svg[class*=\"bg-gray\"]{background-color:var(--shodai-black)!important}.dark [data-docs-theme=\"linden\"] :is(a,button)[class*=\"dark:text-gray\"]{color:var(--shodai-dark-ink)!important}.dark [data-docs-theme=\"linden\"] :is(a,button)[class*=\"dark:hover:text-gray\"]:hover{color:var(--shodai-canvas)!important}.dark [data-docs-theme=\"linden\"] :is(button,.group) svg[class*=\"bg-gray\"]{background-color:var(--shodai-dark-ink)!important}.dark [data-docs-theme=\"linden\"] :is(button,.group):hover svg[class*=\"bg-gray\"]{background-color:var(--shodai-canvas)!important}[data-docs-theme=\"linden\"] :is([id=\"sidebar\"],[id=\"sidebar-content\"]) :is(h5,.sidebar-group-header){color:var(--shodai-section-label)!important}.dark [data-docs-theme=\"linden\"] :is([id=\"sidebar\"],[id=\"sidebar-content\"]) :is(h5,.sidebar-group-header){color:var(--shodai-dark-section-label)!important}[data-docs-theme=\"linden\"] footer{color:var(--shodai-ink-2)!important}[data-docs-theme=\"linden\"] a[href=\"/sdks/quickstart-with-typescript-sdk\"][class*=\"border\"],[data-docs-theme=\"linden\"] footer a[class*=\"border\"]{color:rgb(var(--primary))!important}.dark [data-docs-theme=\"linden\"] footer{color:var(--shodai-dark-ink)!important}.dark [data-docs-theme=\"linden\"] a[href=\"/sdks/quickstart-with-typescript-sdk\"][class*=\"border\"],.dark [data-docs-theme=\"linden\"] footer a[class*=\"border\"]{color:rgb(var(--primary-light))!important}"}]}
{"page":{"pagePath":"reference/api/agreement-records/list-agreements","slug":"/reference/api/agreement-records/list-agreements","pageMetadata":{"title":"List agreements","description":"Lists agreement summaries visible to the authenticated Shodai account. Supports pagination, filtering, and sorting.","deprecated":null,"version":null,"sidebarTitle":"List agreements","openapi":"/openapi.json get /v0/agreements","href":"/reference/api/agreement-records/list-agreements","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Lists agreement summaries visible to the authenticated Shodai account. Supports pagination, filtering, and sorting.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Visibility}=_components;if(!Visibility)_missingMdxReference(`Visibility`,true);return _jsxs(_Fragment,{children:[_jsx(Visibility,{for:`agents`,children:_jsxs(_components.p,{children:[`For the complete documentation index, see `,_jsx(_components.a,{href:`https://docs.shodai.network/llms.txt`,children:`llms.txt`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`client.listAgreements(...)`}),` when integrating with the TypeScript SDK.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"List agreements","description":"Lists agreement summaries visible to the authenticated Shodai account. Supports pagination, filtering, and sorting.","deprecated":null,"version":null,"sidebarTitle":"List agreements","openapi":"/openapi.json get /v0/agreements","href":"/reference/api/agreement-records/list-agreements","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/cnslabs/f1f4f74fd7adaa96/hubspot.js"],"openApiReferenceData":{"operation":{"summary":"List agreements","description":"Lists agreement summaries visible to the authenticated Shodai account. Supports pagination, filtering, and sorting.","tags":["Agreement Records"],"security":["c48be0b2-c512-45a8-863d-503911e5a72d","0c57ffed-5a65-4223-b9b7-2db96678dcf2"],"parameters":["b8f01c10-a64f-4c18-96a0-ff9596080ee8","49073672-3864-40df-9c13-9dea932ac7b6","29fe760f-ef6c-41f2-a952-358f3e08e0db","1637c7b8-66d6-430a-8f9e-ec77274e3152","a7ca31a4-25da-4526-accc-daba39fb5eea","198eb0e2-ebff-426a-89e9-8ff7cd4093d6","1b1f94ea-9499-44f9-93b2-f8d54834063d","67feefa3-45b7-43b9-9a1b-d819413ce69b","f142cf6e-77af-4f0e-81b4-77dc7eb168e6","02ff2478-fe94-48a0-9153-750cebff6f25","b4578779-49b8-47bb-9c3d-a3cdda174b75","bd0a324f-3c9b-49ef-bdff-545469eb3e36","492e9559-9931-464f-b380-5bc8aedd851f","e524401e-12cd-4a0b-a548-f6b11af6ba93","653623ed-96f7-4b7b-94e2-b178cf6c0a55"],"responses":{"200":"0b8f1d32-a6e1-4fe7-925a-a8893895ae49","400":"330122ab-42ba-4cc5-9a09-2f89d8527f5b","401":"bcdcb767-1151-44fd-b59d-e893d29dd91b","402":"b228fa09-38db-47d5-b33a-f3c22218463d","403":"0fbc08b1-9d23-46fd-9fe6-6ddfc8450347"},"operationId":"listAgreements","x-mint":{"metadata":{"sidebarTitle":"List agreements"},"content":"\u003cVisibility for=\"agents\">\nFor the complete documentation index, see [llms.txt](https://docs.shodai.network/llms.txt).\n\u003c/Visibility>\n\nUse `client.listAgreements(...)` when integrating with the TypeScript SDK."},"x-codeSamples":[{"lang":"typescript","label":"SDK","source":"import { ApiClient } from '@shodai-network/agreements-api-client';\n\nconst client = new ApiClient({\n baseUrl: process.env.BASE_URL!,\n apiKey: process.env.API_KEY,\n});\n\nconst page = await client.listAgreements({\n chainId: 59141,\n state: 'AWAITING_PAYMENT',\n createdAt: { gte: '2026-05-01T00:00:00.000Z' },\n sort: { createdAt: 'desc' },\n limit: 25,\n});\nconsole.log(page.data, page.pageInfo.nextCursor);"}],"method":"get","type":"path","servers":["6080c7b0-65de-4254-9208-0f6a9134e838","61ebdc51-3903-424f-b54d-3e2737043c8c"],"path":"/v0/agreements","baseUrlOptions":["https://test-api.shodai.network","https://api.shodai.network"],"title":"List agreements","codeSamples":[{"label":"SDK","lang":"typescript","source":"import { ApiClient } from '@shodai-network/agreements-api-client';\n\nconst client = new ApiClient({\n baseUrl: process.env.BASE_URL!,\n apiKey: process.env.API_KEY,\n});\n\nconst page = await client.listAgreements({\n chainId: 59141,\n state: 'AWAITING_PAYMENT',\n createdAt: { gte: '2026-05-01T00:00:00.000Z' },\n sort: { createdAt: 'desc' },\n limit: 25,\n});\nconsole.log(page.data, page.pageInfo.nextCursor);"}],"requestExampleLanguages":["bash","javascript"],"requiredOnlyExamples":true,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"b8f01c10-a64f-4c18-96a0-ff9596080ee8":{"name":"state","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Optional current agreement state filter.","uniqueKey":"","typeLabel":"string"},"description":"Optional current agreement state filter."},"49073672-3864-40df-9c13-9dea932ac7b6":{"name":"chainId","in":"query","required":false,"schema":{"type":"integer","isRequired":false,"description":"Optional deployed agreement chain filter. Use when the environment contains agreements across more than one supported chain.","uniqueKey":"","typeLabel":"integer"},"description":"Optional deployed agreement chain filter. Use when the environment contains agreements across more than one supported chain."},"29fe760f-ef6c-41f2-a952-358f3e08e0db":{"name":"createdAt[gt]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Include records with createdAt greater than this timestamp.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Include records with createdAt greater than this timestamp."},"1637c7b8-66d6-430a-8f9e-ec77274e3152":{"name":"createdAt[gte]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Include records with createdAt greater than or equal to this timestamp.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Include records with createdAt greater than or equal to this timestamp."},"a7ca31a4-25da-4526-accc-daba39fb5eea":{"name":"createdAt[lt]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Include records with createdAt less than this timestamp.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Include records with createdAt less than this timestamp."},"198eb0e2-ebff-426a-89e9-8ff7cd4093d6":{"name":"createdAt[lte]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Include records with createdAt less than or equal to this timestamp.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Include records with createdAt less than or equal to this timestamp."},"1b1f94ea-9499-44f9-93b2-f8d54834063d":{"name":"updatedAt[gt]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Include records with updatedAt greater than this timestamp.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Include records with updatedAt greater than this timestamp."},"67feefa3-45b7-43b9-9a1b-d819413ce69b":{"name":"updatedAt[gte]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Include records with updatedAt greater than or equal to this timestamp.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Include records with updatedAt greater than or equal to this timestamp."},"f142cf6e-77af-4f0e-81b4-77dc7eb168e6":{"name":"updatedAt[lt]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Include records with updatedAt less than this timestamp.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Include records with updatedAt less than this timestamp."},"02ff2478-fe94-48a0-9153-750cebff6f25":{"name":"updatedAt[lte]","in":"query","required":false,"schema":{"type":"string","format":"date-time","isRequired":false,"description":"Include records with updatedAt less than or equal to this timestamp.","uniqueKey":"","typeLabel":"string\u003cdate-time>"},"description":"Include records with updatedAt less than or equal to this timestamp."},"b4578779-49b8-47bb-9c3d-a3cdda174b75":{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25,"isRequired":false,"description":"Maximum number of records to return.","uniqueKey":"","typeLabel":"integer"},"description":"Maximum number of records to return."},"bd0a324f-3c9b-49ef-bdff-545469eb3e36":{"name":"cursor","in":"query","required":false,"schema":{"type":"string","isRequired":false,"description":"Opaque cursor returned by a previous list response.","uniqueKey":"","typeLabel":"string"},"description":"Opaque cursor returned by a previous list response."},"492e9559-9931-464f-b380-5bc8aedd851f":{"name":"sort[createdAt]","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc","isRequired":false,"description":"Sort by createdAt. Only one sort field may be supplied.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Sort by createdAt. Only one sort field may be supplied."},"e524401e-12cd-4a0b-a548-f6b11af6ba93":{"name":"sort[updatedAt]","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"isRequired":false,"description":"Sort by updatedAt. Only one sort field may be supplied.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Sort by updatedAt. Only one sort field may be supplied."},"653623ed-96f7-4b7b-94e2-b178cf6c0a55":{"name":"sort[displayName]","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"isRequired":false,"description":"Sort by displayName. Only one sort field may be supplied.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Sort by displayName. Only one sort field may be supplied."}},"responses":{"0b8f1d32-a6e1-4fe7-925a-a8893895ae49":{"description":"Paged agreement summaries visible to the authenticated Shodai account.","content":{"application/json":{"schema":{"type":"object","required":["data","pageInfo","meta"],"properties":{"data":{"type":"array","items":{"type":"object","required":["id","chainId","displayName","status","createdAt","updatedAt"],"description":"Compact agreement record returned by list endpoints. Read a single agreement to retrieve full agreement JSON, participants, observers, and on-chain detail.","properties":{"id":{"type":"string","description":"Agreement record ID.","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"chainId":{"type":"integer","description":"Chain ID for the deployed agreement.","isRequired":true,"uniqueKey":"data.items.[INDEX].chainId","typeLabel":"integer"},"status":{"type":"string","enum":["Draft","Deployed"],"description":"Agreement record status.","isRequired":true,"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"updatedAt":{"type":"string","format":"date-time","description":"Record update timestamp.","isRequired":true,"uniqueKey":"data.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"createdAt":{"type":"string","format":"date-time","description":"Record creation timestamp.","isRequired":true,"uniqueKey":"data.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"displayName":{"type":"string","description":"Human-readable record label.","isRequired":true,"uniqueKey":"data.items.[INDEX].displayName","typeLabel":"string"},"address":{"type":"string","description":"Deployed agreement address, when deployed.","uniqueKey":"data.items.[INDEX].address","typeLabel":"string"},"state":{"type":"string","description":"Cached agreement state, when available.","uniqueKey":"data.items.[INDEX].state","typeLabel":"string"},"templateId":{"type":"string","description":"Agreement metadata templateId or id value, when present.","uniqueKey":"data.items.[INDEX].templateId","typeLabel":"string"},"lastInputId":{"type":"string","description":"Most recent submitted input ID, when available.","uniqueKey":"data.items.[INDEX].lastInputId","typeLabel":"string"},"lastInputAt":{"type":"string","format":"date-time","description":"Time of the most recent submitted input, when available.","uniqueKey":"data.items.[INDEX].lastInputAt","typeLabel":"string\u003cdate-time>"},"owner":{"type":"string","description":"Wallet address associated with hosted record ownership.","uniqueKey":"data.items.[INDEX].owner","typeLabel":"string"},"documentId":{"type":"string","description":"Opaque hosted agreement document identifier used by /agreements/documents/{documentId}.","uniqueKey":"data.items.[INDEX].documentId","typeLabel":"string"},"docUri":{"type":"string","description":"Optional document URI associated with the deployed agreement, typically /agreements/documents/{documentId}.","uniqueKey":"data.items.[INDEX].docUri","typeLabel":"string"}},"example":{"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"},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"},"pageInfo":{"type":"object","required":["limit","nextCursor"],"properties":{"limit":{"type":"integer","example":25,"isRequired":true,"uniqueKey":"pageInfo.limit","typeLabel":"integer"},"nextCursor":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"pageInfo.nextCursor.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"pageInfo.nextCursor.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"pageInfo.nextCursor","typeLabel":"string | null"},"totalCount":{"type":"integer","description":"Total number of matching records when available.","uniqueKey":"pageInfo.totalCount","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"pageInfo","typeLabel":"object"},"meta":{"type":"object","required":["apiVersion","requestId"],"properties":{"apiVersion":{"type":"string","example":"v0","isRequired":true,"uniqueKey":"meta.apiVersion","typeLabel":"string"},"requestId":{"type":"string","description":"Correlation ID for support and debugging.","isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"agreements":{"title":"agreements","summary":"Agreement records visible to the authenticated Shodai account","value":{"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"}}}},"exampleType":"examples"}},"exampleType":"examples"},"330122ab-42ba-4cc5-9a09-2f89d8527f5b":{"description":"Invalid list query.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","example":"unauthorized","description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing API credential","description":"Safe human-readable error summary.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Correlation ID for support and debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"description":"Optional field errors or upstream-safe context.","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Missing API credential","requestId":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"bcdcb767-1151-44fd-b59d-e893d29dd91b":{"description":"Missing or invalid API credential.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","example":"unauthorized","description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing API credential","description":"Safe human-readable error summary.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Correlation ID for support and debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"description":"Optional field errors or upstream-safe context.","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Missing API credential","requestId":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b228fa09-38db-47d5-b33a-f3c22218463d":{"description":"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.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","example":"unauthorized","description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing API credential","description":"Safe human-readable error summary.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Correlation ID for support and debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"description":"Optional field errors or upstream-safe context.","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Missing API credential","requestId":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"0fbc08b1-9d23-46fd-9fe6-6ddfc8450347":{"description":"The credential lacks the required OAuth scope, the account lacks entitlement, or the account cannot access the resource.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","requestId"],"properties":{"code":{"type":"string","example":"unauthorized","description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Missing API credential","description":"Safe human-readable error summary.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"requestId":{"type":"string","description":"Correlation ID for support and debugging.","isRequired":true,"uniqueKey":"error.requestId","typeLabel":"string"},"details":{"description":"Optional field errors or upstream-safe context.","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Missing API credential","requestId":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c48be0b2-c512-45a8-863d-503911e5a72d":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Canonical API-key credential. Send X-API-Key: cns_pk_..., or Authorization: Bearer cns_pk_... only as an API-key compatibility alias.","x-default":"YOUR_API_KEY","scopes":[]}},"0c57ffed-5a65-4223-b9b7-2db96678dcf2":{"OAuthBearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth access token issued by Shodai.","x-default":"Bearer YOUR_OAUTH_ACCESS_TOKEN","scopes":[]}}},"servers":{"6080c7b0-65de-4254-9208-0f6a9134e838":{"url":"https://test-api.shodai.network","description":"Public base URL for the Agreements API testnet environment."},"61ebdc51-3903-424f-b54d-3e2737043c8c":{"url":"https://api.shodai.network","description":"Public base URL for the Agreements API production environment."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Canonical API-key credential. Send X-API-Key: cns_pk_..., or Authorization: Bearer cns_pk_... only as an API-key compatibility alias.","x-default":"YOUR_API_KEY","scopes":[]},"schema":{"title":"X-API-Key","type":"string","description":"Canonical API-key credential. Send X-API-Key: cns_pk_..., or Authorization: Bearer cns_pk_... only as an API-key compatibility alias.","isRequired":true,"default":"YOUR_API_KEY","typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth access token issued by Shodai.","x-default":"Bearer YOUR_OAUTH_ACCESS_TOKEN","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"OAuth access token issued by Shodai.","format":"bearer","default":"Bearer YOUR_OAUTH_ACCESS_TOKEN","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuthBearerAuth","name":"Authorization"}],"title":"OAuthBearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"cnslabs","siteName":"Shodai Developer Documentation","title":"List agreements - Shodai Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-22T12:39:58.712Z","originalFileLocation":"reference/api/agreement-records/list-agreements.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Lists agreement summaries visible to the authenticated Shodai account. Supports pagination, filtering, and sorting.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Shodai Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cnslabs/5TFa4BGy9ODpG9tH/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cnslabs/5TFa4BGy9ODpG9tH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cnslabs/5TFa4BGy9ODpG9tH/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cnslabs/5TFa4BGy9ODpG9tH/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cnslabs/5TFa4BGy9ODpG9tH/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cnslabs/5TFa4BGy9ODpG9tH/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cnslabs/5TFa4BGy9ODpG9tH/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cnslabs/5TFa4BGy9ODpG9tH/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cnslabs/5TFa4BGy9ODpG9tH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List agreements - Shodai Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lists agreement summaries visible to the authenticated Shodai account. Supports pagination, filtering, and sorting.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Shodai Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.shodai.network/reference/api/agreement-records/list-agreements\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.shodai.network/images/shodai-og.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List agreements - Shodai Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lists agreement summaries visible to the authenticated Shodai account. Supports pagination, filtering, and sorting.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.shodai.network/images/shodai-og.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cnslabs/5TFa4BGy9ODpG9tH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Shodai Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#73766C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.shodai.network/reference/api/agreement-records/list-agreements\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/api/agreement-records/list-agreements.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.shodai.network/#organization\",\"name\":\"Shodai Developer Documentation\",\"url\":\"https://docs.shodai.network\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cnslabs/QoBo9wst-a7Wya5g/images/shodai-logo-light.svg?fit=max\u0026auto=format\u0026n=QoBo9wst-a7Wya5g\u0026q=85\u0026s=3bb56ed1b8eacd010dd50bd09c6da976\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.shodai.network#website\",\"name\":\"Shodai Developer Documentation\",\"url\":\"https://docs.shodai.network\",\"publisher\":{\"@id\":\"https://docs.shodai.network/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.shodai.network/reference/api/agreement-records/list-agreements#webpage\",\"url\":\"https://docs.shodai.network/reference/api/agreement-records/list-agreements\",\"name\":\"List agreements\",\"description\":\"Lists agreement summaries visible to the authenticated Shodai account. Supports pagination, filtering, and sorting.\",\"dateModified\":\"2026-08-22T12:39:58.712Z\",\"isPartOf\":{\"@id\":\"https://docs.shodai.network#website\"},\"breadcrumb\":{\"@id\":\"https://docs.shodai.network/reference/api/agreement-records/list-agreements#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.shodai.network/reference/api/agreement-records/list-agreements#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.shodai.network/sdks/typescript-client\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.shodai.network/reference/api/system/get-the-openapi-document-for-the-agreements-api\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List agreements\",\"item\":\"https://docs.shodai.network/reference/api/agreement-records/list-agreements\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.shodai.network/reference/api/agreement-records/list-agreements#apireference\",\"headline\":\"List agreements\",\"name\":\"List agreements\",\"description\":\"Lists agreement summaries visible to the authenticated Shodai account. Supports pagination, filtering, and sorting.\",\"url\":\"https://docs.shodai.network/reference/api/agreement-records/list-agreements\",\"mainEntityOfPage\":{\"@id\":\"https://docs.shodai.network/reference/api/agreement-records/list-agreements#webpage\"},\"image\":\"https://docs.shodai.network/images/shodai-og.png\",\"dateModified\":\"2026-08-22T12:39:58.712Z\",\"publisher\":{\"@id\":\"https://docs.shodai.network/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.shodai.network#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Shodai Developer Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Shodai Developer Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/api/agreement-records/list-agreements.md","siteName":"Shodai Developer Documentation","nav":{"global":null,"groups":[{"group":"Start","pages":[{"title":"Overview","href":"/index"},{"title":"Choose an integration surface","href":"/integration-surfaces"},{"title":"Quickstart with TypeScript SDK","href":"/sdks/quickstart-with-typescript-sdk"},{"title":"Quickstart with MCP","href":"/sdks/quickstart-with-mcp"},{"title":"Run an end-to-end agreement workflow","href":"/examples/end-to-end-workflow"},{"title":"Authentication","href":"/authentication"}]},{"group":"Workflow","pages":[{"title":"Author Agreement JSON","href":"/workflow/author-agreement-json"},{"title":"Validate Agreement Structure","href":"/workflow/validate-agreement-structure"},{"title":"Link Wallets and Access Agreements","href":"/workflow/link-a-wallet-and-access-agreements"},{"title":"Deploy an Agreement","href":"/workflow/deploy-an-agreement"},{"title":"Operate a Deployed Agreement","href":"/workflow/operate-a-deployed-agreement"}]},{"group":"Webhooks","pages":[{"title":"Receive webhooks","href":"/webhooks/receive-webhooks"},{"title":"Agreement activity webhooks","href":"/webhooks/agreement-activity-webhooks"},{"title":"Notification webhooks","href":"/webhooks/notification-webhooks"}]},{"group":"Architecture","pages":[{"title":"Architecture overview","mode":"wide","href":"/system-architecture/overview"},{"title":"Agreement data standard","href":"/system-architecture/data-standard"},{"title":"Onchain execution engine","href":"/system-architecture/on-chain"},{"title":"Agreements API","href":"/system-architecture/putting-it-together"},{"title":"Repositories","href":"/system-architecture/repositories"},{"title":"Contracts","href":"/system-architecture/contracts"}]},{"group":"Examples","pages":[{"title":"Simple Agreement","mode":"wide","href":"/examples/simple"},{"title":"Complex Agreement","mode":"wide","href":"/examples/complex"},{"title":"Shodai Reference App","mode":"wide","href":"/examples/reference-app"}]},{"group":"Reference","pages":[{"title":"TypeScript client reference","href":"/sdks/typescript-client"},{"title":"Connect an installed TypeScript client with delegated OAuth","href":"/sdks/delegated-oauth-with-typescript"},{"group":"API Reference","pages":[{"group":"System","pages":[{"title":"Get the OpenAPI document for the Agreements API","deprecated":null,"version":null,"sidebarTitle":"Get OpenAPI document","openapi":"/openapi.json get /v0/openapi.json","href":"/reference/api/system/get-the-openapi-document-for-the-agreements-api"},{"title":"Health check","deprecated":null,"version":null,"sidebarTitle":"Health check","openapi":"/openapi.json get /v0/health","href":"/reference/api/system/health-check"}]},{"group":"Wallet Access","pages":[{"title":"Create wallet verification challenge","deprecated":null,"version":null,"sidebarTitle":"Create wallet challenge","openapi":"/openapi.json post /v0/siwe/nonce","href":"/reference/api/wallet-access/create-wallet-verification-challenge"},{"title":"Verify and link wallet","deprecated":null,"version":null,"sidebarTitle":"Verify and link wallet","openapi":"/openapi.json post /v0/siwe/verify","href":"/reference/api/wallet-access/verify-and-link-wallet"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"sidebarTitle":"List webhooks","openapi":"/openapi.json get /v0/webhooks","href":"/reference/api/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"sidebarTitle":"Create webhook","openapi":"/openapi.json post /v0/webhooks","href":"/reference/api/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"sidebarTitle":"Get webhook","openapi":"/openapi.json get /v0/webhooks/{id}","href":"/reference/api/webhooks/get-webhook"},{"title":"Disable webhook","deprecated":null,"version":null,"sidebarTitle":"Disable webhook","openapi":"/openapi.json delete /v0/webhooks/{id}","href":"/reference/api/webhooks/disable-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"sidebarTitle":"Update webhook","openapi":"/openapi.json patch /v0/webhooks/{id}","href":"/reference/api/webhooks/update-webhook"},{"title":"Send test webhook","description":"Sends a signed test payload to a webhook subscription. The signing secret is not returned after creation.","deprecated":null,"version":null,"sidebarTitle":"Test webhook","openapi":"/openapi.json post /v0/webhooks/{id}/test","href":"/reference/api/webhooks/send-test-webhook"}]},{"group":"Agreement Records","pages":[{"title":"List agreements","deprecated":null,"version":null,"sidebarTitle":"List agreements","openapi":"/openapi.json get /v0/agreements","href":"/reference/api/agreement-records/list-agreements"},{"title":"Get agreement","description":"Returns a single agreement record, including agreement JSON and hosted record context.","deprecated":null,"version":null,"sidebarTitle":"Get agreement","openapi":"/openapi.json get /v0/agreements/{id}","href":"/reference/api/agreement-records/get-agreement"}]},{"group":"Deployment","pages":[{"title":"Preflight deployment request","deprecated":null,"version":null,"sidebarTitle":"Preflight deployment","openapi":"/openapi.json post /v0/agreements/validate","href":"/reference/api/deployment/preflight-deployment-request"},{"title":"Deploy agreement","deprecated":null,"version":null,"sidebarTitle":"Deploy with permit","openapi":"/openapi.json post /v0/agreements/deploy-with-permit","href":"/reference/api/deployment/deploy-agreement"}]},{"group":"Authoring","pages":[{"title":"Validate agreement structure","deprecated":null,"version":null,"sidebarTitle":"Validate agreement structure","openapi":"/openapi.json post /v0/agreements/validate-template","href":"/reference/api/authoring/validate-agreement-structure"}]},{"group":"Agreement Documents","pages":[{"title":"Get agreement document","deprecated":null,"version":null,"openapi":"/openapi.json get /v0/agreements/documents/{documentId}","href":"/reference/api/agreement-documents/get-agreement-document"}]},{"group":"Using Agreements","pages":[{"title":"Get agreement state","deprecated":null,"version":null,"sidebarTitle":"Get agreement state","openapi":"/openapi.json get /v0/agreements/{id}/state","href":"/reference/api/using-agreements/get-agreement-state"},{"title":"Get input history","deprecated":null,"version":null,"sidebarTitle":"Get input history","openapi":"/openapi.json get /v0/agreements/{id}/inputs","href":"/reference/api/using-agreements/get-input-history"},{"title":"Submit input with permit","deprecated":null,"version":null,"sidebarTitle":"Submit input with permit","openapi":"/openapi.json post /v0/agreements/{id}/input","href":"/reference/api/using-agreements/submit-input-with-permit"}]}]},{"title":"EIP-712 Signing Reference","href":"/reference/eip-712-signing"},{"title":"Errors and troubleshooting","href":"/reference/errors-and-troubleshooting"},{"group":"Migration guides","pages":[{"title":"May 2026 API/SDK Response Migration","href":"/reference/migrations/may-2026-api-sdk-response-migration"},{"title":"May 2026 Multi-Chain Migration","href":"/reference/migrations/may-2026-multi-chain-migration"}]}]}]},"basePath":"","title":"List agreements - Shodai Developer Documentation","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}