> ## Documentation Index
> Fetch the complete documentation index at: https://docs.poly.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List deployments for an environment



## OpenAPI

````yaml GET /v1/agents/{agentId}/deployments
openapi: 3.1.0
info:
  title: PolyAI Agents API
  version: 1.0.3
  description: >-
    Build and deploy PolyAI agents programmatically. Create agents, manage
    branches, update behavior rules, configure knowledge bases, provision
    telephony, publish deployments, and update real-time configs.
servers:
  - url: https://api.us.poly.ai
    description: US region
  - url: https://api.uk.poly.ai
    description: UK region
  - url: https://api.eu.poly.ai
    description: EU region
security:
  - ApiKeyAuth: []
tags:
  - name: Agents
    description: Create, list, duplicate, and delete agents.
  - name: Branches
    description: Create isolated branches for parallel development and merge back to main.
  - name: Agent Behavior
    description: >-
      Read and update an agent's behavior rules (system prompt, interaction
      style, edge cases).
  - name: Knowledge Base
    description: Manage knowledge base topics used for retrieval and tool invocation.
  - name: Variants
    description: Manage site-specific variations of an agent using attributes and variants.
  - name: Deployments
    description: Publish drafts, promote across environments, and roll back deployments.
  - name: Connectors
    description: >-
      Manage telephony connectors that bind phone numbers to voice
      infrastructure.
  - name: Phone Numbers
    description: Provision, reassign, and delete phone numbers on an agent's connectors.
  - name: Real-Time Configs
    description: Update runtime values (e.g. opening hours) outside the publish workflow.
paths:
  /v1/agents/{agentId}/deployments:
    parameters:
      - name: agentId
        in: path
        required: true
        schema:
          type: string
    get:
      tags:
        - Deployments
      summary: List deployments for an environment
      parameters:
        - name: environment
          in: query
          required: true
          schema:
            enum:
              - sandbox
              - pre-release
              - live
            type: string
          description: Environment to list deployments for (sandbox, pre-release, live)
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Max number of deployments to return
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDeploymentsResponse'
        '400':
          description: Validation error
        '401':
          description: Unauthorized – missing or invalid API key
        '403':
          description: Forbidden – insufficient permissions
components:
  schemas:
    GetDeploymentsResponse:
      description: Deployments for the requested environment, ordered newest first.
      type: object
      properties:
        deployments:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentResponse'
      required:
        - deployments
    DeploymentResponse:
      description: |-
        A deployment of an agent version to a specific environment, plus
        who created it and when.
      type: object
      properties:
        id:
          description: Unique deployment identifier
          type: string
        accountId:
          description: Account this deployment belongs to
          type: string
        agentId:
          description: Agent (project) this deployment belongs to
          type: string
        environment:
          description: Environment (sandbox, pre-release, live)
          type: string
        artifactVersion:
          description: Artifact version reference
          type: string
        version:
          description: Version hash linking deployments across environments
          type: string
        createdBy:
          description: Email of user who created the deployment
          type: string
        createdAt:
          description: ISO 8601 timestamp of when the deployment was created
          type: string
        metadata:
          description: Deployment metadata (e.g. deployment_message)
          type: object
      required:
        - id
        - accountId
        - agentId
        - environment
        - artifactVersion
        - version
        - createdBy
        - createdAt
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````