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>'
{
  "data": {
    "status": "Deployed",
    "state": "AWAITING_PAYMENT"
  },
  "meta": {
    "apiVersion": "v0",
    "requestId": "req_123"
  }
}
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

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.

Path Parameters

​
id
string
required

Agreement ID or deployed agreement address.

Response

Agreement state payload.

​
data
object
required

Current agreement status and state.

Example:
{
  "status": "Deployed",
  "state": "AWAITING_PAYMENT"
}
​
meta
object
required