---
title: "Get all policy definitions"
method: GET
path: "/api/policies"
tags: ["Policy"]
---

# Get all policy definitions

`GET /api/policies`

Gets all policy definitions set up for a user

## Response `200`

Ok

- PolicySchema[]
  - `checks` Check[]
    - `attribute_label` string, nullable
    - `boolean_check` BooleanCheck
      - `auto_decline` boolean
      - `decline_description` string, nullable
      - `email_template_name` string, nullable
      - `ignore_metric_availability` boolean
      - `is_mandatory` boolean
      - `on_failure` 'fail' | 'review_required'
      - `pass_description` string, nullable
      - `value` boolean
    - `composite_check` CompositeCheck
      - `auto_decline` boolean
      - `checks` Check[]
      - `decline_description` string, nullable
      - `email_template_name` string, nullable
      - `ignore_metric_availability` boolean
      - `is_mandatory` boolean
      - `on_failure` 'fail' | 'review_required'
      - `pass_description` string, nullable
      - `type` 'AND' | 'OR'
    - `date_check` DateCheck
      - `auto_decline` boolean
      - `decline_description` string, nullable
      - `email_template_name` string, nullable
      - `ignore_metric_availability` boolean
      - `is_mandatory` boolean
      - `on_failure` 'fail' | 'review_required'
      - `pass_description` string, nullable
      - `type` 'equal' | 'not_equal' | 'before' | 'before_or_on' | 'after' | 'after_or_on'
      - `value` string, date
    - `date_delta_to_now_check` DateDeltaToNowCheck
      - `auto_decline` boolean
      - `decline_description` string, nullable
      - `email_template_name` string, nullable
      - `ignore_metric_availability` boolean
      - `is_mandatory` boolean
      - `on_failure` 'fail' | 'review_required'
      - `pass_description` string, nullable
      - `pass_if_value_missing` boolean
      - `type` 'greater_than' | 'less_than'
      - `value` object, nullable
    - `enhanced_sql_check` EnhancedSQLCheck
      - `auto_decline` boolean
      - `check_type` 'equal' | 'not_equal' | 'greater_than' | 'greater_than_or_equal' | 'less_than' | 'less_than_or_equal' | 'before' | 'before_or_on' | 'after' | 'after_or_on' | 'is_in' | 'is_not_in', required
      - `column_name` string, required
      - `comparison_value` unknown, required
      - `data_type` 'numeric' | 'date' | 'string', required
      - `decline_description` string, nullable
      - `email_template_name` string, nullable
      - `ignore_metric_availability` boolean
      - `is_mandatory` boolean
      - `on_failure` 'fail' | 'review_required'
      - `pass_description` string, nullable
      - `query_name` string, required
    - `group` string, nullable
    - `name` string, nullable
    - `numeric_check` NumericCheck
      - `auto_decline` boolean
      - `decline_description` string, nullable
      - `email_template_name` string, nullable
      - `ignore_metric_availability` boolean
      - `is_mandatory` boolean
      - `on_failure` 'fail' | 'review_required'
      - `pass_description` string, nullable
      - `type` 'equal' | 'not_equal' | 'greater_than' | 'greater_than_or_equal' | 'less_than' | 'less_than_or_equal'
      - `value` string
    - `sql_check` SQLCheck
      - `auto_decline` boolean
      - `column_name` string, required
      - `decline_description` string, nullable
      - `email_template_name` string, nullable
      - `ignore_metric_availability` boolean
      - `is_mandatory` boolean
      - `on_failure` 'fail' | 'review_required'
      - `pass_description` string, nullable
      - `query_name` string, required
    - `string_check` StringCheck
      - `auto_decline` boolean
      - `decline_description` string, nullable
      - `email_template_name` string, nullable
      - `ignore_metric_availability` boolean
      - `is_mandatory` boolean
      - `on_failure` 'fail' | 'review_required'
      - `pass_description` string, nullable
      - `type` 'equal' | 'not_equal' | 'starts_with' | 'starts_with_any_of' | 'does_not_start_with_any_of' | 'contains' | 'does_not_start_with' | 'does_not_contain' | 'is_in' | 'is_not_in'
      - `value` string
  - `display_order` integer, nullable
  - `heron_id` string, required
  - `name` string, required
  - `use_case` 'background_check' | 'cashflow'

---

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