Hedera · Example Payload

Gethooks

Returns a list of hooks associated with a given account ID, alias, or EVM address.

accounts

Gethooks is an example object payload from Hedera, with 8 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersresponses

Example Payload

Raw ↑ 
{
  "operationId": "getHooks",
  "method": "GET",
  "path": "/api/v1/accounts/{idOrAliasOrEvmAddress}/hooks",
  "summary": "List hooks for an account",
  "description": "Returns a list of hooks associated with a given account ID, alias, or EVM address.",
  "tags": [
    "accounts"
  ],
  "parameters": [
    {
      "name": "idOrAliasOrEvmAddress",
      "in": "path",
      "description": "Account alias or account id or evm address",
      "required": true
    },
    {
      "name": "hook.id",
      "in": "query",
      "description": "The ID of the hook",
      "required": false
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of items to return",
      "required": false
    },
    {
      "name": "order",
      "in": "query",
      "description": "The order in which items are listed",
      "required": false
    }
  ],
  "responses": {
    "200": "OK",
    "400": "Invalid parameter",
    "404": "Not Found"
  }
}