Get an environment

GET

/environments/:environmentId

GET

/environments/:environmentId

$ curl https://api.postman.com/environments/5daabc50-8451-43f6-922d-96b403b4f28e \
>      -H "x-api-key: <apiKey>"

1 {
2   "environment": {
3     "id": "5daabc50-8451-43f6-922d-96b403b4f28e",
4     "name": "Test Environment",
5     "owner": "12345678",
6     "createdAt": "2020-11-05T13:59:22.000Z",
7     "updatedAt": "2020-11-05T13:59:23.000Z",
8     "values": [
9       {
10         "description": "The collection's ID.",
11         "enabled": true,
12         "key": "collectionId",
13         "type": "default",
14         "value": "12ece9e1-2abf-4edc-8e34-de66e74114d2"
15       },
16       {
17         "enabled": true,
18         "key": "apiKey",
19         "secret": true,
20         "source": {
21           "postman": {
22             "secretId": "f5fa5280-18a3-4d93-a706-2fe48b1007dc",
23             "type": "cloud",
24             "vaultId": "453a311c-c5b4-4627-8e51-a3bd48953734"
25           },
26           "provider": "postman"
27         },
28         "type": "default"
29       }
30     ],
31     "isPublic": false
32   }
33 }

Gets information about an environment.

Authentication

x-api-keystring

API Key authentication via header

Path parameters

environmentIdstringRequired

The environment's ID.

Response

Successful Response

environmentobject

Information about the environment.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error