0

Get groups

by
Published Oct 17, 2025

Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site ('Can use' global permission).

Script confluence Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Confluence = {
3
	email: string
4
	apiToken: string
5
	domain: string
6
}
7
/**
8
 * Get groups
9
 * Returns all user groups. The returned groups are ordered alphabetically in
10
ascending order by group name.
11

12
**[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
13
Permission to access the Confluence site ('Can use' global permission).
14
 */
15
export async function main(
16
	auth: Confluence,
17
	start: string | undefined,
18
	limit: string | undefined,
19
	accessType: 'user' | 'admin' | 'site-admin' | undefined
20
) {
21
	const url = new URL(`https://${auth.domain}/wiki/rest/api/group`)
22
	for (const [k, v] of [
23
		['start', start],
24
		['limit', limit],
25
		['accessType', accessType]
26
	]) {
27
		if (v !== undefined && v !== '' && k !== undefined) {
28
			url.searchParams.append(k, v)
29
		}
30
	}
31
	const response = await fetch(url, {
32
		method: 'GET',
33
		headers: {
34
			Authorization: 'Basic ' + btoa(`${auth.email}:${auth.apiToken}`)
35
		},
36
		body: undefined
37
	})
38
	if (!response.ok) {
39
		const text = await response.text()
40
		throw new Error(`${response.status} ${text}`)
41
	}
42
	return await response.json()
43
}
44