{"_id":"570e5f8eb5e70e3200b7bdd7","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"},"__v":10,"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"},"parentDoc":null,"project":"563a252d50bf950d00e09798","user":"54c7fdeae317000d007c2765","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-13T15:02:38.728Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":26,"body":"[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"GET /profile\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Description\",\n    \"0-1\": \"Retrieve information about the authenticated user account.\\n\\nWhen the full parameter is set to true, the information includes associations (tab instances, dashboard properties, permissions for the authenticated user account).\",\n    \"1-0\": \"Permissions\",\n    \"2-0\": \"Resource URL\",\n    \"3-0\": \"Parameters\",\n    \"1-1\": \"\",\n    \"2-1\": \"https://app.klipfolio.com/api/1.0/profile\",\n    \"3-1\": \"full (true/false) — include associations in the listing (tab instances, dashboard properties, permissions).\\nDefault is false.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n##Example Request when full = false\nGET https://app.klipfolio.com/api/1/profile/011oct56d97775c3f18d281e3e3c0ggf\n\n##Example Response\n```\n{\n    \"data\": {\n    \"id\": \"012feb56d97275c3f18d281e3e3c0ffd\",\n    \"company\": { \"id\": \"3c9bf419ff803d7303e3db735f0fe20d\", \"name\": \"Test Inc.\" },\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\",\n    \"email\": \"jdoe:::at:::example.com\",\n    \"date_last_login\": \"2016-04-11T15:29:49Z\",\n    \"date_created\": \"2016-04-11T15:22:51Z\",\n    \"is_locked_out\": false\n  }\n}\n```\n##Example Request when full = true\nGET https://app.klipfolio.com/api/1/profile/011oct56d97775c3f18d281e3e3c0ggf?full=true\n\n##Example Response\n```\n{\n     \"data\": {\n    \"id\": \"012feb56d97275c3f18d281e3e3c0ffd\",\n    \"company\": { \"id\": \"3c9bf419ff803d7303e3db735f0fe20d\", \"name\": \"Test Inc.\" },\n    \"first_name\": \"John\",\n    \"last_name\": \"Doe\",\n    \"email\": \"jdoe@example.com\",\n    \"date_last_login\": \"2016-04-11T15:29:49Z\",\n    \"date_created\": \"2016-04-11T15:22:51Z\",\n    \"is_locked_out\": false,\n    \"tab_instances\": [\n      {\n        \"id\": \"9ebf35d99804cade918362557136abe2\",\n        \"tab_id\": \"99e6e6a668f77e7080994741d3e934ae\",\n        \"name\": \"How To: Klip Template Gallery\",\n        \"context\": \"desktop\",\n        \"layout\": { \"type\": \"\", \"state\": { } }\n      }\n}\n```","excerpt":"View information about the authenticated user account.","slug":"profile","type":"basic","title":"Profile"}

Profile

View information about the authenticated user account.

[block:api-header] { "type": "get", "title": "GET /profile" } [/block] [block:parameters] { "data": { "0-0": "Description", "0-1": "Retrieve information about the authenticated user account.\n\nWhen the full parameter is set to true, the information includes associations (tab instances, dashboard properties, permissions for the authenticated user account).", "1-0": "Permissions", "2-0": "Resource URL", "3-0": "Parameters", "1-1": "", "2-1": "https://app.klipfolio.com/api/1.0/profile", "3-1": "full (true/false) — include associations in the listing (tab instances, dashboard properties, permissions).\nDefault is false." }, "cols": 2, "rows": 4 } [/block] ##Example Request when full = false GET https://app.klipfolio.com/api/1/profile/011oct56d97775c3f18d281e3e3c0ggf ##Example Response ``` { "data": { "id": "012feb56d97275c3f18d281e3e3c0ffd", "company": { "id": "3c9bf419ff803d7303e3db735f0fe20d", "name": "Test Inc." }, "first_name": "John", "last_name": "Doe", "email": "jdoe@example.com", "date_last_login": "2016-04-11T15:29:49Z", "date_created": "2016-04-11T15:22:51Z", "is_locked_out": false } } ``` ##Example Request when full = true GET https://app.klipfolio.com/api/1/profile/011oct56d97775c3f18d281e3e3c0ggf?full=true ##Example Response ``` { "data": { "id": "012feb56d97275c3f18d281e3e3c0ffd", "company": { "id": "3c9bf419ff803d7303e3db735f0fe20d", "name": "Test Inc." }, "first_name": "John", "last_name": "Doe", "email": "jdoe@example.com", "date_last_login": "2016-04-11T15:29:49Z", "date_created": "2016-04-11T15:22:51Z", "is_locked_out": false, "tab_instances": [ { "id": "9ebf35d99804cade918362557136abe2", "tab_id": "99e6e6a668f77e7080994741d3e934ae", "name": "How To: Klip Template Gallery", "context": "desktop", "layout": { "type": "", "state": { } } } } ```