# Retool

> Manage Retool apps, folders and groups, and inspect users, resources, workflows and environments.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/retool

## Actions

### Clone app

Copy an existing app into a folder and return the copy.

**Inputs**

- App (`app_id`, text, required): The app ID.
- New app name (`new_app_name`, text, required): The name of the new app
- Folder (`folder_id`, text): The id of the folder

**Outputs**

- `data` (object): A single app

**Example output**

```json
{
  "data": {
    "data": {
      "app_type": "classic",
      "created_at": "example",
      "description": "example",
      "folder_id": "example",
      "id": "example",
      "is_mobile_app": false,
      "is_module": false,
      "name": "example",
      "protected": false,
      "published_app_identifier": "example",
      "published_app_url": "example",
      "release_version": "example",
      "shortlink": "example",
      "synced": false,
      "updated_at": "example"
    },
    "success": true
  }
}
```

### Create folder

Create a folder and return it.

**Inputs**

- Name (`name`, text, required): The name of the folder.
- Parent folder id (`parent_folder_id`, text): The ID of the parent folder.
- Folder type (`folder_type`, text, required): The type of the folder. One of: `app`, `workflow`, `resource`, `agent`, `library`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": {
      "created_at": "example",
      "folder_type": "app",
      "id": "example",
      "is_system_folder": false,
      "legacy_id": "example",
      "name": "example",
      "parent_folder_id": "example",
      "updated_at": "example"
    },
    "success": true
  }
}
```

### Create group

Create a group and return it.

**Inputs**

- Name (`name`, text, required): The name of the group.
- Members (`members`, list): Users to add to the group.
- Universal app access (`universal_app_access`, text): The universal app access level for the group. This denotes the access level that this group has for all apps. One of: `none`, `use`, `edit`, `own`.
- Universal resource access (`universal_resource_access`, text): The universal resource access level for the group. This denotes the access level that this group has for all resources. One of: `none`, `use`, `edit`, `own`.
- Universal workflow access (`universal_workflow_access`, text): The universal workflow access level for the group. This denotes the access level that this group has for all workflows. One of: `none`, `use`, `edit`, `own`.
- Universal query library access (`universal_query_library_access`, text): Level of access that the group has to the Query Library. One of: `none`, `use`, `edit`.
- User invites (`user_invites`, list): A list of user invites that will be added to the group.
- User list access (`user_list_access`, true/false): Whether the group has access to the user list.
- Audit log access (`audit_log_access`, true/false): Whether the group has access to the audit log.
- Unpublished release access (`unpublished_release_access`, true/false): Whether the group has access to unpublished releases.
- Usage analytics access (`usage_analytics_access`, true/false): Whether the group has access to usage analytics.
- Theme access (`theme_access`, true/false): Whether the group has access to edit themes.
- Account details access (`account_details_access`, true/false): Whether the group has access to account details.
- Landing page app id (`landing_page_app_id`, text): The app ID of the landing page.
- Created at (`created_at`, text): Created at.
- Updated at (`updated_at`, text): Updated at.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": {
      "account_details_access": false,
      "audit_log_access": false,
      "created_at": "example",
      "id": 1.0,
      "landing_page_app_id": "example",
      "legacy_id": 1.0,
      "members": [],
      "name": "example",
      "theme_access": false,
      "universal_app_access": "none",
      "universal_query_library_access": "none",
      "universal_resource_access": "none",
      "universal_workflow_access": "none",
      "unpublished_release_access": false,
      "updated_at": "example",
      "usage_analytics_access": false,
      "user_invites": [],
      "user_list_access": false
    },
    "success": true
  }
}
```

### Delete folder

Delete a folder.

**Inputs**

- Folder (`folder_id`, text, required): The id of the folder
- Recursive (`recursive`, true/false): Should the folder's contents also be deleted? (Only supported for app folders.)

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Delete group

Delete a group.

**Inputs**

- Group (`group_id`, text, required): The group's ID number.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {}
}
```

### Get app

Get one app.

**Inputs**

- App (`app_id`, text, required): The app ID.

**Outputs**

- `data` (object): A single app

**Example output**

```json
{
  "data": {
    "data": {
      "app_type": "classic",
      "created_at": "example",
      "description": "example",
      "folder_id": "example",
      "id": "example",
      "is_mobile_app": false,
      "is_module": false,
      "name": "example",
      "protected": false,
      "published_app_identifier": "example",
      "published_app_url": "example",
      "release_version": "example",
      "shortlink": "example",
      "synced": false,
      "updated_at": "example"
    },
    "success": true
  }
}
```

### Get environment

Get one environment.

**Inputs**

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

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": {
      "color": "example",
      "created_at": "example",
      "default": false,
      "description": "example",
      "id": "example",
      "name": "example",
      "updated_at": "example"
    },
    "success": true
  }
}
```

### Get folder

Get one folder.

**Inputs**

- Folder (`folder_id`, text, required): The id of the folder

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": {
      "created_at": "example",
      "folder_type": "app",
      "id": "example",
      "is_system_folder": false,
      "legacy_id": "example",
      "name": "example",
      "parent_folder_id": "example",
      "updated_at": "example"
    },
    "success": true
  }
}
```

### Get group

Get one group.

**Inputs**

- Group (`group_id`, text, required): The group's ID number.
- Exclude disabled users (`exclude_disabled_users`, true/false): Whether to exclude disabled users from the members list in the response.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": {
      "account_details_access": false,
      "audit_log_access": false,
      "created_at": "example",
      "id": 1.0,
      "landing_page_app_id": "example",
      "legacy_id": 1.0,
      "members": [],
      "name": "example",
      "theme_access": false,
      "universal_app_access": "none",
      "universal_query_library_access": "none",
      "universal_resource_access": "none",
      "universal_workflow_access": "none",
      "unpublished_release_access": false,
      "updated_at": "example",
      "usage_analytics_access": false,
      "user_invites": [],
      "user_list_access": false
    },
    "success": true
  }
}
```

### Get organization

Get your organization's advanced settings.

**Inputs**: None.

**Outputs**

- `data` (object): The current organization's advanced settings

**Example output**

```json
{
  "data": {
    "data": {
      "ai_support_bot_disabled": false,
      "app_owners_permissions_management": false,
      "apply_preloaded_css_to_homepage": false,
      "cache_queries_per_user": false,
      "disable_new_login_ip_notification_email": false,
      "hide_environment_toggle": false,
      "id": "example",
      "javascript_links": [],
      "preloaded_css": "example",
      "preloaded_javascript": "example",
      "release_management_enabled": false,
      "request_access_enabled": false,
      "retool_forms_disabled": false,
      "two_factor_auth_required": false,
      "two_factor_auth_type": "fido2",
      "workflow_run_retention_period_mins": 1.0
    },
    "success": true
  }
}
```

### Get resource

Get one resource.

**Inputs**

- Resource (`resource_id`, text, required): The uuid or name for the resource.

**Outputs**

- `data` (object): A single resource

**Example output**

```json
{
  "data": {
    "data": {
      "created_at": "example",
      "data_access_enforced": false,
      "display_name": "example",
      "folder_id": "example",
      "id": "example",
      "protected": false,
      "type": "airflow",
      "updated_at": "example"
    },
    "success": true
  }
}
```

### Get user

Get one user.

**Inputs**

- User (`retool_user_id`, text, required): The unique identifier for the user.
- Include groups (`include_groups`, true/false): Whether to include a list of groups for which this user is a member. Default: `false`.

**Outputs**

- `data` (object): A single user.

**Example output**

```json
{
  "data": {
    "data": {
      "active": false,
      "created_at": "example",
      "email": "example",
      "first_name": "example",
      "groups": [],
      "id": "example",
      "is_admin": false,
      "last_active": "example",
      "last_name": "example",
      "legacy_id": 1.0,
      "metadata": {},
      "seat_type": "builder",
      "two_factor_auth_enabled": false,
      "user_type": "default"
    },
    "success": true
  }
}
```

### Get workflow

Get one workflow.

**Inputs**

- Workflow (`retool_workflow_id`, text, required): The Workflow ID.

**Outputs**

- `data` (object): A single workflow

**Example output**

```json
{
  "data": {
    "data": {
      "code_executor_memory_limit_mbs": 1,
      "created_at": "example",
      "created_by": 1.0,
      "crontab": "example",
      "description": "example",
      "folder_id": "example",
      "id": "example",
      "is_enabled": false,
      "name": "example",
      "protected": false,
      "run_as_group": {
        "id": 1,
        "name": "example"
      },
      "timezone": "example",
      "updated_at": "example"
    },
    "success": true
  }
}
```

### Get workflow run

Get the details of one workflow run.

**Inputs**

- Id (`id`, text, required): The ID of the workflow run.

**Outputs**

- `data` (object): A workflow run and related data.

**Example output**

```json
{
  "data": {
    "created_at": "example",
    "id": "example",
    "status": "example",
    "trigger_id": "example",
    "trigger_type": "example",
    "user_tasks": [],
    "workflow_id": "example"
  }
}
```

### List apps

List apps.

**Inputs**

- Using resource (`using_resource`, text): Filter only for apps that use this resource, specified by the resource's UUID. Available on Retool versions 3.176.0+.
- Name contains (`name_contains`, text): Filter apps whose name contains this value (case-insensitive).
- Exclude trashed (`exclude_trashed`, text): When true, omits apps in the Trash, including apps inside trashed folders and personal trash folders. Defaults to false. Available on Retool versions 4.63.0+. One of: `true`, `false`.
- Limit (`limit`, number): Maximum number of items to return per page. If not provided, all items are returned. When provided, enables pagination and the response will include next_token for retrieving subsequent pages. Valid range: 1-100. From 1 to 100. Default: `100`.
- Next token (`next_token`, text): Cursor token for retrieving the next page of results. Obtained from the next_token field of a previous paginated response. Only valid when the limit parameter is also provided.

**Outputs**

- `data` (object): A list of all apps in the organization

**Example output**

```json
{
  "data": {
    "data": [],
    "has_more": false,
    "next_token": "example",
    "success": true,
    "total_count": 1.0
  }
}
```

### List environments

List environments.

**Inputs**: None.

**Outputs**

- `data` (object): A list of environments.

**Example output**

```json
{
  "data": {
    "data": [],
    "has_more": false,
    "next_token": "example",
    "success": true,
    "total_count": 1.0
  }
}
```

### List folders

List folders.

**Inputs**

- Name contains (`name_contains`, text): Filter folders whose name contains this value (case-insensitive).
- Limit (`limit`, number): Maximum number of items to return per page. If not provided, all items are returned. When provided, enables pagination and the response will include next_token for retrieving subsequent pages. Valid range: 1-100. From 1 to 100. Default: `100`.
- Next token (`next_token`, text): Cursor token for retrieving the next page of results. Obtained from the next_token field of a previous paginated response. Only valid when the limit parameter is also provided.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "has_more": false,
    "next_token": "example",
    "success": true,
    "total_count": 1.0
  }
}
```

### List groups

List the permission groups in your organization or space.

**Inputs**

- Name contains (`name_contains`, text): Filter groups whose name contains this value (case-insensitive).
- Limit (`limit`, number): Maximum number of items to return per page. If not provided, all items are returned. When provided, enables pagination and the response will include next_token for retrieving subsequent pages. Valid range: 1-100. From 1 to 100. Default: `100`.
- Next token (`next_token`, text): Cursor token for retrieving the next page of results. Obtained from the next_token field of a previous paginated response. Only valid when the limit parameter is also provided.

**Outputs**

- `data` (object): A paginated list of groups.

**Example output**

```json
{
  "data": {
    "data": [],
    "has_more": false,
    "next_token": "example",
    "success": true,
    "total_count": 1.0
  }
}
```

### List resources

List resources, one page at a time.

**Inputs**

- Resource type (`resource_type`, text): The type of resource. One of: `airflow`, `alloydb`, `anthropic`, `asana`, `athena`, `awsBedrock`, `azureAI`, `azureBlob`, `basecamp`, `bigid`, and 82 more.
- Name contains (`name_contains`, text): Filter resources whose name contains this value (case-insensitive). The name is the technical identifier used in TypeScript bindings, not the display name.
- Limit (`limit`, number): Maximum number of items to return per page. If not provided, all items are returned. When provided, enables pagination and the response will include next_token for retrieving subsequent pages. Valid range: 1-100. From 1 to 100. Default: `100`.
- Next token (`next_token`, text): Cursor token for retrieving the next page of results. Obtained from the next_token field of a previous paginated response. Only valid when the limit parameter is also provided.

**Outputs**

- `data` (object): A paginated list of resources.

**Example output**

```json
{
  "data": {
    "data": [],
    "has_more": false,
    "next_token": "example",
    "success": true,
    "total_count": 1.0
  }
}
```

### List user attributes

List the user attributes set up for your organization.

**Inputs**: None.

**Outputs**

- `data` (object): A list of user attributes.

**Example output**

```json
{
  "data": {
    "data": [],
    "success": true
  }
}
```

### List user invites

List the user invites for your organization.

**Inputs**: None.

**Outputs**

- `data` (object): A list of user invites.

**Example output**

```json
{
  "data": {
    "data": [],
    "has_more": false,
    "next_token": "example",
    "success": true,
    "total_count": 1.0
  }
}
```

### List users

List the users in your Retool organization.

**Inputs**

- Email (`email`, text): Filter users by email address.
- First name (`first_name`, text): Filter users by first name.
- Last name (`last_name`, text): Filter users by last name.
- Limit (`limit`, number): Maximum number of items to return per page. If not provided, all items are returned. When provided, enables pagination and the response will include next_token for retrieving subsequent pages. Valid range: 1-100. From 1 to 100. Default: `100`.
- Next token (`next_token`, text): Cursor token for retrieving the next page of results. Obtained from the next_token field of a previous paginated response. Only valid when the limit parameter is also provided.

**Outputs**

- `data` (object): A paginated list of users.

**Example output**

```json
{
  "data": {
    "data": [],
    "has_more": false,
    "next_token": "example",
    "success": true,
    "total_count": 1.0
  }
}
```

### List workflows

List workflows.

**Inputs**

- Name contains (`name_contains`, text): Filter workflows whose name contains this value (case-insensitive).
- Folder (`folder_id`, text): Only return workflows directly in this folder. A folder that is not a workflow folder returns no workflows.
- Limit (`limit`, number): Maximum number of items to return per page. If not provided, all items are returned. When provided, enables pagination and the response will include next_token for retrieving subsequent pages. Valid range: 1-100. From 1 to 100. Default: `100`.
- Next token (`next_token`, text): Cursor token for retrieving the next page of results. Obtained from the next_token field of a previous paginated response. Only valid when the limit parameter is also provided.

**Outputs**

- `data` (object): A list of all workflows in the organization

**Example output**

```json
{
  "data": {
    "data": [],
    "has_more": false,
    "next_token": "example",
    "success": true,
    "total_count": 1.0
  }
}
```

### Update folder

Update a folder and return the updated folder.

**Inputs**

- Folder (`folder_id`, text, required): The id of the folder
- Name (`name`, text): New name; leave empty to keep it.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": {
      "created_at": "example",
      "folder_type": "app",
      "id": "example",
      "is_system_folder": false,
      "legacy_id": "example",
      "name": "example",
      "parent_folder_id": "example",
      "updated_at": "example"
    },
    "success": true
  }
}
```

### Update group

Update a group's name and access settings, and return the updated group.

**Inputs**

- Group (`group_id`, text, required): The group's ID number.
- Name (`name`, text): New name; leave empty to keep it.
- Universal app access (`universal_app_access`, text): Universal app access. One of: `none`, `use`, `edit`, `own`.
- Universal resource access (`universal_resource_access`, text): Universal resource access. One of: `none`, `use`, `edit`, `own`.
- Universal workflow access (`universal_workflow_access`, text): Universal workflow access. One of: `none`, `use`, `edit`, `own`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": {
      "account_details_access": false,
      "audit_log_access": false,
      "created_at": "example",
      "id": 1.0,
      "landing_page_app_id": "example",
      "legacy_id": 1.0,
      "members": [],
      "name": "example",
      "theme_access": false,
      "universal_app_access": "none",
      "universal_query_library_access": "none",
      "universal_resource_access": "none",
      "universal_workflow_access": "none",
      "unpublished_release_access": false,
      "updated_at": "example",
      "usage_analytics_access": false,
      "user_invites": [],
      "user_list_access": false
    },
    "success": true
  }
}
```
