diff options
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/groups.md | 22 | 
1 files changed, 21 insertions, 1 deletions
| diff --git a/doc/api/groups.md b/doc/api/groups.md index e6893d71774..9217c7a7f24 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -20,7 +20,7 @@ GET /groups  ]  ``` -You can search for groups by name or path with: `/groups?search=Rails` +You can search for groups by name or path, see below.  ## Details of a group @@ -73,6 +73,26 @@ Parameters:  - `id` (required) - The ID of a user group +## Search for group + +Get all groups that match your string in their name or path. + +``` +GET /groups?search=foobar +``` + +```json +[ +  { +    "id": 1, +    "name": "Foobar Group", +    "path": "foo-bar", +    "owner_id": 18, +    "description": "An interesting group" +  } +] +``` +  ## Group members  **Group access levels** | 
