Environments REST API Guide

List Environments

get

Retrieve a list of environments from authorized projects.

Authorizations
Query parameters
typestring · enumOptional

type of environment

Possible values:
filterstringOptional

Allows you to filter by any field.

searchstringOptional

Allows you to search by any field.

orderingstringOptional

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitintegerOptional

Limit for the pagination

offsetintegerOptional

Offset for the pagination

Responses
200
List of environments from authorized projects
application/json
Responseall of
get
GET /v3/environments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "PRE_PRODUCTION",
        "row_count": 1,
        "model": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "version": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "created_at": "2025-07-09T06:16:11.093Z",
        "updated_at": "2025-07-09T06:16:11.093Z"
      }
    ]
  }
}

Get environment of a model

get

Retrieve details of a specific environment associated with a model.

Authorizations
Path parameters
env_idstring · uuidRequired

environment id path parameter

Responses
200
Details of the environment associated with the specified ID
application/json
Responseall of
get
GET /v3/environments/{env_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "PRE_PRODUCTION",
    "row_count": 1,
    "model": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "version": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "created_at": "2025-07-09T06:16:11.093Z",
    "updated_at": "2025-07-09T06:16:11.093Z"
  }
}

List of environments of a model

get

Retrieve a list of environments associated with a specific model.

Authorizations
Path parameters
model_idstring · uuidRequired

model id path parameter

Query parameters
typestring · enumOptional

type of environment

Possible values:
filterstringOptional

Allows you to filter by any field.

searchstringOptional

Allows you to search by any field.

orderingstringOptional

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitintegerOptional

Limit for the pagination

offsetintegerOptional

Offset for the pagination

Responses
200
List of environments associated with the specified model
application/json
Responseall of
get
GET /v3/models/{model_id}/environments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "PRE_PRODUCTION",
        "row_count": 1,
        "model": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "version": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "created_at": "2025-07-09T06:16:11.093Z",
        "updated_at": "2025-07-09T06:16:11.093Z"
      }
    ]
  }
}

Last updated

Was this helpful?