Group Users

Manage users assigned to group or to client account groups.

GET /groups/{id}/users


Description	Get the details for all users in a group.
Permissions	dashboard.library
Resource URL	https://app.klipfolio.com/api/1.0/groups/{id}/users
Parameters	optional: client_id

Example Request

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

GET https://app.klipfolio.com/api/1.0/groups/{id}/users?client_id=0123456789abcdef0123456789abcdef

Example Response

{"meta":{"success":true,"status":200},
"data":
{
"users":[
  {"id":"2e21eda434a5169f9890576ec4d8e789",
   "first_name":"XYZ",
   "last_name":"ZYX",
   "email":"[email protected]"}
]}}

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


Description	Add the user to the group.
Permissions	dashboard.library
Resource URL	https://app.klipfolio.com/api/1.0/groups/{id}/users/{userid}
Parameters	optional: client_id

Example Request

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

PUT https://app.klipfolio.com/api/1/groups/0123456789abcdef0123456789abcdef/users/asdbef012345789?client_id=0123456789abcdef0123456789abcdef

Example Response

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

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


Description	Delete a user from a group.
Permissions	user.manage
Resource URL	https://app.klipfolio.com/api/1.0/groups/{id}/users/{id}
Parameters	optional: client_id

Example Request

DELETE https://app.klipfolio.com/api/1/groups/0987654321qwer/users/098765432211abc

DELETE https://app.klipfolio.com/api/1/groups/0987654321qwer/users/098765432211abc?client_id=0123456789abcdef0123456789abcdef

Example Response

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