---
id: entity-hook-action-list
title: "List entity hook actions"
description: "Lists entity hook actions within an organization."
sidebar_label: "List entity hook actions"
hide_title: true
hide_table_of_contents: true
api: eJzdWN1u28gVfpWDQYFNAlqmHSm7JZACbprtZrdwA8dBF4gNYcQ5FGdDzjAzQytagXe97+tsX6cv0FcozgwpkpLWdl2nBeoLWZrf73znd86GCbSpkZWTWrGE/UlaZwGVk24NudYfgac0ZWElXS4VcAXaLLmSP3Man7CIOb60LPnAXve72HXEdIXGr3kjWMLCkXOanIcjk0JaxyJWccNLdGjokA2TBONTjWbNIqZ4iSxhyigWMZvmWHKWbJhbVzRsnZFqyZqIGfxUS4OCJc7UGO0I9a0s6PitKC7nDkru0hy0AW4QSm0QbIWpzGRK8wpcjlAZfSMFCji/OCdJ8TMvq4KuHnLw8iThaapr5V6eJoTYVjzFl89ZEx0WJ3Bxu0RjCS5zBFoCOuuUw7MMU4cCFmtwuTyktDFkm+oKfxWTvo3hiKGqS9JxapA7ZBGrKxG+CCzQIbvew/wu0InWU9mhD8iCCpyRyyUphhYQ7jHg9q7mOmIW09oQZ2QhC+QGzVntcpZ8uKZpg7bSyqIl6KdxTP/2CSR7GxBIF9pgBlItPQbPCYFItXKoHJ3Dq6qQqVf08U+WDtvs86QXP2FKxtwb4gdW8WUgz6CtC2fJKSpDbuFkgNquuOMcnWUWabCQpXT7p7Tz/SlSOVyiYRErpZIlaS4+ZFHWceNI9kpL5SDTBjyi4NnwB8w44QanIQaZgdJu6xIjVcVNB+4gCP45gDiND8Jo50HV5QINaagljC426GqjoEKPDScw3MGLQq9QwA0vagRp4TSOR8BO47hpml4DPTxuDCfzlw5Le5cGpCBH8UFo67vBkFnEtJpXupDpem7rNEVrR2MZlwWL2CpHWusvoel9LUpxyO8ybUruWMLq2oPYZ69W8hMJLwhZJgOBZMwDMx/71WwW4zfTOD7C098ujqYnYnrEvz55cTSdvngxm02ncRzHFIJI4AOQxhDOSFm6NukIwpPzi/OnbUBdk4WtcjQY4lQbAbxfof33w2oy8MiXUwLa6uROrP9BFG3D3+BqHy51FUJgVeh1SQEjxFOPlFS8H307u7kX2G1Gajlb6xpWXDlyjAWSPxLdAvhC126Is0eUbCP2YGxl5O5QG8Zbofpd4We3Ifzarh3Q0e8YDnb7hmPb3Vum+r39ULezH+kSzR6r3XbKQLJEZSnJH3LpMcE/4PooBI6KS2NBYCZVlwn8wZ0nHcimG4bqRhqtvNYT8mVRdxHBG61Zk9daRuFnP0TckmJLrmpekJz7BtFlT69+xz+iAq12vR3aSyZX6kr9Dp49O9cOk2fP4FVtDCpXrCPQqljDVXvXFaPYaeuq0sahmFypkVO2gJq9sPaoQgwFoNNrg5MrRiIAPKoQPhTfAn2BmTbeaDOHZl+Evq5Z5ehyNNvyBXSa1sZCOMHXlnQEqLooqoI7CuZfWaDMaBQvoNBLme4Cba9v2mRxC9Cu0L4zyA2D2d02QavvINPf7O3hYbXiFysVI+bts02pO6l+n6ducZuMBNlk70wtV//469//+cvf4A3VP4MdBiHTtRIRrLCrUrgCLCtKK3RlYO1XC4xb0n9fO+0m2/1sT1Wb62RZj2iZvfj6my+Ux7v7HjONh5fIffIireyC8wG52SuzrpyGH7RawtvOIBpf1gvp7pcezuD7d38+hzA7Tg79MVArgQZWuUzzUD/cQssmpKsJVZZoHYo5ETspsdRmPZdqvlzQot8UDlkybcJfxJx0Rf9q/M673uFxerxftE8hFjZPf/xx/zH0qpCoHKAx2sD27QSiRnIAqW54IQVIVdWOglgprfWvhO1D/dGeSNZxV9tXWlB08HjovYDW8iXul8iD1Xf7yneXl28h7IBUC/LRyqAltroc31VX6ZCPJzhZTiKYxjF9nNDHc/qYPh0pcxrH3qDEPUz2DEpOj0w8MsgFXxTY3uVx+fiWcodLbeTPbQy0aG7IudtEOM4QXMxbG/LVr6ftHiAWRmIWQV6XXPVIBqu2LwcPzofhlo0r9nsu4CJcesVo4L3itcs9ZHHFxuQMVxPETqN3gxTBsXgBAh2XhQ21bQ9rfA8Fg5YKWHF6zReUZFGAZ1c5LhWKrUkPLbhzr9khD3kX6N/1EKmEt3O1pFAvra2xq7/O3r4BKwX+n7mGHRLRGsOMXGMWn9LH87HiZ/87r+iqqnlYNA+U/df8401X1LWm85rWBE+hEZkivFf8hsuCTt1zmIPbv6jrnCmoFX6uwvM3iOTrV4NiAm8L5BbBmTXwJZcKCu7QdF7jcblcU2N3iaGJS904djxo8x5vOyRBI6G9W5uCCkjnKpscH/NKTobV8STV5ajh9458JZj4sO23JYMO6hqXoXqmRSxqv3zbtU++/8ulf4lJlWnaTngCbyeTeBKzPp0Ou9i+nrSu5N5v204pZdlDHfJdjWz6OPCwtnqQ0OFnd1wVXCqC4+nbtHR/GHbV+5bUdcRybR3NbzYLbvG9KZqGhkPPl9QgpCU7FCzJeGF3O+ZD6E8u2qD0FB6tj35QtI+43rb6/bucJcy3q++P9eENnlsQbTt+DwT1wMfNLYj0mKJr+mEkwfEN8YjlyAUar+iw4yxNsXKDXXt5iU7Z+vQfX1+SOY1dbce1/OndC0sN+dlswopL/RFV07AOtqPfrLlumuZfpRwyJg==
sidebar_class_name: "get api-method"
info_path: docs/api/entity-hook
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List entity hook actions"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/entity_hook/action"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Lists entity hook actions within an organization.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"query","name":"nrn","schema":{"type":"string"},"required":true,"description":"Filters actions that match or are more specific than the provided NRN.","example":"organization=1:account=2:namespace=3"},{"in":"query","name":"entity","schema":{"type":"string"},"description":"The type of entity affected by this entity hook action.","example":"scope"},{"in":"query","name":"on","schema":{"type":"string","enum":["create","update","delete"]},"description":"Specifies the type of action that triggers the hook.","example":"create"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The list of entity hooks matching the query.","content":{"application/json":{"schema":{"type":"object","required":["paging","results"],"properties":{"paging":{"type":"object","required":["offset","limit"],"properties":{"offset":{"type":"integer","minimum":0,"description":"The starting point for pagination. Defaults to 0 if not provided.","example":0},"limit":{"type":"integer","maximum":200,"description":"The maximum number of results to return per page. The maximum allowed value is 200.","example":200}}},"results":{"type":"array","items":{"type":"object","required":["id","nrn","entity","action","on_policy_success","on_policy_fail","when","type","on"],"properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the entity hook.","example":"550e8400-e29b-41d4-a716-446655440000"},"nrn":{"type":"string","description":"A resource identifier (NRN) specifying where this action applies.","example":"organization=1:account=2:namespace=3:application=4"},"entity":{"type":"string","description":"The type of entity affected by this entity hook action.","enum":["application","scope","deployment","namespace"],"example":"scope"},"action":{"type":"string","description":"The specific action you want to be notified about.","enum":["deployment:create","deployment:write","deployment:delete","scope:create","scope:write","scope:delete","application:create","application:write","application:delete","namespace:create","namespace:write","namespace:delete"],"example":"scope:create"},"dimensions":{"type":"object","description":"Key-value pairs defining the scope of the action.","example":{"environment":"production","country":"us"}},"on_policy_success":{"type":"string","enum":["manual"],"description":"The action to be taken on the entity hook success.\n\n> **Note:** Currently, only \"manual\" is supported.\n","example":"manual"},"on_policy_fail":{"type":"string","enum":["manual"],"description":"The action to be taken on entity hook failure.\"\n\n  > **Note:** Currently, only \"manual\" is supported.\n","example":"manual"},"when":{"type":"string","enum":["before","after"],"description":"Specifies whether the hook occurs before or after nullplatform's internal logic.\n","example":"before"},"type":{"type":"string","enum":["hook"],"description":"The type of entity hook action.\n\n> **Note:** Currently, only \"hook\" is supported.\n","example":"hook"},"on":{"type":"string","enum":["create","update","delete"],"description":"Specifies the type of action that triggers the hook.","example":"create"},"policies":{"type":"array","description":"The policies applied to the entity.\n\n> ℹ️ If no policies are found, we return an empty array.\n","items":{"type":"object","properties":{"id":{"type":"integer","description":"A unique identifier for the policy.","example":5678},"nrn":{"type":"string","description":"A resource identifier (NRN) specifying where the policy applies.","example":"organization=1:account=2:namespace=3:application=4"},"name":{"type":"string","description":"The name of the policy.","example":"Crypto Kong Policies"},"conditions":{"type":"object","description":"A JSON object defining the conditions under which this policy applies.","example":{"scope.requested_spec.memory_in_gb":{"$lte":4}}}}}}},"title":"entityHook"}}},"title":"entityHookListResponse"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>