The Confluence Cloud REST API

Group

Get groups

GET /wiki/rest/api/group

Returns all user groups. The returned groups are ordered alphabetically in ascending order by group name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

App scope required: READ

OAuth scopes required:

read:confluence-groups

Request

Query parameters

start

integer

The starting index of the returned groups.

Default: 0, Minimum: 0, Format: int32

limit

integer

The maximum number of groups to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0, Format: int32

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group' \
  --header 'Accept: application/json'

Responses

200

403

Returned if the requested groups are returned.

Content type	Value
application/json	allOf [GroupArray, object]

Create new user group

POST /wiki/rest/api/group

Creates a new user group.

Permissions required: User must be a site admin.

Apps cannot access this REST resource.

OAuth scopes required:

write:confluence-groups

Request

Body parameters

name Required

string

Example

cURL

Node.js

Java

Python

PHP

Forge

curl --request POST \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>"
}'

Responses

201

400

401

403

Returned if the group was created successfully.

Content type	Value
application/json	Group

Delete user group

DELETE /wiki/rest/api/group

Delete user group.

Permissions required: User must be a site admin.

Apps cannot access this REST resource.

OAuth scopes required:

write:confluence-groups

Request

Query parameters

name Required

string

Name of the group to delete.

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group?name={name}'

Responses

204

400

401

403

404

Returned if the group was removed successfully.

Get group

GET /wiki/rest/api/group/by-name

Returns a user group for a given group name.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

App scope required: READ

OAuth scopes required:

read:confluence-groups

Request

Query parameters

name Required

string

The name of the group. This is the same as the group name shown in the Confluence administration console.

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/by-name?name={name}' \
  --header 'Accept: application/json'

Responses

200

403

Returned if the requested group is returned.

Content type	Value
application/json	Group

Get group

GET /wiki/rest/api/group/by-id

Returns a user group for a given group id.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

App scope required: READ

Request

Query parameters

id Required

string

The id of the group.

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/by-id?id={id}' \
  --header 'Accept: application/json'

Responses

200

403

Returned if the requested group is returned.

Content type	Value
application/json	Group

Get group

Deprecated

GET /wiki/rest/api/group/{groupName}

Returns a user group for a given group name.

Use updated Get group API

Permissions required: Permission to access the Confluence site ('Can use' global permission).

App scope required: READ

Request

Path parameters

groupName Required

string

The name of the group. This is the same as the group name shown in the Confluence administration console.

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/{groupName}' \
  --header 'Accept: application/json'

Responses

200

403

Returned if the requested group is returned.

Content type	Value
application/json	Group

Get group members

GET /wiki/rest/api/group/member

Returns the users that are members of a group.

Permissions required: Permission to access the Confluence site ('Can use' global permission).

App scope required: READ

OAuth scopes required:

read:confluence-groups

Request

Query parameters

name Required

string

The name of the group to be queried for its members.

start

integer

The starting index of the returned users.

Default: 0, Minimum: 0, Format: int32

limit

integer

The maximum number of users to return per page. Note, this is restricted by fixed system limit of 200 which is to say if the limit parameter exceeds 200, this API will return a maximum of 200 users per page.

Default: 200, Minimum: 0, Format: int32

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/member?name={name}' \
  --header 'Accept: application/json'

Responses

200

403

Returned if the requested users are returned.

Content type	Value
application/json	allOf [UserArray, object]

Get group members

Deprecated

GET /wiki/rest/api/group/{groupName}/member

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).

App scope required: READ

Request

Path parameters

groupName Required

string

The name of the group to be queried for its members.

Query parameters

start

integer

The starting index of the returned users.

Default: 0, Minimum: 0, Format: int32

limit

integer

The maximum number of users to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0, Format: int32

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/{groupName}/member' \
  --header 'Accept: application/json'

Responses

200

400

403

Returned if the requested users are returned.

Content type	Value
application/json	allOf [UserArray, object]

Search groups by partial query

GET /wiki/rest/api/group/picker

Get search results of groups by partial query provided.

App scope required: READ

OAuth scopes required:

read:confluence-groups

Request

Query parameters

query Required

string

the search term used to query results.

start

integer

The starting index of the returned groups.

Default: 0, Minimum: 0, Format: int32

limit

integer

The maximum number of groups to return per page. Note, this is restricted to a maximum limit of 200 groups.

Default: 200, Minimum: 0, Format: int32

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/picker?query={query}' \
  --header 'Accept: application/json'

Responses

200

403

Returns a full JSON representation of group collection.

Content type	Value
application/json	allOf [GroupArray, object]

Add member to group by groupId

POST /wiki/rest/api/group/userByGroupId

Adds a user as a member in a group represented by its groupId

Permissions required: User must be a site admin.

Apps cannot access this REST resource.

OAuth scopes required:

write:confluence-groups

Request

Query parameters

groupId Required

string

GroupId of the group whose membership is updated

Body parameters

accountId Required

string

Example

cURL

Node.js

Java

Python

PHP

Forge

curl --request POST \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/userByGroupId?groupId={groupId}' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "<string>"
}'

Responses

201

400

401

403

404

Returned if the group was created successfully.

A schema has not been defined for this response code.

Remove member from group using group id

DELETE /wiki/rest/api/group/userByGroupId

Remove user as a member from a group.

Permissions required: User must be a site admin.

Apps cannot access this REST resource.

OAuth scopes required:

write:confluence-groups

Request

Query parameters

groupId Required

string

Id of the group whose membership is updated.

accountId Required

string

AccountId of the user whose membership is removed.

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/userByGroupId?groupId={groupId}&accountId={accountId}'

Responses

204

400

401

403

404

Returned if the group was removed successfully.

Get group members

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).

App scope required: READ

OAuth scopes required:

read:confluence-groups

Request

Path parameters

groupId Required

string

The id of the group to be queried for its members.

Query parameters

start

integer

The starting index of the returned users.

Default: 0, Minimum: 0, Format: int32

limit

integer

The maximum number of users to return per page. Note, this may be restricted by fixed system limits.

Default: 200, Minimum: 0, Format: int32

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2
3

curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/{groupId}/membersByGroupId' \
  --header 'Accept: application/json'

Responses

200

400

403

Returned if the requested users are returned.

Content type	Value
application/json	allOf [UserArray, object]

Add member to group

POST /wiki/rest/api/group/user

Adds a user as a member in a group.

Permissions required: User must be a site admin.

Apps cannot access this REST resource.

OAuth scopes required:

write:confluence-groups

Request

Query parameters

name Required

string

Name of the group whose membership is updated

Body parameters

accountId Required

string

Example

cURL

Node.js

Java

Python

PHP

Forge

curl --request POST \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/user?name={name}' \
  --header 'Content-Type: application/json' \
  --data '{
  "accountId": "<string>"
}'

Responses

201

400

401

403

404

Returned if the group was created successfully.

A schema has not been defined for this response code.

Remove member from group

DELETE /wiki/rest/api/group/user

Remove user as a member from a group.

Permissions required: User must be a site admin.

Apps cannot access this REST resource.

OAuth scopes required:

write:confluence-groups

Request

Query parameters

name Required

string

Name of the group whose membership is updated.

accountId Required

string

AccountId of the user whose membership is removed.

Example

cURL

Node.js

Java

Python

PHP

Forge

1
2

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/group/user?name={name}&accountId={accountId}'

Responses

204

400

401

403

404

Returned if the group was removed successfully.