---
title: "List deployment groups"
method: GET
path: "/v1/default/deployment-groups"
tags: ["deployment-groups-api", "deployment-visibility-project"]
---

# List deployment groups

`GET /v1/default/deployment-groups`

## Request

- Base URL: `https://api.bymason.com`
- URL: `https://api.bymason.com/v1/default/deployment-groups`
- Auth: API key in header `Authorization`

Fetches a page of groups in your account.

## Query parameters

- `limit` integer
- `before` string
- `after` string
- `name` string

## Response `200`

List groups response

- object
  - `data` DeploymentGroup[]: Paginated list of groups
    - `id` string, uuid, required: unique ID for the group
    - `name` string, required: Group name
    - `createdAt` string, date-time, required: Date group was created
    - `updatedAt` string, date-time, required: Date group was last updated
    - `description` string: Description of the group
    - `deviceFamily` 'D03' | 'F07' | 'D450' | 'D450A' | 'D450A1' | 'D450B' | 'C210' | 'F210' | 'F450' | 'G430' | 'G450' | 'I3399A' | 'A4100' | 'D215'
    - `apiLevel` 23 | 25 | 27 | 30
    - `deviceCount` integer, required: Number of devices currently in the group
    - `devicesUpToDateCount` integer: Of the devices in the group, indicates how many are running *all* the desired deployment versions
    - `apps` object[]: Details of each app (APK) deployed to the group
      - `createdAt` string: Date app was deployed to group
      - `name` string: Package name of the app
      - `version` string
    - `config` object: Details of the configuration deployed to the group
      - `createdAt` string: Date configuration was deployed to group
      - `name` string: Configuration name
      - `version` string
    - `os` object: Details of the OS deployed to the group
      - `createdAt` string: Date OS was deployed to group
      - `name` string
      - `version` string
  - `nextPage` string: Token for the next page of results. To use, set the `after` query paramter with this value.
  - `prevPage` string: Token for the previous page of results. To use, set the `before` query parameter with this value.

## Other responses

- `400`: Bad request
- `404`: The resource requested does not exist
- `500`: Internal server error

---

[API](https://skmtc.dev/bymason/apis/mason-platform-apis-docs.md) - [All operations](https://skmtc.dev/bymason/apis/mason-platform-apis-docs/llms.txt) - [OpenAPI document](https://skmtc.dev/bymason/apis/mason-platform-apis-docs/revisions/365b123b04d4?raw)