1 of 3

Schedules

Get Schedules Entities

List schedules entities

This method will use 15 Compute Units.

Get Schedule by ID

Returns schedule information based on the given schedule id

This method will use 15 Compute Units.

Get Schedule by ID

Returns schedule information based on the given schedule id

This method will use 15 Compute Units.

Get schedule by id

Returns schedule information based on the given schedule id

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/schedules/{scheduleId}

Path parameters

scheduleId*nullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

Response

Body

admin_keynullable Key (object)

_typeenum

Example: "ProtobufEncoded"

ECDSA_SECP256K1ED25519ProtobufEncoded

keystring

Example: 10101

consensus_timestampTimestamp (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

creator_account_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

deletedboolean

Example: false

executed_timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

expiration_timenullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

memostring

Example: "created on 02/10/2021"

payer_account_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

schedule_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

signaturesarray of ScheduleSignature (object)

consensus_timestampTimestamp (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

public_key_prefixstring (byte)

Example: "AAEBAwuqAwzB"

signaturestring (byte)

Example: "3q2+7wABAQMLqgMMwQ=="

typeenum

Example: "ED25519"

CONTRACTED25519RSA_3072ECDSA_384ECDSA_SECP256K1UNKNOWN

transaction_bodystring (byte)

Example: "Kd6tvu8="

wait_for_expiryboolean

Request

Response

Get Schedules Entities

List schedules entities

This method will use 15 Compute Units.

List schedules entities

Lists schedules on the network that govern the execution logic of scheduled transactions. This includes executed and non executed schedules.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/schedules

Query parameters

account.idEntityIdQuery (string)

The ID of the account to return information for

Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "desc"

ascdesc

schedule.idEntityIdQuery (string)

The ID of the schedule to return information for

Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$

Response

Body

schedulesSchedules (array of Schedule (object))

admin_keynullable Key (object)

_typeenum

Example: "ProtobufEncoded"

ECDSA_SECP256K1ED25519ProtobufEncoded

keystring

Example: 10101

consensus_timestampTimestamp (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

creator_account_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

deletedboolean

Example: false

executed_timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

expiration_timenullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

memostring

Example: "created on 02/10/2021"

payer_account_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

schedule_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

signaturesarray of ScheduleSignature (object)

consensus_timestampTimestamp (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

public_key_prefixstring (byte)

Example: "AAEBAwuqAwzB"

signaturestring (byte)

Example: "3q2+7wABAQMLqgMMwQ=="

typeenum

Example: "ED25519"

CONTRACTED25519RSA_3072ECDSA_384ECDSA_SECP256K1UNKNOWN

transaction_bodystring (byte)

Example: "Kd6tvu8="

wait_for_expiryboolean

linksLinks (object)

nextnullable string

Example: "/api/v1/transactions?timestamp=lt:1657598275.517984411"

Request

Response

List schedules entities

Lists schedules on the network that govern the execution logic of scheduled transactions. This includes executed and non executed schedules.

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/schedules

Query parameters

account.idEntityIdQuery (string)

The ID of the account to return information for

Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$

limitinteger (int32)

The maximum number of items to return

Example: 2

orderenum

The order in which items are listed

Example: "desc"

ascdesc

schedule.idEntityIdQuery (string)

The ID of the schedule to return information for

Pattern: ^((gte?|lte?|eq|ne)\:)?(\d{1,10}\.\d{1,10}\.)?\d{1,10}$

Response

Body

schedulesSchedules (array of Schedule (object))

admin_keynullable Key (object)

_typeenum

Example: "ProtobufEncoded"

ECDSA_SECP256K1ED25519ProtobufEncoded

keystring

Example: 10101

consensus_timestampTimestamp (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

creator_account_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

deletedboolean

Example: false

executed_timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

expiration_timenullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

memostring

Example: "created on 02/10/2021"

payer_account_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

schedule_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

signaturesarray of ScheduleSignature (object)

consensus_timestampTimestamp (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

public_key_prefixstring (byte)

Example: "AAEBAwuqAwzB"

signaturestring (byte)

Example: "3q2+7wABAQMLqgMMwQ=="

typeenum

Example: "ED25519"

CONTRACTED25519RSA_3072ECDSA_384ECDSA_SECP256K1UNKNOWN

transaction_bodystring (byte)

Example: "Kd6tvu8="

wait_for_expiryboolean

linksLinks (object)

nextnullable string

Example: "/api/v1/transactions?timestamp=lt:1657598275.517984411"

Request

Response

Get schedule by id

Returns schedule information based on the given schedule id

GEThttps://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/schedules/{scheduleId}

Path parameters

scheduleId*nullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

Response

Body

admin_keynullable Key (object)

_typeenum

Example: "ProtobufEncoded"

ECDSA_SECP256K1ED25519ProtobufEncoded

keystring

Example: 10101

consensus_timestampTimestamp (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

creator_account_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

deletedboolean

Example: false

executed_timestampnullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

expiration_timenullable TimestampNullable (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

memostring

Example: "created on 02/10/2021"

payer_account_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

schedule_idnullable EntityId (string)

Network entity ID in the format of shard.realm.num

Example: "0.1.2"

Pattern: ^\d{1,10}\.\d{1,10}\.\d{1,10}$

signaturesarray of ScheduleSignature (object)

consensus_timestampTimestamp (string)

Example: "1586567700.453054000"

Pattern: ^\d{1,10}(\.\d{1,9})?$

public_key_prefixstring (byte)

Example: "AAEBAwuqAwzB"

signaturestring (byte)

Example: "3q2+7wABAQMLqgMMwQ=="

typeenum

Example: "ED25519"

CONTRACTED25519RSA_3072ECDSA_384ECDSA_SECP256K1UNKNOWN

transaction_bodystring (byte)

Example: "Kd6tvu8="

wait_for_expiryboolean

Request

Response

const response = await fetch('https://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/schedules', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "schedules": [
    {
      "admin_key": {
        "_type": "ProtobufEncoded",
        "key": 10101
      },
      "consensus_timestamp": "1586567700.453054000",
      "creator_account_id": "0.1.2",
      "deleted": false,
      "executed_timestamp": "1586567700.453054000",
      "expiration_time": "1586567700.453054000",
      "memo": "created on 02/10/2021",
      "payer_account_id": "0.1.2",
      "schedule_id": "0.1.2",
      "signatures": [
        {
          "consensus_timestamp": "1586567700.453054000",
          "public_key_prefix": "AAEBAwuqAwzB",
          "signature": "3q2+7wABAQMLqgMMwQ==",
          "type": "ED25519"
        }
      ],
      "transaction_body": "Kd6tvu8=",
      "wait_for_expiry": false
    }
  ],
  "links": {
    "next": "/api/v1/transactions?timestamp=lt:1657598275.517984411"
  }
}

const response = await fetch('https://mainnet.hedera.validationcloud.io/v1/YOUR_API_KEY/api/v1/schedules/{scheduleId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

{
  "admin_key": {
    "_type": "ProtobufEncoded",
    "key": 10101
  },
  "consensus_timestamp": "1586567700.453054000",
  "creator_account_id": "0.1.2",
  "deleted": false,
  "executed_timestamp": "1586567700.453054000",
  "expiration_time": "1586567700.453054000",
  "memo": "created on 02/10/2021",
  "payer_account_id": "0.1.2",
  "schedule_id": "0.1.2",
  "signatures": [
    {
      "consensus_timestamp": "1586567700.453054000",
      "public_key_prefix": "AAEBAwuqAwzB",
      "signature": "3q2+7wABAQMLqgMMwQ==",
      "type": "ED25519"
    }
  ],
  "transaction_body": "Kd6tvu8=",
  "wait_for_expiry": false
}