Environments REST API Guide
Retrieve a list of environments from authorized projects.
type of environment
Allows you to filter by any field.
Allows you to search by any field.
Allows you to order results by any field. For desc order prefix field name with -
and provide comman separated values for multiple fields
Limit for the pagination
Offset for the pagination
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"
}
]
}
}
Retrieve details of a specific environment associated with a model.
environment id path parameter
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"
}
}
Retrieve a list of environments associated with a specific model.
model id path parameter
type of environment
Allows you to filter by any field.
Allows you to search by any field.
Allows you to order results by any field. For desc order prefix field name with -
and provide comman separated values for multiple fields
Limit for the pagination
Offset for the pagination
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?