> ## Documentation Index > Fetch the complete documentation index at: https://docs.roark.ai/llms.txt > Use this file to discover all available pages before exploring further. # List environments > Returns a paginated list of environments: the project's own plus the environments Roark curates and shares across every project. Reference one by id when setting a customer flow variant's environment. ## OpenAPI ````yaml /api-reference/openapi.documented.json get /v1/simulation/environment openapi: 3.1.0 info: title: Roark Analytics API description: >- The Roark Analytics API gives you access to the same API that powers the award winning Roark Analytics platform. version: 1.0.0 servers: - description: Production url: https://api.roark.ai security: - Bearer: [] tags: - name: Agent - name: Agent Endpoint - name: Call - name: Chat - name: Metric - name: Metric Policy - name: Metric Collection Job - name: Simulation Persona - name: Simulation Environment - name: Simulation Customer Flow - name: Simulation Customer Flow Variant - name: Simulation Scenario - name: Simulation Run Plan - name: Simulation Run Plan Job - name: Simulation Job - name: HTTP Request Definition - name: Webhook - name: Issue - name: Knowledge Base - name: Call Analysis - name: Health paths: /v1/simulation/environment: get: tags: - Simulation Environment summary: List environments description: >- Returns a paginated list of environments: the project's own plus the environments Roark curates and shares across every project. Reference one by id when setting a customer flow variant's environment. operationId: getV1SimulationEnvironment parameters: - in: query name: limit schema: type: integer minimum: 1 maximum: 50 default: 20 - in: query name: after schema: type: string responses: '200': description: List of environments content: application/json: schema: $ref: '#/components/schemas/GetEnvironmentsResponse' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Validation error example: type: validation code: invalid_parameter message: The request was invalid param: email description: Bad Request '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Authentication error example: type: authentication code: unauthorized message: Authentication required description: Unauthorized '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Permission error example: type: forbidden code: permission_denied message: You do not have permission to access this resource description: Forbidden '429': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Rate limit error example: type: rate_limit code: too_many_requests message: Rate limit exceeded description: Too Many Requests '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Server error example: type: internal code: internal_error message: Internal server error description: Internal Server Error x-codeSamples: - lang: JavaScript source: >- import Roark from '@roarkanalytics/sdk'; const client = new Roark({ bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted }); const simulationEnvironments = await client.simulationEnvironment.list(); console.log(simulationEnvironments.data); - lang: Python source: |- import os from roark_analytics import Roark client = Roark( bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"), # This is the default and can be omitted ) simulation_environments = client.simulation_environment.list() print(simulation_environments.data) components: schemas: GetEnvironmentsResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/EnvironmentResponse' pagination: type: object properties: total: type: number description: Total number of items hasMore: type: boolean description: Whether there are more items to fetch nextCursor: type: - string - 'null' description: Cursor for the next page of items required: - total - hasMore - nextCursor required: - data - pagination description: >- Paginated list of environments: the project's own plus the shared Roark-curated ones ErrorResponse: type: object properties: type: type: string enum: - validation - authentication - forbidden - not_found - conflict - payment_required - rate_limit - internal description: The error type category examples: - validation - authentication code: type: string description: Machine-readable error code identifier examples: - invalid_parameter - missing_required_field - unauthorized message: type: string description: Human-readable error message examples: - The request was invalid - Authentication required param: type: string description: The parameter that caused the error (if applicable) examples: - email - user_id details: description: Additional error context information required: - type - code - message EnvironmentResponse: type: object properties: id: type: string format: uuid source: type: string enum: - SYSTEM - CUSTOM default: CUSTOM systemKey: type: - string - 'null' name: type: string minLength: 1 description: type: - string - 'null' backgroundNoise: type: string enum: - NONE - AIRPORT - CHILDREN_PLAYING - CITY - COFFEE_SHOP - DRIVING - OFFICE - THUNDERSTORM default: NONE createdAt: type: string description: Creation timestamp in ISO 8601 format updatedAt: type: string description: Last update timestamp in ISO 8601 format required: - id - source - name - backgroundNoise - createdAt - updatedAt description: >- A simulation environment: the ambient conditions a customer flow variant runs under. Environments with source SYSTEM are curated by Roark and shared across every project. securitySchemes: Bearer: type: http scheme: bearer bearerFormat: JWT ````