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

# List deployments

`GET /v1/default/deployments`

## Request

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

Fetches a page of deployments.

## Query parameters

- `limit` integer
- `before` string
- `after` string
- `name` string
- `type` 'ota' | 'config' | 'apk'
- `version` string
- `groupId` string
- `isActive` boolean

## Response `200`

List deployments response

- object
  - `data` Deployment[]: Paginated list of deployments
    - `id` string, uuid: Unique identifier for the deployment
    - `artifact` DeployedArtifact: The artifact deployed to a group
      - `name` string: Name of the deployed artifact
      - `type` 'ota' | 'config' | 'apk'
      - `version` string: Version of the deployed artifact
    - `createdAt` string, date-time: Timestamp for when the deployment was created
    - `updatedAt` string, date-time: Timestamp for when the deployment was created
    - `groupId` string, uuid: The group id the deployment belongs to
    - `deployInsecure` boolean: Set to true for devices to download the update over http
    - `isActive` boolean: Whether the deployment is active or not
  - `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

- `404`: Resource(s) not found
- `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)