---
title: "Create group"
method: POST
path: "/rest/api/3/group"
tags: ["Groups"]
---

# Create group

`POST /rest/api/3/group`

Creates a group.

**[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)).

## Request body

- AddGroupBean
  - `name` string, required — The name of the group.

## Response `201`

Returned if the request is successful.

- Group
  - `expand` string — Expand options that include additional group details in the response.
  - `groupId` string, nullable — The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.
  - `name` string — The name of group.
  - `self` string, uri — The URL for these group details.
  - `users` PagedListUserDetailsApplicationUser — A paged list. To access additional details append `[start-index:end-index]` to the expand request. For example, `?expand=sharedUsers[10:40]` returns a list starting at item 10 and finishing at item 40.
    - `end-index` integer — The index of the last item returned on the page.
    - `items` UserDetails[] — The list of items.
      - `accountId` string — The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
      - `accountType` string — The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
      - `active` boolean — Whether the user is active.
      - `avatarUrls` AvatarUrlsBean
        - `16x16` string, uri — The URL of the item's 16x16 pixel avatar.
        - `24x24` string, uri — The URL of the item's 24x24 pixel avatar.
        - `32x32` string, uri — The URL of the item's 32x32 pixel avatar.
        - `48x48` string, uri — The URL of the item's 48x48 pixel avatar.
      - `displayName` string — The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
      - `emailAddress` string — The email address of the user. Depending on the user’s privacy settings, this may be returned as null.
      - `key` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
      - `name` string — This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.
      - `self` string — The URL of the user.
      - `timeZone` string — The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
    - `max-results` integer — The maximum number of results that could be on the page.
    - `size` integer — The number of items on the page.
    - `start-index` integer — The index of the first item returned on the page.

## Other responses

- `400` — Returned if group name is not specified or the group name is in use.
- `401` — Returned if the authentication credentials are incorrect or missing.
- `403` — Returned if the user does not have the necessary permission.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-2/versions/5a51740d7ab3/schema)