Skip to main content
GET
/
v0
/
agreements
/
{id}
/
state
cURL
curl --request GET \
  --url https://test-api.shodai.network/v0/agreements/{id}/state \
  --header 'X-API-Key: <api-key>'
{
  "status": "Deployed",
  "state": "AWAITING_PAYMENT"
}

Documentation Index

Fetch the complete documentation index at: https://docs.shodai.network/llms.txt

Use this file to discover all available pages before exploring further.

Use the current state together with the authored agreement lifecycle before choosing an input to submit.

Authorizations

​
X-API-Key
string
header
default:YOUR_API_KEY
required

API key. Send this value in the X-API-Key request header.

Path Parameters

​
id
string
required

Agreement ID or deployed agreement address.

Response

Agreement state payload.

Current agreement status and state.

​
status
enum<string>
required

Agreement record status.

Available options:
Draft,
Deployed
​
state
string | null
required

Current agreement state, or null when no state is available.