{
  "opencollection": "1.0.0",
  "info": {
    "name": "Superhuman Docs Admin Account Workspace Users API",
    "version": "0.0.2"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Workspace Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List workspace users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://docs.superhuman.com/apis/admin/v1/organizations/:organizationId/workspaces/:workspaceId/users",
            "params": [
              {
                "name": "organizationId",
                "value": "org-AbCDeFGHIj",
                "type": "path",
                "description": "ID of the organization."
              },
              {
                "name": "workspaceId",
                "value": "ws-AbCDeFGHIj",
                "type": "path",
                "description": "ID of the workspace."
              },
              {
                "name": "limit",
                "value": "10",
                "type": "query",
                "description": "Maximum number of results to return in this query."
              },
              {
                "name": "pageToken",
                "value": "eyJsaW1pd",
                "type": "query",
                "description": "An opaque token used to fetch the next page of results."
              },
              {
                "name": "workspaceUserRoles",
                "value": "",
                "type": "query",
                "description": "Filter results to users based on their role in the workspace"
              },
              {
                "name": "query",
                "value": "feature%parity",
                "type": "query",
                "description": "Search terms used to narrow down results."
              },
              {
                "name": "isActivated",
                "value": "",
                "type": "query",
                "description": "Filter results to users based on their activation status."
              }
            ]
          },
          "docs": "Returns a list of users within a workspace.\n"
        },
        {
          "info": {
            "name": "Add workspace user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://docs.superhuman.com/apis/admin/v1/organizations/:organizationId/workspaces/:workspaceId/users",
            "params": [
              {
                "name": "organizationId",
                "value": "org-AbCDeFGHIj",
                "type": "path",
                "description": "ID of the organization."
              },
              {
                "name": "workspaceId",
                "value": "ws-AbCDeFGHIj",
                "type": "path",
                "description": "ID of the workspace."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds an existing user to a workspace.\n"
        },
        {
          "info": {
            "name": "Update workspace user role",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://docs.superhuman.com/apis/admin/v1/organizations/:organizationId/workspaces/:workspaceId/users/:userEmail",
            "params": [
              {
                "name": "organizationId",
                "value": "org-AbCDeFGHIj",
                "type": "path",
                "description": "ID of the organization."
              },
              {
                "name": "workspaceId",
                "value": "ws-AbCDeFGHIj",
                "type": "path",
                "description": "ID of the workspace."
              },
              {
                "name": "userEmail",
                "value": "april@example.com",
                "type": "path",
                "description": "User to act upon."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the role of the given user in the workspace.\n"
        },
        {
          "info": {
            "name": "Removes a user from a workspace",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://docs.superhuman.com/apis/admin/v1/organizations/:organizationId/workspaces/:workspaceId/users/:userEmail",
            "params": [
              {
                "name": "organizationId",
                "value": "org-AbCDeFGHIj",
                "type": "path",
                "description": "ID of the organization."
              },
              {
                "name": "workspaceId",
                "value": "ws-AbCDeFGHIj",
                "type": "path",
                "description": "ID of the workspace."
              },
              {
                "name": "userEmail",
                "value": "april@example.com",
                "type": "path",
                "description": "User to act upon."
              }
            ]
          },
          "docs": "Removes a user from a workspace. Note this does not remove the user from Superhuman Docs or from other workspaces.\n"
        }
      ]
    }
  ],
  "bundled": true
}