Policies
Define policy reforms by modifying tax-benefit system parameters.
List policies
GET
/policiesRetrieve all defined policies.
https://v2.api.policyengine.org/policies
Get policy
GET
/policies/:policy_idRetrieve a specific policy by ID.
Path parameters
https://v2.api.policyengine.org/policies/660e8400-e29b-41d4-a716-446655440000
Create policy
POST
/policiesCreate a new policy reform with parameter value changes.
Request body
https://v2.api.policyengine.org/policies
Request parameters
namestring - Policy namedescriptionstring | null - Optional descriptionparameter_valuesarray - Parameter modifications (see below)Delete policy
DELETE
/policies/:policy_idDelete a policy by ID.
Path parameters
https://v2.api.policyengine.org/policies/660e8400-e29b-41d4-a716-446655440000
Policy object
idUUID - Unique identifiernamestring - Policy namedescriptionstring | null - Optional descriptionparameter_valuesarray - Parameter modificationscreated_atdatetime - Creation timestampParameter value object
parameter_idUUID - Reference to parametervalue_jsonobject - New parameter valuestart_datedate - When change takes effectend_datedate - When change ends