---
title: "Get a target's control groups"
method: GET
path: "/issuing/controls/control-groups"
tags: ["Control groups"]
---

# Get a target's control groups

`GET /issuing/controls/control-groups`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/issuing/controls/control-groups`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `string` scopes: `issuing:controls-read`
- TypeScript: <https://skmtc.dev/checkout/apis/checkout-com-api-reference/docs/issuing/controls/control-groups/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a list of control groups applied to the specified target.

## Query parameters

- `target_id` string, required: The ID of the card or control profile.

## Response `200`

Target's control groups retrieved successfully

- GetControlGroupsArrayResponse: The list of control groups applied to the specified target.
  - `control_groups` GetControlGroupResponse[], required: The list of control groups applied to the specified target.
    - `id` string, required: The control group's unique identifier.
    - `description` string: A description for the control group.
    - `target_id` string, required: The ID of the card or control profile.
    - `fail_if` 'all_fail' | 'any_fail', required: Sets how to determine the result of the group.
    - `controls` AddControlGroupRequestControl[], required: The controls that belong to the group.
      - union: The control to create.
        - object
          - `description` string: A description for the control.
          - `control_type` 'velocity_limit' | 'mcc_limit' | 'mid_limit', required: The control's type. A `velocity_limit` determines how much can be spent over a given period of time. An `mcc_limit` determines the types of businesses from which transactions can be processed. A `mid_limit` specifies the merchants from whom transactions can be processed.
          - `velocity_limit` VelocityLimit, required: The velocity limit, which determines how much a target card can spend over a given timeframe.
            - `amount_limit` integer, required: The amount the target can spend, in minor units.
            - `velocity_window` VelocityWindow, required: The period of time over which the specified `amount_limit` can be spent.
              - …
            - `mcc_list` string[]: The list of <a href= "https://www.checkout.com/docs/resources/codes/merchant-category-codes">merchant category codes</a> (MCCs) that the velocity limit applies to, as four-digit ISO 18245 codes.
            - `mid_list` MidCode[]: The list of merchant identification (MID) codes to allow or block transactions from. <br/> You can provide either `mcc_list` or `mid_list`, but not both.
        - object
          - `description` string: A description for the control.
          - `control_type` 'velocity_limit' | 'mcc_limit' | 'mid_limit', required: The control's type. A `velocity_limit` determines how much can be spent over a given period of time. An `mcc_limit` determines the types of businesses from which transactions can be processed. A `mid_limit` specifies the merchants from whom transactions can be processed.
          - `mcc_limit` MccLimit, required: The <a href= "https://www.checkout.com/docs/resources/codes/merchant-category-codes">merchant category code (MCC)</a> rule, which determines the types of businesses transactions can be processed from.
            - `type` 'allow' | 'block', required: Sets whether to allow or block the list of MCCs supplied.
            - `mcc_list` string[], required: The list of <a href= "https://www.checkout.com/docs/resources/codes/merchant-category-codes">MCCs</a> to allow or block transactions from, as 4-digit ISO 18245 codes.
        - object
          - `description` string: A description for the control.
          - `control_type` 'velocity_limit' | 'mcc_limit' | 'mid_limit', required: The control's type. A `velocity_limit` determines how much can be spent over a given period of time. An `mcc_limit` determines the types of businesses from which transactions can be processed. A `mid_limit` specifies the merchants from whom transactions can be processed.
          - `mid_limit` MidLimit, required: The merchant identification (MID) code rule, which determines the merchants from whom transactions can be processed.
            - `type` 'allow' | 'block', required: Sets whether to allow or block the list of MIDs supplied.
            - `mid_list` MidCode[], required: The list of merchant identification (MID) codes to allow or block transactions from.
    - `is_editable` boolean, required: Indicates whether the control group is set to readonly. Control groups marked as non-editable are predefined by Checkout and are not modifiable by clients.
    - `created_date` string, date-time, required
    - `last_modified_date` string, date-time, required

## Other responses

- `401`: Unauthorized
- `404`: Target not found
- `422`: Invalid data was sent
- `500`: Internal Server Error

---

[API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)