# Business policies

The /api/policies/ endpoint enables you to retrieve information about business policies. A business policy in Iteras contains mbusiness intelligence settings and policies.

# Parameters

The endpoint uses GET and currently supports the following parameters, all optional:

• "policy_id" - (optional) ID of a specific policy, e.g. ?policy_id=654. If left out together with external_id, information for all policies is returned.

• "external_id" - (optional) External ID of a specific policy, e.g. ?external_id=Royals. If left out together with policy_id, information for all policies is returned.

• "include_archived" - (optional) include archived policies, e.g. ?include_archived=1.

# Return value

The data returned is an object with an array of business policy information (possibly empty array).

{
  "policies": [
    {
      "id": "6543",
      "name": "Royal customers",
      "external_id": "Royals", // if business policy has an external ID
      "active": true,
      "lines": [
        {
          "text": "Special discount",
          "percentage": -0.10
        }
      ],
    }
  ]
}