GET /klips
| Description | Get a list of all the Klips the user can access. |
| Permissions | dashboard.library |
| Resource URL | https://app.klipfolio.com/api/1.0/klips |
| Parameters | client_id (string) — show only klips that belong to a specific client datasource_id (string) — show only |
Example Request
GET https://app.klipfolio.com/api/1/klips?client_id=0123456789abcdef0123456789abcdef
##Example Response
{
"data": {
"klips": [
{
"description": "This is a sample klip",
"id": "fedcba9876543210fedcba9876543210",
"name": "sample klip"
}
]
},
"meta": {
"status": 200,
"success": true
}
}
GET /klips/{id}
| Description | Get the details for the specified Klip. |
| Resource URL | https://app.klipfolio.com/api/1.0/klips/{id} |
| Permissions | dashboard.library |
| Parameters | full (true/false) — include associations (share_rights) |
Example Request
GET https://app.klipfolio.com/api/1/klips/0123456789abcdef0123456789abcdef?full=true
Example Response
{
"data": {
"company": "Klipfolio",
"created_by": "12312312312312312312312312312312",
"date_created": "2014-07-07T14:08:51Z",
"description": "Table klip",
"id": "0123456789abcdef0123456789abcdef",
"last_updated": "2014-09-17T17:59:26Z",
"name": "Inventory",
"share_rights": [
{
"group_id": "5292aac2978f697f02f7ac4459e979fb",
"group_name": "Managers",
"can_edit": false
},
]
},
"meta": {
"status": 200,
"success": true
}
}
GET /klips/{id}/client-instances
| Description | Returns a list of Klip instances for a specified Klip. |
| Resource URL | https://app.klipfolio.com/api/1.0/klips/{id}/client-instances |
| Permissions | client.access dashboard.library |
| Parameters | {id} is the public id of the klip full=[true/false] (full=true returns klip public id, name and client name) |
Example Request
GET https://app.klipfolio.com/api/1/klips/0123456789abcdef0123456789abcdef/client-instances
Example Response
If full is false or omitted
{
"meta": {
"success": true,
"status": 200
},
"data": {
"klips": [
"673e4f4a3cb3bc73fd5ca12d2bf4cd94",
"fd17f1255a1544ab97fd2d9841d03e15"
]
}
}
If full=true
{
"meta": {
"success": true,
"status": 200
},
"data": {
"klips": [
{
"id": "673e4f4a3cb3bc73fd5ca12d2bf4cd94",
"name": "Sample Klip",
"client_name": "Sample Company"
},
{
"id": "fd17f1255a1544ab97fd2d9841d03e15",
"name": "Sample Klip",
"client_name": "Sample Company"
}
]
}
}
POST /klips
| Description | Create a Klip; optionally include ‘client_id’ in the post data to create a Klip for a client. A schema may be specified by including ‘schema’ in the post data. If no schema is specified, the new Klip will have a simple default schema, which may be updated using the /klips/{id}/schema resource. |
| Permissions | klip.build |
| Resource URL | https://app.klipfolio.com/api/1.0/klips |
| Fields | klip.build |
Example Request
POST https://app.klipfolio.com/api/1/klips -d
“{
'name': 'Example',
'description': 'This is a new klip',
‘client_id’: ‘0123456789abcdef0123456789abcdef’
}”
Example Response
{
"data": {},
"meta": {
"location": "/klips/ec6947ab9d07fdd6b9bb41551c79fd31",
"status": 201,
"success": true
}
}
PUT /klips/{id}
| Description | Update the specified klip details. To update the klip schema, use the /klips/{id}/schema resource. |
| Permissions | klip.edit |
| Resource URL | https://app.klipfolio.com/api/1.0/klips/{id} |
| Fields | name, description |
Example Request
PUT https://app.klipfolio.com/api/1/klips/ec6947ab9d07fdd6b9bb41551c79fd31 -d
“{
'name': 'Update',
'description': 'This is an updated klip',
}”
Example Response
{
"data": {},
"meta": {
"status": 200,
"success": true
}
}
DELETE /klips/{id}
| Description | Delete a specified Klip. |
| Permissions | klip.delete |
| Resource URL | https://app.klipfolio.com/api/1.0/klips/{id} |
| Fields | name, description |
Example
DELETE https://app.klipfolio.com/api/1/klips/01dd23b45fc67fd0123d81d16a0123e8 -d
Example Response
{
"data": {},
"meta": {
"status": 200,
"success": true
}
}