{"_id":"564b7fa8cc472d0d00da9447","version":{"_id":"563a252d50bf950d00e0979b","__v":7,"project":"563a252d50bf950d00e09798","createdAt":"2015-11-04T15:33:01.701Z","releaseDate":"2015-11-04T15:33:01.701Z","categories":["563a252e50bf950d00e0979c","563a2a691846790d008952fe","563a3394daf1c00d00136d9b","563a3467d25e8919005f3f0c","563a347850bf950d00e097b4","570e5cec10aa423200391fb5","5890d358d6cb8e2500a3f311"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"project":"563a252d50bf950d00e09798","__v":13,"category":{"_id":"563a252e50bf950d00e0979c","project":"563a252d50bf950d00e09798","pages":["563a252f50bf950d00e0979e","563a35ac1846790d0089532c","563d1407d8f2d20d00448d3c","563d1d3f9799fb0d0004776a","564509aa2c74cf1900da48c7","56453b7e9f3f550d00fa3c7b","564b498aeed7de0d003672c3","564b523ce5d9d61700d580e0","564b58ea1a8e610d006bfd49","564b59baee12850d00958656","564b6773d969330d00aba984","564b69b2d7b95d0d00ed050f","564b7fa8cc472d0d00da9447","564b905fa8a0ba21002ad6b1","564ba051288b1a2b00b3ae83","564ba6275cc43717009bcff1","564bb2138841060d00abb2e0","564bb74e05c99e1700161dd1","564c8ad60ddedc210051e582","564cca42d0c5b42b002305e8","564cca8ecfa4452b0019926d","564ce34f404ce53500fdb255","564cea76404ce53500fdb272","564cedb77d4d31170028dd2e","564cefc1bc81632100b10468","564cf17d1f42792b00820515","564cf5462248461700bd4017","564ddd49a8671617004e7b90","564ddf9ead1d5217003e2e18","564de1dea8671617004e7b99","564de3c11133043500f4bf96","564de669e39c4435005a1f65","564df3f16eaa3a2100868961","5655d3519347d30d00d7e8e2"],"version":"563a252d50bf950d00e0979b","__v":34,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-04T15:33:02.244Z","from_sync":false,"order":9999,"slug":"documentation","title":"Documentation"},"user":"54c7fdeae317000d007c2765","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-17T19:27:36.491Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":18,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /groups\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Get the details for all groups\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"user.manage\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/groups\",\n    \"3-1\": \"client_id (string) — show only groups that belong to a specific client\\nexternal_id (string) — show only groups that have the specified external_id\\nfull (true/false) — include associations in the listing (members) (Note: Only works when specifying external_id.)\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`GET https://app.klipfolio.com/api/1/groups`\n\n##Example Response\n```\n\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {\n    \"id\": \"c17db511dbc00421d0a093fc8c236064\",\n    \"company\": \"Hello\",\n    \"first_name\": \"Jane\",\n    \"last_name\": \"Doe\",\n    \"email\": \"jdoe:::at:::test.com\",\n    \"date_last_login\": \"2016-06-17T18:12:11Z\",\n    \"date_created\": \"2016-06-17T18:12:06Z\",\n    \"is_locked_out\": false\n  }\n}\n``` \n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /groups/{id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-1\": \"Get the details for the specific group.\",\n    \"0-0\": \"Description\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"user.manage\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/groups/{id}\",\n    \"3-1\": \"full (true/false) — include associations in the listing (members)\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`GET https://app.klipfolio.com/api/1/groups/42c1abcdefgh54d44029ee5199111c2b?full=true`\n##Example Response\n```\n{\n  \"meta\": {\n    \"success\": true,\n    \"status\": 200\n  },\n  \"data\": {\n    \"id\": \"42c1accfbcfd54d44029ee5199805a9y\",\n    \"external_id\": \"group_api\",\n    \"company\": \"Self\",\n    \"name\": \"APIGroup\",\n    \"description\": \"Updated group\",\n    \"num_members\": 1,\n    \"members\": [\n      {\n        \"id\": \"2e21abc434a5169f9890576ec4d8e333\",\n        \"full_name\": \"Jane Doe\"\n      }\n    ]\n  }\n}\n\n\n``` \n\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"POST /groups\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Create a new group.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"dashboard.library\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/groups\",\n    \"3-1\": \"None.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`POST https://app.klipfolio.com/api/1/groups -d \"{'name':'New Group', 'description':'A brand new group', ‘client_id’:’1234567890’, 'external_id':'group_api'}\"`\n\n##Example Response\n```\n{\n\"meta\": {\n   \"success\": true,\n   \"status\": 201,\n   \"location\": \"/groups/0932d8270fb840f102d542331f200aca\"\n}\n}\n```\n[block:api-header]\n{\n  \"type\": \"put\",\n  \"title\": \"PUT /groups/{id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Update the specified group.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"dashboard.library\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/groups/{id}\",\n    \"3-1\": \"name, description, external_id\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`PUT https://app.klipfolio.com/api/1/groups/012345678998745641asfd -d \"{description:'This is new'}\"`\n\n##Example Response\n```\n{\n\"meta\": {\n   \"status\": 200,\n   \"success\": true\n}\n}\n```\n[block:api-header]\n{\n  \"type\": \"delete\",\n  \"title\": \"DELETE /groups/{id}\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Delete a group.\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"user.manage\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/groups/{id}\",\n    \"3-1\": \"None.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request\n`DELETE https://app.klipfolio.com/api/1/groups/0987654321qwer -d`\n##Example Response\n```\n{\n\"meta\": {\n      \"status\": 200,\n      \"success\": true\n  }\n}\n```","excerpt":"","slug":"groups","type":"basic","title":"Groups"}
[block:api-header] { "type": "get", "title": "GET /groups" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Get the details for all groups", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "user.manage", "2-1": "https://app.klipfolio.com/api/1.0/groups", "3-1": "client_id (string) — show only groups that belong to a specific client\nexternal_id (string) — show only groups that have the specified external_id\nfull (true/false) — include associations in the listing (members) (Note: Only works when specifying external_id.)" }, "cols": 2, "rows": 4 } [/block] ##Example Request `GET https://app.klipfolio.com/api/1/groups` ##Example Response ``` { "meta": { "success": true, "status": 200 }, "data": { "id": "c17db511dbc00421d0a093fc8c236064", "company": "Hello", "first_name": "Jane", "last_name": "Doe", "email": "jdoe@test.com", "date_last_login": "2016-06-17T18:12:11Z", "date_created": "2016-06-17T18:12:06Z", "is_locked_out": false } } ```  [block:api-header] { "type": "get", "title": "GET /groups/{id}" } [/block] [block:parameters] { "data": { "0-1": "Get the details for the specific group.", "0-0": "Description", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "user.manage", "2-1": "https://app.klipfolio.com/api/1.0/groups/{id}", "3-1": "full (true/false) — include associations in the listing (members)" }, "cols": 2, "rows": 4 } [/block] ##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" } ] } } ```  [block:api-header] { "type": "post", "title": "POST /groups" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Create a new group.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "dashboard.library", "2-1": "https://app.klipfolio.com/api/1.0/groups", "3-1": "None." }, "cols": 2, "rows": 4 } [/block] ##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" } } ``` [block:api-header] { "type": "put", "title": "PUT /groups/{id}" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Update the specified group.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "dashboard.library", "2-1": "https://app.klipfolio.com/api/1.0/groups/{id}", "3-1": "name, description, external_id" }, "cols": 2, "rows": 4 } [/block] ##Example Request `PUT https://app.klipfolio.com/api/1/groups/012345678998745641asfd -d "{description:'This is new'}"` ##Example Response ``` { "meta": { "status": 200, "success": true } } ``` [block:api-header] { "type": "delete", "title": "DELETE /groups/{id}" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Delete a group.", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "user.manage", "2-1": "https://app.klipfolio.com/api/1.0/groups/{id}", "3-1": "None." }, "cols": 2, "rows": 4 } [/block] ##Example Request `DELETE https://app.klipfolio.com/api/1/groups/0987654321qwer -d` ##Example Response ``` { "meta": { "status": 200, "success": true } } ```