---
title: "Candidate policy listing for a particular agency group"
method: GET
path: "/candidate/{candidate_id}/agency-group/{group_id}/policy"
tags: ["Policy", "Candidate Policy"]
---

# Candidate policy listing for a particular agency group

`GET /candidate/{candidate_id}/agency-group/{group_id}/policy`

## Request

- Base URL: `http://localhost:3010/v1`
- URL: `http://localhost:3010/v1/candidate/{candidate_id}/agency-group/{group_id}/policy`
- Auth: HTTP basic

- All assigned policy types for a candidate for a particular agency group
  - /candidate/{candidate_id}/agency-group/{group_id}/policy
- Has a candidate acknowledged a particular policy?
  - /candidate/{candidate_id}/agency-group/{group_id}/policy?action=acknowledged&policy_type_id=2468
- Has a candidate acknowledged a particular version of the policy?
  - /candidate/{candidate_id}/agency-group/{group_id}/policy?action=acknowledged&policy_type_id=2468&latest_only=true
  - /candidate/{candidate_id}/agency-group/{group_id}/policy?action=acknowledged&policy_type_id=2468&version=2
- Has a candidate acknowledged a document that has an effective date greater than x?
  - /candidate/{candidate_id}/agency-group/{group_id}/policy?action=acknowledged&policy_type_id=2468&policy_effective_at_from=x

## Query parameters

- `action` 'acknowledged' | 'not_acknowledged'
- `version_from` integer
- `version` integer
- `version_to` integer
- `latest_only` boolean
- `policy_type_id` string
- `policy_effective_at_from` string, date-time
- `policy_effective_at` string, date-time
- `policy_effective_at_to` string, date-time
- `sortBy` string[]
- `policy_type_classification` 'viewable' | 'acknowledgeable'
- `page` integer
- `items_per_page` integer

## Response `200`

Listing of all policies assigned to the candidate for the agency group

- CandidateOrUserPolicyReturn[]
  - `_id` string, required
  - `updated_at` string, date-time, required
  - `created_at` string, date-time, required
  - `__v` integer, required
  - `latest_policy` EmbeddedPolicy
    - `version` integer
    - `effective_at` string, date-time
  - `acknowledged_policy` EmbeddedPolicy
    - `version` integer
    - `effective_at` string, date-time
  - `resource_type` string, required
  - `resource_id` string, required
  - `policy_type_id` string, required
  - `policy_type_title` string, required
  - `policy_type_description` string, required
  - `policy_type_classification` 'viewable' | 'acknowledgeable'

## Other responses

- `204`: No Content. There were no records to return based on your query.
- `400`: Validation Error. Usually caused by a missing or invalid parameter.
- `401`: Authorization Error. Thrown if the user does not have access to resource.
- `default`: unexpected error

---

[API](https://skmtc.dev/staffshift/apis/staffshift-api-gateway.md) - [All operations](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/llms.txt) - [OpenAPI document](https://skmtc.dev/staffshift/apis/staffshift-api-gateway/revisions/1f079f6b65f5?raw)