Retool

opencollection: 1.0.0
info:
  name: Retool Management API
  version: 1.0.0
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Users
    type: folder
  items:
  - info:
      name: List Users
      type: http
    http:
      method: GET
      url: https://api.retool.com/v1/users
      params:
      - name: page
        value: ''
        type: query
        description: Page number for pagination (1-based).
      - name: pageSize
        value: ''
        type: query
        description: Number of records per page.
    docs: Retrieves a paginated list of all users in the Retool organization. Returns user profiles including email, name,
      admin status, and group memberships.
  - info:
      name: Create User
      type: http
    http:
      method: POST
      url: https://api.retool.com/v1/users
      body:
        type: json
        data: '{}'
    docs: 'Creates a new user in the Retool organization. The email address must be unique. User type determines default access
      level: default users have standard access while endUser accounts have limited access to embedded applications.'
  - info:
      name: Get User
      type: http
    http:
      method: GET
      url: https://api.retool.com/v1/users/:userId
      params:
      - name: userId
        value: ''
        type: path
        description: The unique UUID identifier of the user.
    docs: Retrieves the details of a specific user by their unique identifier. Returns the user's profile, admin status, and
      group memberships.
  - info:
      name: Update User
      type: http
    http:
      method: PUT
      url: https://api.retool.com/v1/users/:userId
      params:
      - name: userId
        value: ''
        type: path
        description: The unique UUID identifier of the user.
      body:
        type: json
        data: '{}'
    docs: Updates the details of a specific user. Supports updating the user's name, admin status, and active/disabled state.
      Uses full PUT semantics so all updatable fields should be provided.
  - info:
      name: Delete User
      type: http
    http:
      method: DELETE
      url: https://api.retool.com/v1/users/:userId
      params:
      - name: userId
        value: ''
        type: path
        description: The unique UUID identifier of the user.
    docs: Permanently removes a user from the Retool organization. This action cannot be undone. The user will lose access
      to all apps and resources.
- info:
    name: Groups
    type: folder
  items:
  - info:
      name: List Groups
      type: http
    http:
      method: GET
      url: https://api.retool.com/v1/groups
    docs: Retrieves all groups within the Retool organization. Groups are used to manage access permissions for apps, resources,
      and workflows.
  - info:
      name: Create Group
      type: http
    http:
      method: POST
      url: https://api.retool.com/v1/groups
      body:
        type: json
        data: '{}'
    docs: Creates a new group within the Retool organization. Groups can be used to control access to apps, resources, and
      workflows.
  - info:
      name: Add Member to Group
      type: http
    http:
      method: POST
      url: https://api.retool.com/v1/groups/:groupId/members
      params:
      - name: groupId
        value: ''
        type: path
        description: The numeric identifier of the group.
      body:
        type: json
        data: '{}'
    docs: Adds a user to a group, granting them the permissions associated with that group. The user must already exist in
      the organization.
  - info:
      name: Remove Member from Group
      type: http
    http:
      method: DELETE
      url: https://api.retool.com/v1/groups/:groupId/members/:userId
      params:
      - name: groupId
        value: ''
        type: path
        description: The numeric identifier of the group.
      - name: userId
        value: ''
        type: path
        description: The unique UUID identifier of the user.
    docs: Removes a user from a group, revoking the permissions associated with that group. The user remains in the organization
      but loses access granted by group membership.
- info:
    name: Apps
    type: folder
  items:
  - info:
      name: List Apps
      type: http
    http:
      method: GET
      url: https://api.retool.com/v1/apps
      params:
      - name: page
        value: ''
        type: query
        description: Page number for pagination (1-based).
      - name: pageSize
        value: ''
        type: query
        description: Number of records per page.
    docs: Retrieves a list of all applications within the Retool organization. Returns app metadata including name, description,
      creator, and folder location.
  - info:
      name: Create App
      type: http
    http:
      method: POST
      url: https://api.retool.com/v1/apps
      body:
        type: json
        data: '{}'
    docs: Creates a new application within the Retool organization. The app will be empty and can be edited in the Retool
      visual editor.
  - info:
      name: Get App
      type: http
    http:
      method: GET
      url: https://api.retool.com/v1/apps/:appId
      params:
      - name: appId
        value: ''
        type: path
        description: The unique identifier of the app.
    docs: Retrieves the details of a specific app by its unique identifier. Returns the app's metadata, configuration, and
      access information.
  - info:
      name: Update App
      type: http
    http:
      method: PUT
      url: https://api.retool.com/v1/apps/:appId
      params:
      - name: appId
        value: ''
        type: path
        description: The unique identifier of the app.
      body:
        type: json
        data: '{}'
    docs: Updates the metadata of a specific app such as its name, description, or folder location.
  - info:
      name: Delete App
      type: http
    http:
      method: DELETE
      url: https://api.retool.com/v1/apps/:appId
      params:
      - name: appId
        value: ''
        type: path
        description: The unique identifier of the app.
    docs: Permanently deletes an app from the Retool organization. This action cannot be undone.
- info:
    name: Resources
    type: folder
  items:
  - info:
      name: List Resources
      type: http
    http:
      method: GET
      url: https://api.retool.com/v1/resources
    docs: Retrieves all data source resource connections configured in the Retool organization, including databases, REST
      APIs, and third-party service integrations.
- info:
    name: Folders
    type: folder
  items:
  - info:
      name: List Folders
      type: http
    http:
      method: GET
      url: https://api.retool.com/v1/folders
      params:
      - name: folderType
        value: ''
        type: query
        description: Filter folders by type (app, resource, workflow).
    docs: Retrieves all folders within the Retool organization. Folders are used to organize apps, resources, and workflows.
  - info:
      name: Create Folder
      type: http
    http:
      method: POST
      url: https://api.retool.com/v1/folders
      body:
        type: json
        data: '{}'
    docs: Creates a new folder in the Retool organization to organize apps, resources, or workflows.
bundled: true