GET /wiki/rest/api/search/user

Searches for users using user-specific queries from the Confluence Query Language (CQL).

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.

Note that some user fields may be set to null depending on the user's privacy settings. These are: email, profilePicture, displayName, and timeZone.

Servers

https://your-domain.atlassian.net

Query parameters

Name	Type	Required	Description
`cql`	String	Yes	The CQL query to be used for the search. See Advanced Searching using CQL for instructions on how to build a CQL query. Example queries: cql=type=user will return up to 10k users cql=user="1234" will return user with accountId "1234" You can also use IN, NOT IN, != operators cql=user IN ("12", "34") will return users with accountids "12" and "34" cql=user.fullname~jo will return users with nickname/full name starting with "jo" cql=user.accountid="123" will return user with accountId "123"
`limit`	Integer	No	The maximum number of user objects to return per page. Note, this may be restricted by fixed system limits. Default value: 25
`expand[]`	Array	No	A multi-value parameter indicating which properties of the user to expand. `operations` returns the operations for the user, which are used when setting permissions. `personalSpace` returns the personal space of the user.
`sitePermissionTypeFilter`	String	No	Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator` for external/guest users, and `all` to include all permission types. Possible values: `"externalCollaborator"` `"none"` `"all"` Default value: "none"
`start`	Integer	No	The starting index of the returned users. Default value: 0

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.