{
  "opencollection": "1.0.0",
  "info": {
    "name": "Atomicwork Public accessManagement users API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Invite Users",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/invite",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Invite Users"
        },
        {
          "info": {
            "name": "User workspace invite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/workspaces/invite",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "User workspace invite"
        },
        {
          "info": {
            "name": "Get users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.atomicwork.com/api/v1/users",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "search_key",
                "value": "",
                "type": "query"
              },
              {
                "name": "is_deleted",
                "value": "",
                "type": "query"
              },
              {
                "name": "has_slack",
                "value": "",
                "type": "query"
              },
              {
                "name": "role",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query",
                "description": "Optional comma-separated list of user types to filter by"
              }
            ]
          },
          "docs": "Get users"
        },
        {
          "info": {
            "name": "Create user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}.atomicwork.com/api/v1/users",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "send_email",
                "value": "",
                "type": "query",
                "description": "Send welcome email or not"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create user"
        },
        {
          "info": {
            "name": "Get paginated users list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/list",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "search_key",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort_order",
                "value": "",
                "type": "query"
              },
              {
                "name": "is_deleted",
                "value": "",
                "type": "query"
              },
              {
                "name": "has_slack",
                "value": "",
                "type": "query"
              },
              {
                "name": "role",
                "value": "",
                "type": "query"
              },
              {
                "name": "role_id",
                "value": "",
                "type": "query"
              },
              {
                "name": "user_status",
                "value": "",
                "type": "query"
              },
              {
                "name": "invitation_status",
                "value": "",
                "type": "query"
              },
              {
                "name": "types",
                "value": "",
                "type": "query",
                "description": "Optional comma-separated list of user types to filter by"
              },
              {
                "name": "expand",
                "value": "",
                "type": "query"
              },
              {
                "name": "excluded_user_ids",
                "value": "",
                "type": "query"
              },
              {
                "name": "notification_enabled",
                "value": "",
                "type": "query",
                "description": "Filter users by notification enabled status"
              },
              {
                "name": "employee_id",
                "value": "",
                "type": "query",
                "description": "Filter users by employee ID (exact match)"
              }
            ]
          },
          "docs": "Get paginated users list"
        },
        {
          "info": {
            "name": "Get paginated users list in a segment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/:segment_id/list",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "segment_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "search_key",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query"
              },
              {
                "name": "sort_order",
                "value": "",
                "type": "query"
              },
              {
                "name": "is_deleted",
                "value": "",
                "type": "query",
                "description": "Filter by deactivation state. true returns only deactivated users, false returns only active users. When omitted, active users are returned by default unless include_deactivated is set. Do not add a schema default here: a materialised default makes the param non-null and renders include_deactivated unreachable in the controller."
              },
              {
                "name": "role",
                "value": "",
                "type": "query"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Automation entity type (see allowed values in the enum schema)."
              },
              {
                "name": "include_deactivated",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get paginated users list in a segment"
        },
        {
          "info": {
            "name": "Retrieve User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/:user_id",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve User"
        },
        {
          "info": {
            "name": "Update User",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/:user_id",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update User"
        },
        {
          "info": {
            "name": "Patch a user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/:user_id",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Patch a user"
        },
        {
          "info": {
            "name": "Delete user from organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/:user_id",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete user from organization"
        },
        {
          "info": {
            "name": "Patch a user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/:user_id/properties",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Patch a user"
        },
        {
          "info": {
            "name": "Restore a user",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/:user_id/restore",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore a user"
        },
        {
          "info": {
            "name": "Restore user in organization",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/:email/restore-by-email",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore user in organization"
        },
        {
          "info": {
            "name": "Get a user by email",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{tenant}.atomicwork.com/api/v1/users/:email/email-lookup",
            "headers": [
              {
                "name": "X-Api-Key",
                "value": ""
              },
              {
                "name": "X-Workspace-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get a user by email"
        }
      ]
    }
  ],
  "bundled": true
}