Policy

Get all policy definitions

Changed on Nov 3, 2026

Gets all policy definitions set up for a user

get/api/policies

Request

Base URL
https://app.herondata.io
URL
https://app.herondata.io/api/policies
Auth
API key in header x-api-key

Response

display_orderinteger nullable

heron_idstring required

namestring required

use_case'background_check' | 'cashflow'

Changes

Nov 3, 2026bd8008e49534 Revision changes
- breaking
  the response property //////// became nullable for the status
- breaking
  added subschema #1 to the //////// response property oneOf list for the response status
- breaking
  added subschema #1 to the //////// response property oneOf list for the response status
- breaking
  the //////// response's property type changed from string to no type for status
- breaking
  the //////// response's property type changed from string to no type for status
- warning
  added the new AT_MOST_FAILING enum value to the //////// response property for the response status
- warning
  added the new greater_than_or_equal enum value to the //////// response property for the response status
- warning
  added the new has_any_of enum value to the //////// response property for the response status
- warning
  added the new has_fewer_than_n_matches enum value to the //////// response property for the response status
- warning
  added the new has_more_than_n_matches enum value to the //////// response property for the response status
- warning
  added the new has_none_of enum value to the //////// response property for the response status
- warning
  added the new has_only enum value to the //////// response property for the response status
- warning
  added the new is_invalid enum value to the //////// response property for the response status
- warning
  added the new is_valid enum value to the //////// response property for the response status
- warning
  added the new less_than_or_equal enum value to the //////// response property for the response status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status
- info
  added the optional property //////// to the response with the status

Operation history

Get all policy definitions

Request

Response 200OK

Changes

Response