---
id: deployment-group-list
title: "List deployment groups"
description: "List all deployment groups for a specific application."
sidebar_label: "List deployment groups"
hide_title: true
hide_table_of_contents: true
api: eJztWVtv28YS/iuLfUoC2ZZvaaKHAj5OLy6KNogVnOLYhjDijsRtyF12d+hLBf73YnZJiRRlW3bSHqDIi2ySuzPf3HdnFlKhT5wuSFsjR/Jn7UlAlgmFRWbvcjQk5s6WhRcz6wQIX2CiZzoRUBSZToD37V4aOZAEcy9HF/Ld2k55NZC2QBeWnik5kivak7BilGlPciA9JqXTdCdHFws5RXDoTkpK5ejiqroayAIc5EjofFigGe8fJbo7OZAGcpQjaWczj4FUkmIOcrSQdFfwF20I5+jkQOba6LzM5Wg4kApnUGYkR8NqsKaJcYrCEzjSZi4Kqw0FDRQw1yZKLd7F3V6QFUOhZ8JYEoWz11qh2pUDibeQFxkG8psBZzrXD+LdiCuHWxZBmDKfohN2Jhz6BolDKp0RBQaw2MFxeC+QljknWslNXM/eMSdKsW175sjm2+wwzNzhH6V2qOSIXIkbRPXktJnLim3s0BfWePT8/WA45D99JEt3EjfghS+TBL2flRmzS6whNMQbWzD3fve8e9Hnbqe/Y0IdnBcyWHkeXga9sg8XjtmSjtjqFY/QWfpjY2eyBFmfWny9yVv7woe1G0yfAyUpOytbKFi3Z/oGz+Nh8XdGQq2M7aTtyxn9G9XKwzvsD4frYlfVyo4rpuAcsP9rwtw/ZscQEZ6ASh9QNq7uQ+jaAsM/5IBwfjdRQCAH/ZBymCF4bOJrSWQCuS0N80wcAqGaTBlZWajVQ/MFqPUFqO9KWvVD6+FoXo/cjv7kPqegWvQNhNGwz1xEfNrMJ1Cw3SFrMLffTRQajar1SQ7kDeiwaGbdRBtPYJKgTlcaE1fMtIFM/9l5iFR4bZbFD/VD+DADHf9xNnyeTCH5VD+yRuOTwgyp0U+GhIrV2VXVeZD8XlVdmkvzrXj16hdL+OrVSJwjiotVBfRXL/aUTfxey9ovQ/Tk1qHQZmZd3tTQb0MZXWm+UUDV9bhnunBw00ntyNFRez7bc6blpie6VNgnblJ0uK63KWbWzH3HyfYPqhaqrXi1KDYbxRQ5Q5W+Tjm1Z2qjSQd/nGYlTuYO0bCkK0W33lfrKtmg1S6YU2tmel7W9Yj3BPvSZowMbE3FN5qSFNWEHMxmOtkiL56WzjHRAl2ChmCOQe9xv+CazIkTb8Q1Os+oXgx39ofDl/16oNCzf0yeAWIMbo605NrC0ojfQtDhfMycY8pbBfyE7IQzwRacP9Re3aoNSzJiijOOrMLZBFGFcmhrNLdsBuymt+NqIFOEjNK7VvLZ3gQJS8EIaiIrJF1lc9WD0gQdP4XPeK3YrwRtyPXEibZsLDlhkVuMptZmCKbH6MworlXoOWopxZ4Hay909CxISF/j0vKRXzgbpOC7500+8VWhAJOmEGsrij9wAv01BhWvqOvoE9Lb5xa+52SpeFzehg+vXMZCYNUtrCcfxI44p3iObKsorH3X1VPU0NfM9DUzfc1MXzIz9U7pT0whnZvwhgNik0gE2W70v/7mzVtZde4ET2Rd7xTgvU003wfEjaZ0DUaX6/Hrb96snSeby8fjFv9laevW9kb1sdWzZvDWdWYr4UqPriVh2G7dVveUt2/3q86V6TkMM/Ahd3nuLKRW1OS24X5Qde5oG7jHoz6XQCDcIZ3jZgOf/7rz5vVwX3wcnwpe5QnyghHepHiPk3EXpGbetffB8OBwZ3+4M9wf7x+MDo9Gx6//J6vOBfKfRxq0XCPYBu79p4cPdbdIPnTEeB/7FKjaq6uBPPrtt3536TTTDBads04sm1FCldx3EdpcQ6aV0KYoSfAtTnsf8suyNfnFWlDxyn1qFSs/4OEmDXoPc9xwUVutfjyQfxyP34u4QyRWcSopHHo01LSPll3epK2PF7g73x2Io+GQf/b555B/jrr1+2jIZTTpYrknCE9EDpyiccchKJhmWPMKuCgFEpz759bpP9FHbOiu0Qm+4pdu7Uw1BTVhJaIndvOoti1ATJ3G2UCkZQ5mhaS1qskQERyTa7RxKf8DSnyITC8lv/hooKQ0QFaXsquc9mqG2Fj0cZBKaf4XuDdPoDMvYGpLWsHq8hmHEhH4hKjLIeO4RiWCdg2B5iZa49JtD66qGCHHmyLkPKp/PUJ0rNLsQGCE9r7E5rx38v5MeK3wXxYavq2I2hmOOTSOhwf8c/hy7Wz5f4sKFtYZyCZx0SSq7B+Lj7Oavahd5zteEyOF3+gExUcD16AzptoLmI3b/9bQOTGiNHhbYMLFP4pkk4QP1mpXvI/HLnJ3AuagjciA0DVRE3BRannONQ+t/wJ4hCX31qdeYeDFEsVxVukyOZIpUeFHe3tQ6F1TZlmRAXHY7iY2lzwgaWZk5xwp0cHbk7KlKphQM1cKmTEs4iZY+Of7psT/9N9xqLDciuTt9bWIG7+7w92hXJXVVleTtV9YTzmEqK1HSD9vHAOtW2OxygGfNW2MYhLe0l6RgQ6tu6DDRa3xi96ckXNDaj3xt8ViCh4/uqyq+HWchrEdlPbshkqOZpB5fAD9l5iLbBTjE961Z5nXkJW8SPLs7mnwnjoofABOM8F6JpoXzd34pfiMWeID+HrTlhXQK35wmpGGWXK4WCt0wd5x90mSYNEWr1edmMoysn/4bswDnm7IrYVYoN60ssxdi/ZiEVeM7Sc0VSUbEYifZXVVVdVfhWwIdw==
sidebar_class_name: "get api-method"
info_path: docs/api/deployments
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"List deployment groups"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/deployment_group"}
  context={"endpoint"}
>
  
</MethodEndpoint>



List all deployment groups for a specific application.


<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"in":"query","name":"offset","schema":{"type":"integer","minimum":0,"default":0},"description":"The starting point for pagination. Defaults to 0 if not provided.","example":0},{"in":"query","name":"limit","schema":{"type":"integer"},"description":"The maximum number of results to return per page.","example":30},{"in":"query","name":"application_id","description":"The ID of the application to list deployment groups for.","required":true,"schema":{"type":"string"}}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","content":{"application/json":{"schema":{"type":"object","required":["paging","results"],"properties":{"paging":{"type":"object","required":["offset","limit","total"],"properties":{"total":{"type":"integer","description":"The total number of results matching the query.","example":30},"offset":{"type":"integer","minimum":0,"description":"The starting point for pagination. Defaults to 0 if not provided.","example":0},"limit":{"type":"integer","description":"The number of results returned per page. Defaults to 30.","example":30}}},"results":{"type":"array","items":{"type":"object","required":["id","status","deployments","scopes","strategy_data","application_id","release_id","deployments_amount","created_by","updated_by","created_at","updated_at"],"properties":{"id":{"type":"string","description":"The ID of the deployment group.","example":"1"},"status":{"type":"string","enum":["creating_approval","creating_approval_denied","creating","waiting_for_instances","running","finalizing","finalized","cancelling","cancelled","failed","rolling_back","rolled_back","deleting","deleted"],"description":"Status of the deployment group.\n\n> **Note**: See [Deployments](/docs/deployments) for more information.\n>\n","example":"running"},"deployments":{"type":"array","items":{"type":"object","required":["scope_id","strategy","strategy_data"],"properties":{"scope_id":{"type":"string","description":"The ID of the scope where the deployment belongs.","example":12},"strategy":{"type":"string","description":"The deployment strategy being used.","enum":["initial","blue_green"],"example":"blue_green"},"strategy_data":{"type":"object","description":"Configuration data for the deployment strategy.","properties":{"switched_traffic":{"type":"integer","description":"Current percentage of traffic on the new version (0-100).","example":30},"desired_switched_traffic":{"type":"integer","description":"Target traffic percentage for the new version.","example":50},"amount_instances_to_wait":{"type":"integer","description":"Required number of instances before proceeding to the next step.","example":5},"healthy_instances":{"type":"integer","description":"Current count of healthy instances.","example":3},"launched_instances":{"type":"integer","description":"Total number of instances launched.","example":5},"switch_traffic_step":{"type":"boolean","description":"Indicates whether the deployment is in the active traffic switching phase.","example":true}}}},"title":"deploymentGroupObject"}},"scopes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the scope where the deployment belongs.","example":12},"name":{"type":"string","description":"The name for the scope.","example":"AR - Staging"}},"title":"scopeDeploymentGroup"}},"strategy_data":{"type":"object","description":"Configuration data for the deployment strategy.","properties":{"switched_traffic":{"type":"integer","description":"Current percentage of traffic on the new version (0-100).","example":30},"desired_switched_traffic":{"type":"integer","description":"Target traffic percentage for the new version.","example":50},"amount_instances_to_wait":{"type":"integer","description":"Required number of instances before proceeding to the next step.","example":5},"healthy_instances":{"type":"integer","description":"Current count of healthy instances.","example":3},"launched_instances":{"type":"integer","description":"Total number of instances launched.","example":5},"switch_traffic_step":{"type":"boolean","description":"Indicates whether the deployment is in the active traffic switching phase.","example":true}}},"application_id":{"type":"string","description":"The ID of the application the deployment group belongs to.","example":"6789"},"release_id":{"type":"string","description":"The ID of the release associated with the deployment.","example":"5678"},"deployments_amount":{"type":"integer","description":"Number of deployments in the group","example":5},"created_by":{"type":"string","description":"The user ID of the creator of the deployment group.","example":991},"updated_by":{"type":"string","description":"The user ID of the last person who updated the deployment group.","example":992},"created_at":{"type":"string","format":"date-time","description":"The ISO-8601 UTC timestamp of when the deployment group was created.","example":"2023-10-01T12:34:56Z"},"updated_at":{"type":"string","format":"date-time","description":"The ISO-8601 UTC timestamp of when the deployment group was last updated.","example":"2023-10-01T12:34:56Z"}},"title":"deploymentGroupResponse"}}},"title":"deploymentGroupPaginatedResponse"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>