{
  "opencollection": "1.0.0",
  "info": {
    "name": "Atlassian Confluence Search API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Search",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Atlassian Search Users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "//your-domain.atlassian.net/wiki/rest/api/search/user",
            "params": [
              {
                "name": "cql",
                "value": "",
                "type": "query",
                "description": "The CQL query to be used for the search. See\n[Advanced Searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/)\nfor instructions on how to build a CQL query.\n\nExample queries:\n          cql=type=user will return all users\n          cql=user=\"1234\" will return user with accountId \"1234\"\n          You can also use IN, NOT IN, != operators\n          cql=user IN (\"12\", \"34\") will return users with accountids \"12\" and \"34\"\n          cql=user.fullname~jo will return users with nickname/full name starting with \"jo\"\n          cql=user.accountid=\"123\" will return user with accountId \"123\""
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "The starting index of the returned users."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of user objects to return per page.\nNote, this may be restricted by fixed system limits."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "A multi-value parameter indicating which properties of the user to expand.\n\n- `operations` returns the operations for the user, which are used\nwhen setting permissions.\n- `personalSpace` returns the personal space of the user."
              },
              {
                "name": "sitePermissionTypeFilter",
                "value": "",
                "type": "query",
                "description": "Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator`\nfor external/guest users, and `all` to include all permission types."
              }
            ]
          },
          "docs": "Searches for users using user-specific queries from the<br>[Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).<br><br>Note that CQL input queries submitted through the `/wiki/rest/api/search/user` endpoint only support user-specific fields like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.<br><br>Note that some user fields may be set to null depending on the user's privacy settings.<br>These are: email, profilePictur"
        }
      ]
    }
  ],
  "bundled": true
}