# Postman

> Manage Postman workspaces, collections and environments; run monitors and inspect mock servers.

App · 21 actions. Web page: https://docs.lodol.com/docs/integrations/postman

## Actions

### Create collection

Create collection.

**Inputs**

- Name (`name`, text, required): Name.
- Workspace (`workspace`, text): Workspace.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Create environment

Create environment.

**Inputs**

- Name (`name`, text, required): Name.
- Workspace (`workspace`, text): Workspace.
- Values (`values`, list): Values.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Create workspace

Create workspace.

**Inputs**

- Name (`name`, text, required): Name.
- Workspace type (`workspace_type`, text, required): Workspace type. One of: `personal`, `team`, `private`, `public`, `partner`.
- Description (`description`, text): Description.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Delete collection

Delete collection.

**Inputs**

- Collection (`collection_id`, text, required): Collection id.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Delete environment

Delete environment.

**Inputs**

- Environment (`environment_id`, text, required): Environment id.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Delete workspace

Delete workspace.

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get collection

Get collection.

**Inputs**

- Collection (`collection_id`, text, required): Collection id.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get current user

Get current user.

**Inputs**: None.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get environment

Get environment.

**Inputs**

- Environment (`environment_id`, text, required): Environment id.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get mock

Get mock.

**Inputs**

- Mock (`mock_id`, text, required): Mock id.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get monitor

Get monitor.

**Inputs**

- Monitor (`monitor_id`, text, required): Monitor id.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get workspace

Get workspace.

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List collections

List collections.

**Inputs**

- Workspace (`workspace`, text): Workspace.
- Limit (`limit`, number): Limit. From 1 to 100.
- Offset (`offset`, number): Offset. At least 0.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List environments

List environments.

**Inputs**

- Workspace (`workspace`, text): Workspace.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List mocks

List mocks.

**Inputs**

- Workspace (`workspace`, text): Workspace.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List monitors

List monitors.

**Inputs**

- Workspace (`workspace`, text): Workspace.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List workspaces

List workspaces.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100.
- Cursor (`cursor`, text): Cursor.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Rename collection

Rename collection.

**Inputs**

- Collection (`collection_id`, text, required): Collection id.
- Name (`name`, text, required): Name.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Rename environment

Rename environment.

**Inputs**

- Environment (`environment_id`, text, required): Environment id.
- Name (`name`, text, required): Name.

**Outputs**: Response.

- `data` (object): Data.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Run monitor

Start a monitor in the background. Its collection can send requests that change other services. Use Get monitor to check lastRun for the results.

**Inputs**

- Monitor (`monitor_id`, text, required): The monitor to run.

**Outputs**

- `data` (object): The accepted monitor run.
- `has_more` (true/false): Always false.
- `next_cursor` (text): No pagination token.

**Example output**

```json
{
  "data": {
    "run": {}
  },
  "has_more": false,
  "next_cursor": null
}
```

### Set environment variables

Set the values of variables in a Postman environment, such as a fresh token or a new base URL, adding any it doesn't have yet. Other variables are left as they are, and a secret variable stays secret.

**Inputs**

- Environment (`environment_id`, text, required): The environment to change.
- Variables (`variables`, object, required): Each variable's name and the value to give it. A name the environment doesn't have yet is added.

**Outputs**: Response.

- `data` (object): The environment after the change.
- `has_more` (true/false): Whether more records are available.
- `next_cursor` (text): Continuation token, if another page exists.

**Example output**

```json
{
  "data": {
    "added": [
      "baseUrl"
    ],
    "environment": {
      "id": "5daabc50-8451-43f6-922d-96b403b4f28e",
      "name": "Staging",
      "values": [
        {
          "enabled": true,
          "key": "baseUrl",
          "type": "default",
          "value": "https://staging.example.com"
        }
      ]
    },
    "updated": []
  },
  "has_more": false,
  "next_cursor": null
}
```
