---
title: "Search shared policy groups"
method: GET
path: "/shared-policy-groups"
tags: ["SharedPolicyGroups"]
---

# Search shared policy groups

`GET /shared-policy-groups`

## Request

- Base URL: `/management/v2/environments/DEFAULT` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/management/v2/environments/DEFAULT/shared-policy-groups`
- Auth: one of:
  - HTTP basic
  - API key in cookie `Auth-Graviteeio-APIM`

## Query parameters

- `page` integer
- `perPage` integer
- `sortBy` 'name' | '-name' | 'apiType' | '-apiType' | 'phase' | '-phase' | 'updatedAt' | '-updatedAt' | 'deployedAt' | '-deployedAt'
- `q` string

## Response `200`

Page of shared policy groups

- object
  - `data` SharedPolicyGroup[]: List of SharedPolicyGroup.
    - `id` string: The unique ID of the shared policy group
    - `crossId` string: The unique ID of the shared policy group
    - `name` string: The name of the shared policy group
    - `description` string: The description of the shared policy group
    - `prerequisiteMessage` string: The prerequisite message of the shared policy group. This message is displayed to the user to help understand the prerequisite to use the shared policy group.
    - `version` number: The version of the shared policy group
    - `apiType` 'A2A_PROXY' | 'AUTHZ' | 'EDGE' | 'LLM_PROXY' | 'MCP_PROXY' | 'MESSAGE' | 'PROXY' | 'NATIVE': API's type.
    - `originContext` BaseOriginContext
      - `origin` 'MANAGEMENT' | 'KUBERNETES' | 'INTEGRATION': The origin of the API.
    - `steps` StepV4[]: The list of steps (policies) in the shared policy group
      - `name` string: The name of the step
      - `description` string: The description of the step
      - `enabled` boolean: Is the step enabled or not.
      - `policy` string: The policy of the step
      - `configuration` object: The configuration of the step
      - `condition` string: The condition of the step
      - `messageCondition` string: The message condition of the step
    - `phase` 'ENTRYPOINT_CONNECT' | 'REQUEST' | 'RESPONSE' | 'INTERACT' | 'PUBLISH' | 'SUBSCRIBE': The execution phase of a policy.
    - `deployedAt` string, date-time: The date at which the shared policy group was deployed
    - `createdAt` string, date-time: The date at which the shared policy group was created
    - `updatedAt` string, date-time: The date at which the shared policy group was last updated
    - `lifecycleState` 'DEPLOYED' | 'UNDEPLOYED' | 'PENDING': The lifecycle state of a shared policy group
  - `pagination` Pagination: Generic object to handle pagination data.
    - `page` integer: The current page.
    - `perPage` integer: The number of items requested per page.
    - `pageCount` integer: The total number of pages.
    - `pageItemsCount` integer: The number of items for the current page.
    - `totalCount` integer: The total number of items, or `-1` if the count could not be computed within the configured timeout.
  - `links` Links: List of links for pagination
    - `self` string: Link to current resource
    - `first` string: In a paginated response, link to the first page
    - `last` string: In a paginated response, link to the last page
    - `previous` string: In a paginated response, link to the previous page. Maybe null if current is the first page
    - `next` string: In a paginated response, link to the next page. Maybe null if current is the last page

## Other responses

- `default`: Generic error response

## Changes

- **2026-06-19** `d1cab18ccf47`: 1 warning
  - added the new `AUTHZ` enum value to the `data/items/apiType` response property for the response status `200`
- **2026-05-22** `34e152417e4e`: 1 warning
  - added the new `EDGE` enum value to the `data/items/apiType` response property for the response status `200`
- **2026-02-13** `1c9b92e2e21c`: 1 info
  - removed the `CONNECT` enum value from the `data/items/phase` response property for the response status `200`
- **2026-02-03** `90e19a0ff082`: 1 warning
  - added the new `ENTRYPOINT_CONNECT` enum value to the `data/items/phase` response property for the response status `200`
- **2025-12-18** `84dd2985444a`: 1 warning
  - added the new `A2A_PROXY` enum value to the `data/items/apiType` response property for the response status `200`

[Operation history](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-environments/changes/shared-policy-groups/get.md)

---

[API](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-environments.md) - [All operations](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-environments/llms.txt) - [OpenAPI document](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-environments/revisions/b736a7e375df?raw)
