summaryrefslogtreecommitdiff
path: root/doc/api/groups.md
blob: 00a7387c76fb29b9030a22b413f996c207bccdf8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
## List project groups

Get a list of groups. (As user: my groups, as admin: all groups)

```
GET /groups
```

```json
[
    {
        "id": 1,
        "name": "Foobar Group",
        "path": "foo-bar",
        "owner_id": 18
    }
]
```

## Details of group

Get all details of a group.

```
GET /groups/:id
```

Parameters:

+ `id` (required) - The ID of a group

## New group

Create a new project group. Available only for admin

```
POST /groups
```

Parameters:
+ `name` (required)                  - Email
+ `path`                             - Password

Will return created group with status `201 Created` on success, or `404 Not found` on fail.