GET /groups
| Description | Get the details for all groups |
| Resource URL | https://app.klipfolio.com/api/1.0/groups |
| Parameters | client_id (string) — show only groups that belong to a specific client external_id (string) — show only groups that have the specified external_id full (true/false) — include associations in the listing (members) (Note: Only works when specifying external_id) |
Example Request
'GET https://app.klipfolio.com/api/1/groups'
Example Response
{
"meta": {
"status": 200,
"success": true
},
"data":{
"groups":[
{
"id": "42c1accfbcfd54d44029ee5199805a9y",
"name": "All Users",
"description": "All of the users in your company"
},
{
"id": "2e21abc434a5169f9890576ec4d8e333",
"name": "Internal",
"description": "For access to client accounts"
}
]
}
}
GET /groups/{id}
| Description | Get the details for the specific group. |
| Permissions | user.manage |
| Resource URL | https://app.klipfolio.com/api/1.0/groups/{id} |
| Parameters | full (true/false) — include associations in the listing (members) |
Example Request
'GET https://app.klipfolio.com/api/1/groups/42c1abcdefgh54d44029ee5199111c2b?full=true'
Example Response
{
"meta": {
"success": true,
"status": 200
},
"data": {
"id": "42c1accfbcfd54d44029ee5199805a9y",
"external_id": "group_api",
"company": "Self",
"name": "APIGroup",
"description": "Updated group",
"num_members": 1,
"members": [
{
"id": "2e21abc434a5169f9890576ec4d8e333",
"full_name": "Jane Doe"
}
]
}
}
POST /groups
| Description | Create a new group. |
| Permissions | dashboard.library |
| Resource URL | https://app.klipfolio.com/api/1.0/groups |
| Parameters | None. |
Example Request
POST https://app.klipfolio.com/api/1/groups -d "{'name':'New Group', 'description':'A brand new group', 'client_id':'1234567890', 'external_id':'group_api'}"
Example Response
{
"meta": {
"success": true,
"status": 201,
"location": "/groups/0932d8270fb840f102d542331f200aca"
}
}
PUT /groups/{id}
| Description | Update the specified group. |
| Permissions | dashboard.library |
| Resource URL | https://app.klipfolio.com/api/1.0/groups/{id} |
| Parameters | name, description, external_id |
Example Request
PUT https://app.klipfolio.com/api/1/groups/012345678998745641asfd -d "{description:'This is new'}"
Example Response
{
"meta": {
"status": 200,
"success": true
}
}
DELETE /groups/{id}
| Description | Delete a group. |
| Permissions | user.manage |
| Resource URL | https://app.klipfolio.com/api/1.0/groups/{id} |
| Parameters | None. |
Example Request
DELETE https://app.klipfolio.com/api/1/groups/0987654321qwer -d
##Example Response
{
"meta": {
"status": 200,
"success": true
}
}