---
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: eJztWW1v3DYS/isEPyXB2pbXdprshwI+p9fLoWiDeIMrzjYWs+Lsig1FqiTlly7034shpV1pJdtrJ+0Bh3xZWxI588w7ObPiAl1qZeGl0XzCf5LOM1CKCSyUuctRe7a0piwcWxjLgLkCU7mQKYOiUDIF2rd/qfmIe1g6Prng77Z28qsRNwXasPS94BO+oT0LKyZKOs9H3GFaWunv+ORixecIFu1p6TM+ubiqrka8AAs5erQuLJCE9/cS7R0fcQ058gk3i4XDQCrNMAc+WXF/V9AXqT0u0fIRz6WWeZnzSTLiAhdQKs8nSTXa0sQ0Q+Y8WC/1khVGah80UMBS6ig1exd3O+YNS5hcMG08K6y5lgLFPh9xvIW8UBjIDwNWMpcP4h3ElcMticB0mc/RMrNgFl2DxKIvrWYFBrDYwXF0L5CWOWdS8CGu798RJ59h2/bEkcw37DDE3OLvpbQo+MTbEgdEdd5KveQV2diiK4x26Oj7OEnoTx/J2p3YDTjmyjRF5xalInap0R61p40tmAe/Odq96nM3898w9R2cFzxYeRleBr2SDxeW2HoZsdUrHqGz9sfGzt54UH1q8fWQt/aFD2sHTJ+DTzNyVrJQsG7P9A2ex8Pir4yEWhmDIKJj88k4GYTxJMdn7R2glLlBwa5BlcikY+Mk6QAbJ0lVVRuLb+CBtUCRIj3m7jGLh9hxHnzpgvWaoHAhyE2B4R9vwePybibAAx/1g8+iQnDYROKayAxyU2rimVoEj2I2J2RlITYPzRfwrS/g+04nRT8IH4777RjvKJAfUrKqRR8gjJoMexHxSb2cQUEeAqrB3H43E6glitYnPuI3IMOihbEzqZ0HnQZ12lLruGIhNSj5R+chUqG1SsUP9UP4sAAZ/7EmfJ7NIf1cP5JG45NAhb7Rj0KPgtTZVdV5kPxeVV3qS/09e/XqZ+Px1asJO0dkF5ta6a5eHAiTuoOWtV+GOMuNRSb1wti8qbbfh4K70XyjgKrrcc904eCms9qRo6P2fLbnTOtNT3SpsI/dZGhxW29zVEYvXcfJDsdVC9VOvFoUm41sjpTLSlcnp9ozpZZeBn+cqxJnS4uoSdKNolvvq22VDGi1C+bM6IVclnXloj3Bvn4YIwHbUvGN9GmGYuYtLBYy3aFenJXWEtECbYrawxKD3uN+RtU7Q6bxhl2jdYTqRbJ3mCQv+5VDoCP/mD0DxBTsEv2aawtLI34LQYfzCXGOKW8T8DNvZpQJduD8sfbqVr1Yk2FzXFBkFdakiCIUTlOjuSUzYDe9nVQjniEon921ks/uJkhJCkJQE9kg6Sqb6iOUOuj4KXymW8eCjaANuZ440ZaNJWckcovR3BiFoHuM3mtBtQodRa3PsOfB0jEZPQtSL69xbfnIL5wiMnDdkymdDatQgL30IdY2FH+kBPpLDCpaUdfRJ6S3Ly18z8lS8WC9Cx9auY6FwKpbWE8/sj127uOJs62isPZdV09RQ98y07fM9C0zfc3M1DulPzGFdO7MAwfEJpEwb7rR//q7N2951bkTPJF1vZOBcyaVdB9gN9JnWzC6XE9ef/dm6zzZXD4et/jPa1u3tjeqj02hLYO3rjM7CVc6tC0Jw3Zjd7qnvH17WHWuTM9hqMCF3OWoB5EZVpPbhfu46tzRBrjHoz6VQPC452WOwwY+/2XvzevkkH2anjFa5TzkBSG8yfAeJ6N+Sc28a+9xMj7aO0z2ksPp4XhydDw5ef1fXnUukH8/0qDlGsEucO8/PXys+0r8oSPGh9jRQNFeXY348a+/9vtQZ0oSWLTWWLZuWzFRUoeGSX0NSgomdVF6Rrc46VzIL+sm5ldrVsUr95kRpPyAhzop6BwsceCitln9eCD/azr9wOIOlhpBqaSw6FD7ptG07genbX28wP3l/ogdJwn9HNLPEf0cd+v3cUJlNO1iuScIT1kOlKJxzyIImCuseQVcPgPPKPcvjZV/oIvY0F6jZXTFL+3WmWoOYkZKROfJzaPadgAxtxIXI5aVOegNktaqJkNEcESu0cYl/wcI9jEyveT04pOG0mcBsrjkXeW0VxPExqKPgxRC0r9AXXwPUjkGc1P6Dawun2koEYFPiLocFMU1Cha0qz1IjWLt0m0PrqoYISdDEXIe1b8dITJWaXIg0Ew6V2Jz3jv98J45KfD/LDRcWxG1M5xQaJwkY/o5erl1tvyfRQUJazWoWVw0iyr72+Ljfc2e1a7zA62JkUJvZIrsk4ZrkIqo9gJmcPtfGjqnmpUabwtMqfhHkUya0sFa7LMP8djl7R2DJUjNFHi0TdQEXD4zNBFbhiFBATTs4gfb87EwGiOJ4uCrtIpPeOZ94SYHB1DIfV0qVSjwFLb7qck5jVKaado5RUp08PZMba0KItRMoEJmDIuoCRb++WdT4v/9n2mosNSKpO31tYgav/vJfsI3ZbXV1STtF8b5HELU1sOmnwYHRtvWWG1ywBfNJaOYHm/9QaFAhtZd0OGq1vhFbyJJuSEzztO31WoODj9ZVVX0Os7NyA5COnJDwScLUA4fQP81JiiDYnzGu/bUMww3+IRzmvI9Dd5TR4oPwGlmXc9E86K5G79kXzB1fABfb9qyAXpFD1YS0jB1DhdrgTbYO+4+TVMs2uL1qhNRWUf2jz9MacDTDbmtEAvUm1aWvmvRXq3iiqn5jLqqeCOCp2deXVVV9SeYNRas
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","maximum":200,"description":"The maximum number of results to return per page. The maximum allowed value is 200.","example":200}}},"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>