Using Agreements

Get agreement state

Returns the current state of an agreement. For deployed agreements, interpret the state against the authored agreement lifecycle.

get/v0/agreements/{id}/state

Request

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

Path parameters

idstring required

Agreement ID or deployed agreement address.

Response

Agreement state payload.

Example response

{
  "data": {
    "status": "Deployed",
    "state": "AWAITING_PAYMENT"
  },
  "meta": {
    "apiVersion": "v0"
  }
}

Changes

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