Environment GET

GET 
/environments/:environmentId

Required Permissions: Environment Get or Environment Admin

Request

Path Parameters

environmentId integerrequired

The id of the Environment that you wish to get data from.

Responses

200

A JSON Object containing a single environment's data.

application/json

Schema

Schema

environment object
id integer
name string
description string
type
Possible values: [development, production]
archived boolean
created_at date-time
created_by_user_id integer
updated_at date-timenullable
updated_by_user_id integernullable
created_by object
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email
updated_by objectnullable
archived boolean
avatar objectnullable
avatar_file_upload_url string
created_at date-time
created_by_user_id integer
Possible values: >= 1
department string
email email

Example (from schema)

{
  "environment": {
    "id": 0,
    "name": "Sandbox",
    "description": "Our sandbox environment.",
    "archived": false,
    "created_at": "2024-12-12T13:15:10.432Z",
    "created_by_user_id": 0,
    "updated_at": "2024-12-12T13:15:10.432Z",
    "updated_by_user_id": 0,
    "created_by": {
      "archived": false,
      "avatar": {},
      "avatar_file_upload_url": "/cropUrl/100x100/1.png",
      "created_at": "2024-12-12T13:15:10.432Z",
      "created_by_user_id": 0,
      "department": "Marketing",
      "email": "[email protected]"
    },
    "updated_by": {
      "archived": false,
      "avatar": {},
      "avatar_file_upload_url": "/cropUrl/100x100/1.png",
      "created_at": "2024-12-12T13:15:10.432Z",
      "created_by_user_id": 0,
      "department": "Marketing",
      "email": "[email protected]"
    }
  }
}

Loading...