View and manage groups to which a user belongs.

GET /users/{id}/groups

Description

Retrieve the list of groups to which the specified user belongs.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/users/{id}/groups

Parameters

None.

Example Request

GET https://app.klipfolio.com/api/1/users/0123456789abcdef0123456789abcdef/groups

Example Response

{
   "data": {
       "groups": [
           {
               "description": All managers in the company,
               "id": "0123456789abcdef0123456789abcdef",
               "name": "Managers"
           },
           {
               "description": "All users in the company",
               "id": "0123456789abcdef0123456789abcdef",
               "name": "All"
           }
       ]
   },
   "meta": {
       "status": 200,
       "success": true
   }

PUT /users/{id}/groups/{id}

Description

Add a specified user to one group at a time.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/users/{id}/groups

Fields

groups, group_id, can_edit (true/false)

Example Request

PUT https://app.klipfolio.com/api/1/users/0123456789abcdef0123456789abcdef/groups/123a2d1234e123f2c7b1234123412341 -d
##Example Response

{
   "meta": {
       "status": 200,
       "success": true
   }
}

DELETE /users/{id}/groups/{id}

Description

Delete a specified user from specified groups.

Permissions

user.manage

Resource URL

https://app.klipfolio.com/api/1.0/users/{id}/groups/{groupId}

Parameters

None.

Example Request

DELETE https://app.klipfolio.com/api/1/users/0123456789abc/groups/01234123411qwer

Example Response

{
"meta": {
      "status": 200,
      "success": true
  }
}