---
title: "Get control group details"
method: GET
path: "/issuing/controls/control-groups/{controlGroupId}"
tags: ["Control groups"]
---

# Get control group details

`GET /issuing/controls/control-groups/{controlGroupId}`

## Request

- Base URL: `https://{prefix}.api.sandbox.checkout.com`
- URL: `https://{prefix}.api.sandbox.checkout.com/issuing/controls/control-groups/{controlGroupId}`
- 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/:controlGroupId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves the details of a control group you created previously.

## Path parameters

- `controlGroupId` string, required: The control group's unique identifier.

## Response `200`

Control group retrieved successfully

- AddControlGroupResponse: The control group's details.
  - `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.
            - `type` 'daily' | 'weekly' | 'monthly' | 'all_time', required: The velocity window's unit of time.
          - `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
  - `_links` ControlGroupLinks, required: The links related to the control group.
    - `self` IssuingLink, required
      - `href` string, required: The link URL.
      - `actions` string[], required: The HTTP Methods that can be performed on the link.
      - `types` string[], required: The Content Types for the link to the resource

## Other responses

- `401`: Unauthorized
- `404`: Control group not found
- `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)