GET /wiki/rest/api/group/{groupId}/membersByGroupId
Returns the users that are members of a group.
Use updated Get group API
Permissions required: Permission to access the Confluence site ('Can use' global permission).
Servers
- https://your-domain.atlassian.net
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
groupId |
String | Yes |
The id of the group to be queried for its members. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit |
Integer | No |
The maximum number of users to return per page. Note, this may be restricted by fixed system limits. Default value: 200 |
expand[] |
Array | No |
A multi-value parameter indicating which properties of the user to expand.
|
shouldReturnTotalSize |
Boolean | No |
Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value. Default value: false |
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.