2016-06-23 15:14:31 +00:00
# Group and project members
**Valid access levels**
The access levels are defined in the `Gitlab::Access` module. Currently, these levels are recognized:
```
10 => Guest access
20 => Reporter access
30 => Developer access
40 => Master access
50 => Owner access # Only valid for groups
```
## List all members of a group or project
Gets a list of group or project members viewable by the authenticated user.
```
GET /groups/:id/members
GET /projects/:id/members
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-04-08 08:54:00 +00:00
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group ](README.md#namespaced-path-encoding ) owned by the authenticated user |
2016-06-23 15:14:31 +00:00
| `query` | string | no | A query string to search for members |
```bash
2017-03-01 17:39:40 +00:00
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/:id/members
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/:id/members
2016-06-23 15:14:31 +00:00
```
Example response:
```json
[
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
"created_at": "2012-10-22T14:13:35Z",
"access_level": 30
},
{
"id": 2,
"username": "john_doe",
"name": "John Doe",
"state": "active",
"created_at": "2012-10-22T14:13:35Z",
"access_level": 30
}
]
```
## Get a member of a group or project
Gets a member of a group or project.
```
GET /groups/:id/members/:user_id
GET /projects/:id/members/:user_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-04-08 08:54:00 +00:00
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group ](README.md#namespaced-path-encoding ) owned by the authenticated user |
2016-06-23 15:14:31 +00:00
| `user_id` | integer | yes | The user ID of the member |
```bash
2017-03-01 17:39:40 +00:00
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/:id/members/:user_id
curl --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/:id/members/:user_id
2016-06-23 15:14:31 +00:00
```
Example response:
```json
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
"created_at": "2012-10-22T14:13:35Z",
2016-08-18 14:49:32 +00:00
"access_level": 30,
"expires_at": null
2016-06-23 15:14:31 +00:00
}
```
## Add a member to a group or project
Adds a member to a group or project.
```
POST /groups/:id/members
POST /projects/:id/members
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-04-08 08:54:00 +00:00
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group ](README.md#namespaced-path-encoding ) owned by the authenticated user |
2016-06-23 15:14:31 +00:00
| `user_id` | integer | yes | The user ID of the new member |
| `access_level` | integer | yes | A valid access level |
2016-08-18 14:49:32 +00:00
| `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY |
2016-06-23 15:14:31 +00:00
```bash
2017-03-01 17:39:40 +00:00
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --data "user_id=1& access_level=30" https://gitlab.example.com/api/v4/groups/:id/members
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --data "user_id=1& access_level=30" https://gitlab.example.com/api/v4/projects/:id/members
2016-06-23 15:14:31 +00:00
```
Example response:
```json
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
"created_at": "2012-10-22T14:13:35Z",
"access_level": 30
}
```
## Edit a member of a group or project
Updates a member of a group or project.
```
PUT /groups/:id/members/:user_id
PUT /projects/:id/members/:user_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-04-08 08:54:00 +00:00
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group ](README.md#namespaced-path-encoding ) owned by the authenticated user |
2016-06-23 15:14:31 +00:00
| `user_id` | integer | yes | The user ID of the member |
| `access_level` | integer | yes | A valid access level |
2016-08-18 14:49:32 +00:00
| `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY |
2016-06-23 15:14:31 +00:00
```bash
2017-03-01 17:39:40 +00:00
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/:id/members/:user_id?access_level=40
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/:id/members/:user_id?access_level=40
2016-06-23 15:14:31 +00:00
```
Example response:
```json
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
"created_at": "2012-10-22T14:13:35Z",
"access_level": 40
}
```
## Remove a member from a group or project
Removes a user from a group or project.
```
DELETE /groups/:id/members/:user_id
DELETE /projects/:id/members/:user_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2017-04-08 08:54:00 +00:00
| `id` | integer/string | yes | The ID or [URL-encoded path of the project or group ](README.md#namespaced-path-encoding ) owned by the authenticated user |
2016-06-23 15:14:31 +00:00
| `user_id` | integer | yes | The user ID of the member |
```bash
2017-03-01 17:39:40 +00:00
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/:id/members/:user_id
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/projects/:id/members/:user_id
2016-06-23 15:14:31 +00:00
```