Find environments | Opik Documentation

GET/v1/private/environmentsFind environments

Find environments for the workspace. Capped at the workspace limit (default 20).

Responses

objectEnvironmentPage_Public

contentarray of object

Show child attributes

Show array items

colorstring

maxLength 20 · minLength 0

created_atstring · date-time

created_bystring

descriptionstring

maxLength 500 · minLength 0

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

namestringrequired

maxLength 150 · minLength 0 · pattern ^[A-Za-z0-9_-]+$

positioninteger · int32

pageinteger · int32

sizeinteger · int32

sortableByarray of string

Show child attributes

totalinteger · int64

Example response

{
  "content": [
    {
      "color": "string",
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "description": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "name": "string",
      "position": 0
    }
  ],
  "page": 0,
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}

Examples

curl -X GET 'http://localhost:5173/api/v1/private/environments'

const response = await fetch('http://localhost:5173/api/v1/private/environments', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/environments', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/environments")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "http://localhost:5173/api/v1/private/environments", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/environments");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/environments"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/environments")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:5173/api/v1/private/environments");
using var response = await client.SendAsync(request);

{
  "content": [
    {
      "color": "string",
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "description": "string",
      "id": "00000000-0000-0000-0000-000000000000",
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "name": "string",
      "position": 0
    }
  ],
  "page": 0,
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}