---
title: "Retrieve policies list by filters"
method: GET
path: "/policies/"
tags: ["Policies"]
---

# Retrieve policies list by filters

`GET /policies/`

## Query parameters

- `filters[]` string[]
- `group` string
- `lang` 'en' | 'ru', required
- `page` integer, required
- `pageSize` integer, required
- `sort` string, required
- `type` 'sort' | 'filter' | 'init' | 'page' | 'size', required

## Response `200`

policies list received successful

- object
  - `data` object
    - `details` PrivatePolicyDetails[]
      - `active_modules` integer
      - `agents` integer
      - `consistency` boolean
      - `dependencies` ModelsPolicyDependency[]
        - `min_agent_version` string
        - `min_module_version` string
        - `module_name` string
        - `source_module_name` string, required
        - `status` boolean
        - `type` 'to_receive_data' | 'to_send_data' | 'to_make_action' | 'agent_version', required
      - `groups` ModelsGroup[]
        - `created_date` string
        - `deleted_at` string
        - `hash` string, required
        - `id` integer
        - `info` ModelsGroupInfo, required
          - `name` ModelsGroupItemLocale, required
            - `en` string, required
            - `ru` string, required
          - `system` boolean
          - `tags` string[], required
        - `updated_at` string
      - `hash` string
      - `joined_modules` string
      - `modules` ModelsModuleAShort[]
        - `deleted_at` string
        - `dynamic_dependencies` ModelsDependencyItem[], required
          - `min_agent_version` string
          - `min_module_version` string
          - `module_name` string
          - `type` 'to_receive_data' | 'to_send_data' | 'to_make_action' | 'agent_version', required
        - `id` integer
        - `info` ModelsModuleInfo, required
          - `actions` string[], required
          - `events` string[], required
          - `fields` string[], required
          - `name` string, required
          - `os` ModelsModuleInfoOS, required
          - `system` boolean
          - `tags` string[], required
          - `template` 'generic' | 'empty' | 'collector' | 'detector' | 'responder' | 'custom', required
          - `version` ModelsSemVersion, required
            - `major` integer
            - `minor` integer
            - `patch` integer
        - `last_module_update` string, required
        - `last_update` string
        - `locale` ModelsLocale, required
          - `action_config` object, required
          - `actions` object, required
          - `config` object, required
          - `event_config` object, required
          - `events` object, required
          - `fields` object, required
          - `module` ModelsModuleLocaleDesc, required
          - `secure_config` object
          - `tags` object, required
        - `policy_id` integer
        - `state` 'draft' | 'release'
        - `static_dependencies` ModelsDependencyItem[], required
          - `min_agent_version` string
          - `min_module_version` string
          - `module_name` string
          - `type` 'to_receive_data' | 'to_send_data' | 'to_make_action' | 'agent_version', required
      - `update_modules` boolean
    - `policies` ModelsPolicy[]
      - `created_date` string
      - `deleted_at` string
      - `hash` string, required
      - `id` integer
      - `info` ModelsPolicyInfo, required
        - `name` ModelsPolicyItemLocale, required
          - `en` string, required
          - `ru` string, required
        - `system` boolean
        - `tags` string[], required
      - `updated_at` string
    - `total` integer
  - `status` string

## Other responses

- `400` — invalid query request data
- `403` — getting policies not permitted
- `404` — policies not found
- `500` — internal error on getting policies

---

[API](https://skmtc.net/vxcontrol/apis/soldr-swagger-api.md) · [All operations](https://skmtc.net/vxcontrol/apis/soldr-swagger-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vxcontrol/soldr-swagger-api/versions/ac519ec936b3/schema)