---
title: "List entity hook actions"
method: GET
path: "/entity_hook/action"
tags: ["Entity hook"]
---

# List entity hook actions

`GET /entity_hook/action`

Lists entity hook actions within an organization.

## Query parameters

- `nrn` string, required
- `entity` string
- `on` 'create' | 'update' | 'delete'

## Response `200`

The list of entity hooks matching the query.

- EntityHookListResponse
  - `paging` object, required
    - `offset` integer, required — The starting point for pagination. Defaults to 0 if not provided.
    - `limit` integer, required — The maximum number of results to return per page. The maximum allowed value is 200.
  - `results` EntityHook[], required
    - `id` string, uuid, required — The unique identifier of the entity hook.
    - `nrn` string, required — A resource identifier (NRN) specifying where this action applies.
    - `entity` 'application' | 'scope' | 'deployment' | 'namespace', required — The type of entity affected by this entity hook action.
    - `action` 'deployment:create' | 'deployment:write' | 'deployment:delete' | 'scope:create' | 'scope:write' | 'scope:delete' | 'application:create' | 'application:write' | 'application:delete' | 'namespace:create' | 'namespace:write' | 'namespace:delete', required — The specific action you want to be notified about.
    - `dimensions` object — Key-value pairs defining the scope of the action.
    - `on_policy_success` 'manual', required — The action to be taken on the entity hook success. > **Note:** Currently, only "manual" is supported.
    - `on_policy_fail` 'manual', required — The action to be taken on entity hook failure." > **Note:** Currently, only "manual" is supported.
    - `when` 'before' | 'after', required — Specifies whether the hook occurs before or after nullplatform's internal logic.
    - `type` 'hook', required — The type of entity hook action. > **Note:** Currently, only "hook" is supported.
    - `on` 'create' | 'update' | 'delete', required — Specifies the type of action that triggers the hook.
    - `policies` object[] — The policies applied to the entity. > ℹ️ If no policies are found, we return an empty array.
      - `id` integer — A unique identifier for the policy.
      - `nrn` string — A resource identifier (NRN) specifying where the policy applies.
      - `name` string — The name of the policy.
      - `conditions` object — A JSON object defining the conditions under which this policy applies.

## Other responses

- `4XX` — Client error responses due to invalid input or missing parameters.
- `5XX` — Server error responses indicating an issue on the API side.

---

[API](https://skmtc.dev/nullplatform/apis/nullplatform-api.md) · [All operations](https://skmtc.dev/nullplatform/apis/nullplatform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nullplatform/nullplatform-api/revisions/1c4ea154b159/schema)