{"__v":7,"_id":"5616288acf2a1e0d002478a4","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"Welcome to the Tilkee API documentation!\nThe Tilkee APIs allow you to integrate complex services with Tilkee to go beyond the integrations we provide out of the box.\n\nYou can view code examples in the area to the right. We provide examples in Curl & PHP.\nThis API supercedes the previous V1 API, which has been deprecated.\n\nFor more information about Tilkee you can visit our product documentation.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Getting in touch!\"\n}\n[/block]\nWe’re excited to see the kinds of things the community builds with Tilkee. Feel free to contact us by email.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. API Summary\"\n}\n[/block]\nThe API is organized around the following resources, you may use in any integration. JSON is returned in all responses.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"API Area\",\n    \"h-1\": \"Resource Area\",\n    \"h-2\": \"Description\",\n    \"2-0\": \"Project\",\n    \"2-1\": \"https://tilkee.readme.io/docs/projects\",\n    \"2-2\": \"Create and update Projects. List projects or access them individually.\",\n    \"3-1\": \"https://tilkee.readme.io/docs/create\",\n    \"3-2\": \"Update, archive or restore « Tilks »\",\n    \"4-1\": \"https://tilkee.readme.io/docs/direct-upload\",\n    \"4-2\": \"Create and update Items. Get lists of Items, or delete them.\",\n    \"3-0\": \"Tilk\",\n    \"4-0\": \"Items\",\n    \"0-2\": \"Everything about authentication and connection to the Tilkee API\",\n    \"0-0\": \"Authorization\",\n    \"1-0\": \"Main functions\",\n    \"1-2\": \"The most useful functions\",\n    \"5-0\": \"Wrapper\",\n    \"6-0\": \"Stats\",\n    \"5-2\": \"Creation of projects with documents directly added in\",\n    \"0-1\": \"https://tilkee.readme.io/docs/authentication\",\n    \"1-1\": \"https://tilkee.readme.io/docs/wrapper\",\n    \"5-1\": \"https://tilkee.readme.io/docs/wrapper-1\",\n    \"6-1\": \"https://tilkee.readme.io/docs/list-of-connexions-on-a-project\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\nSome admin operations may also be done from API. Access to these API calls is restricted to admin accounts.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"API Area\",\n    \"h-1\": \"Resource Area\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"Users\",\n    \"1-0\": \"Company\",\n    \"5-0\": \"Webhooks\",\n    \"6-0\": \"Themes\",\n    \"0-1\": \"https://tilkee.readme.io/docs/list-4\",\n    \"1-1\": \"https://tilkee.readme.io/docs/show-your-info\",\n    \"5-1\": \"https://tilkee.readme.io/docs/list-5\",\n    \"6-1\": \"https://tilkee.readme.io/docs/create-1\",\n    \"0-2\": \"Create and update Users. List users or access them individually.\",\n    \"1-2\": \"Access company details or update company info\",\n    \"5-2\": \"Create and update Items. Get lists of webhooks, or delete them.\",\n    \"6-2\": \"Create and update Themes. Get lists of themes, or delete them\",\n    \"2-0\": \"Connections\",\n    \"2-2\": \"Manage connections\",\n    \"3-0\": \"Organization Contact\",\n    \"3-2\": \"Create and manage an organization contact\",\n    \"4-0\": \"Person Contact\",\n    \"4-2\": \"Manage your contacts\",\n    \"2-1\": \"https://tilkee.readme.io/docs/list-of-connexions-for-a-user\",\n    \"3-1\": \"https://tilkee.readme.io/docs/create-2\",\n    \"4-1\": \"https://tilkee.readme.io/docs/list-1\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"General info\"\n}\n[/block]\nOur API endpoints are: https://api.tilkee.com (production) & https://api-beta.tilkee.com\nFor all call, header must include Content-Type: application/json","category":"561626f5cf2a1e0d002478a3","createdAt":"2015-10-08T08:25:46.759Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"introduction","sync_unique":"","title":"Introduction","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

Introduction


Welcome to the Tilkee API documentation! The Tilkee APIs allow you to integrate complex services with Tilkee to go beyond the integrations we provide out of the box. You can view code examples in the area to the right. We provide examples in Curl & PHP. This API supercedes the previous V1 API, which has been deprecated. For more information about Tilkee you can visit our product documentation. [block:api-header] { "type": "basic", "title": "1. Getting in touch!" } [/block] We’re excited to see the kinds of things the community builds with Tilkee. Feel free to contact us by email. [block:api-header] { "type": "basic", "title": "2. API Summary" } [/block] The API is organized around the following resources, you may use in any integration. JSON is returned in all responses. [block:parameters] { "data": { "h-0": "API Area", "h-1": "Resource Area", "h-2": "Description", "2-0": "Project", "2-1": "https://tilkee.readme.io/docs/projects", "2-2": "Create and update Projects. List projects or access them individually.", "3-1": "https://tilkee.readme.io/docs/create", "3-2": "Update, archive or restore « Tilks »", "4-1": "https://tilkee.readme.io/docs/direct-upload", "4-2": "Create and update Items. Get lists of Items, or delete them.", "3-0": "Tilk", "4-0": "Items", "0-2": "Everything about authentication and connection to the Tilkee API", "0-0": "Authorization", "1-0": "Main functions", "1-2": "The most useful functions", "5-0": "Wrapper", "6-0": "Stats", "5-2": "Creation of projects with documents directly added in", "0-1": "https://tilkee.readme.io/docs/authentication", "1-1": "https://tilkee.readme.io/docs/wrapper", "5-1": "https://tilkee.readme.io/docs/wrapper-1", "6-1": "https://tilkee.readme.io/docs/list-of-connexions-on-a-project" }, "cols": 3, "rows": 7 } [/block] Some admin operations may also be done from API. Access to these API calls is restricted to admin accounts. [block:parameters] { "data": { "h-0": "API Area", "h-1": "Resource Area", "h-2": "Description", "0-0": "Users", "1-0": "Company", "5-0": "Webhooks", "6-0": "Themes", "0-1": "https://tilkee.readme.io/docs/list-4", "1-1": "https://tilkee.readme.io/docs/show-your-info", "5-1": "https://tilkee.readme.io/docs/list-5", "6-1": "https://tilkee.readme.io/docs/create-1", "0-2": "Create and update Users. List users or access them individually.", "1-2": "Access company details or update company info", "5-2": "Create and update Items. Get lists of webhooks, or delete them.", "6-2": "Create and update Themes. Get lists of themes, or delete them", "2-0": "Connections", "2-2": "Manage connections", "3-0": "Organization Contact", "3-2": "Create and manage an organization contact", "4-0": "Person Contact", "4-2": "Manage your contacts", "2-1": "https://tilkee.readme.io/docs/list-of-connexions-for-a-user", "3-1": "https://tilkee.readme.io/docs/create-2", "4-1": "https://tilkee.readme.io/docs/list-1" }, "cols": 3, "rows": 7 } [/block] [block:api-header] { "type": "basic", "title": "General info" } [/block] Our API endpoints are: https://api.tilkee.com (production) & https://api-beta.tilkee.com For all call, header must include Content-Type: application/json
View all 59 endpoints
Welcome to the Tilkee API documentation! The Tilkee APIs allow you to integrate complex services with Tilkee to go beyond the integrations we provide out of the box. You can view code examples in the area to the right. We provide examples in Curl & PHP. This API supercedes the previous V1 API, which has been deprecated. For more information about Tilkee you can visit our product documentation. [block:api-header] { "type": "basic", "title": "1. Getting in touch!" } [/block] We’re excited to see the kinds of things the community builds with Tilkee. Feel free to contact us by email. [block:api-header] { "type": "basic", "title": "2. API Summary" } [/block] The API is organized around the following resources, you may use in any integration. JSON is returned in all responses. [block:parameters] { "data": { "h-0": "API Area", "h-1": "Resource Area", "h-2": "Description", "2-0": "Project", "2-1": "https://tilkee.readme.io/docs/projects", "2-2": "Create and update Projects. List projects or access them individually.", "3-1": "https://tilkee.readme.io/docs/create", "3-2": "Update, archive or restore « Tilks »", "4-1": "https://tilkee.readme.io/docs/direct-upload", "4-2": "Create and update Items. Get lists of Items, or delete them.", "3-0": "Tilk", "4-0": "Items", "0-2": "Everything about authentication and connection to the Tilkee API", "0-0": "Authorization", "1-0": "Main functions", "1-2": "The most useful functions", "5-0": "Wrapper", "6-0": "Stats", "5-2": "Creation of projects with documents directly added in", "0-1": "https://tilkee.readme.io/docs/authentication", "1-1": "https://tilkee.readme.io/docs/wrapper", "5-1": "https://tilkee.readme.io/docs/wrapper-1", "6-1": "https://tilkee.readme.io/docs/list-of-connexions-on-a-project" }, "cols": 3, "rows": 7 } [/block] Some admin operations may also be done from API. Access to these API calls is restricted to admin accounts. [block:parameters] { "data": { "h-0": "API Area", "h-1": "Resource Area", "h-2": "Description", "0-0": "Users", "1-0": "Company", "5-0": "Webhooks", "6-0": "Themes", "0-1": "https://tilkee.readme.io/docs/list-4", "1-1": "https://tilkee.readme.io/docs/show-your-info", "5-1": "https://tilkee.readme.io/docs/list-5", "6-1": "https://tilkee.readme.io/docs/create-1", "0-2": "Create and update Users. List users or access them individually.", "1-2": "Access company details or update company info", "5-2": "Create and update Items. Get lists of webhooks, or delete them.", "6-2": "Create and update Themes. Get lists of themes, or delete them", "2-0": "Connections", "2-2": "Manage connections", "3-0": "Organization Contact", "3-2": "Create and manage an organization contact", "4-0": "Person Contact", "4-2": "Manage your contacts", "2-1": "https://tilkee.readme.io/docs/list-of-connexions-for-a-user", "3-1": "https://tilkee.readme.io/docs/create-2", "4-1": "https://tilkee.readme.io/docs/list-1" }, "cols": 3, "rows": 7 } [/block] [block:api-header] { "type": "basic", "title": "General info" } [/block] Our API endpoints are: https://api.tilkee.com (production) & https://api-beta.tilkee.com For all call, header must include Content-Type: application/json
{"__v":10,"_id":"5620ac98f761a4170068ebed","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"In a standard integration, just follow these steps:\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. Authentication\"\n}\n[/block]\nYou must retreive an oAuth2 access_token, using one of the provided calls: https://tilkee.readme.io/docs/authentication\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/W5jJ55WJRYKVgOckFxTN_Capture%20d’écran%202015-10-12%20à%2009.32.03.png\",\n        \"Capture d’écran 2015-10-12 à 09.32.03.png\",\n        \"582\",\n        \"568\",\n        \"#d35333\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Get projects\"\n}\n[/block]\nYou may list projects using https://tilkee.readme.io/docs/list-2\nTo retreive templates, just add \"is_template=true\" in the GET request\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/GUoz0zwRdSGfwBkfyzIY_Capture%20d’écran%202015-10-12%20à%2009.51.27.png\",\n        \"Capture d’écran 2015-10-12 à 09.51.27.png\",\n        \"558\",\n        \"567\",\n        \"#d25333\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/iOaGZTEmTFKsSJnunqWI_Capture%20d’écran%202015-10-12%20à%2009.32.25%20(2).png\",\n        \"Capture d’écran 2015-10-12 à 09.32.25 (2).png\",\n        \"567\",\n        \"559\",\n        \"#d45135\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"3. Add a link to an existing project\"\n}\n[/block]\nJust POST prospect's name as a title using https://tilkee.readme.io/docs/create\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/VU4cImxRBC7g0M2oBJiq_Capture%20d’écran%202015-10-12%20à%2009.32.17.png\",\n        \"Capture d’écran 2015-10-12 à 09.32.17.png\",\n        \"552\",\n        \"548\",\n        \"#d35434\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"4. Send file to Tilkee\"\n}\n[/block]\nYou may use direct HTTP upload to send us files (PDF, PPT, DOC, etc...) https://tilkee.readme.io/docs/direct-upload\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/mkzzvjDfQTqOzd9yfDsu_Capture%20d’écran%202015-10-12%20à%2009.32.25%20(3).png\",\n        \"Capture d’écran 2015-10-12 à 09.32.25 (3).png\",\n        \"567\",\n        \"559\",\n        \"#d35234\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"5. Create a project\"\n}\n[/block]\nOur wrapper function allows you to create a project and retreive a new link with one call: https://tilkee.readme.io/docs/wrapper-1\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9avKA3BGQiODEuF2SZuZ_Capture%20d’écran%202015-10-12%20à%2009.51.27%20(5).png\",\n        \"Capture d’écran 2015-10-12 à 09.51.27 (5).png\",\n        \"558\",\n        \"567\",\n        \"#d55035\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/YqQElMHFTNuWAa5yMNbT_Capture%20d’écran%202015-10-12%20à%2009.32.25%20(4).png\",\n        \"Capture d’écran 2015-10-12 à 09.32.25 (4).png\",\n        \"567\",\n        \"559\",\n        \"#d35234\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"6. Archive a project\"\n}\n[/block]\nWhen the opportunity is closed, you must archive the project in Tilkee (https://tilkee.readme.io/docs/archive), with a status (won/lost/na)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"7. Misc\"\n}\n[/block]\nIf you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"USER_ID\",\n    \"1-0\": \"USER_EMAIL\",\n    \"2-0\": \"USER_SF_ID\",\n    \"h-0\": \"Header field name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Example\",\n    \"0-1\": \"Tilkee internal user id\",\n    \"1-1\": \"Tilkee user login\",\n    \"2-1\": \"External id\",\n    \"0-2\": \"USER_ID: 3245\",\n    \"1-2\": \"USER_EMAIL: test@tilkee.com\",\n    \"2-2\": \"USER_SF_ID: 00524099011kl0FFF\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]","category":"561626f5cf2a1e0d002478a3","createdAt":"2015-10-16T07:51:52.593Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"standard-workflow","sync_unique":"","title":"Standard workflow","type":"basic","updates":["570dfd1210aa423200391ebb"],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

Standard workflow


In a standard integration, just follow these steps: [block:api-header] { "type": "basic", "title": "1. Authentication" } [/block] You must retreive an oAuth2 access_token, using one of the provided calls: https://tilkee.readme.io/docs/authentication [block:image] { "images": [ { "image": [ "https://files.readme.io/W5jJ55WJRYKVgOckFxTN_Capture%20d’écran%202015-10-12%20à%2009.32.03.png", "Capture d’écran 2015-10-12 à 09.32.03.png", "582", "568", "#d35333", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "2. Get projects" } [/block] You may list projects using https://tilkee.readme.io/docs/list-2 To retreive templates, just add "is_template=true" in the GET request [block:image] { "images": [ { "image": [ "https://files.readme.io/GUoz0zwRdSGfwBkfyzIY_Capture%20d’écran%202015-10-12%20à%2009.51.27.png", "Capture d’écran 2015-10-12 à 09.51.27.png", "558", "567", "#d25333", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/iOaGZTEmTFKsSJnunqWI_Capture%20d’écran%202015-10-12%20à%2009.32.25%20(2).png", "Capture d’écran 2015-10-12 à 09.32.25 (2).png", "567", "559", "#d45135", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "3. Add a link to an existing project" } [/block] Just POST prospect's name as a title using https://tilkee.readme.io/docs/create [block:image] { "images": [ { "image": [ "https://files.readme.io/VU4cImxRBC7g0M2oBJiq_Capture%20d’écran%202015-10-12%20à%2009.32.17.png", "Capture d’écran 2015-10-12 à 09.32.17.png", "552", "548", "#d35434", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "4. Send file to Tilkee" } [/block] You may use direct HTTP upload to send us files (PDF, PPT, DOC, etc...) https://tilkee.readme.io/docs/direct-upload [block:image] { "images": [ { "image": [ "https://files.readme.io/mkzzvjDfQTqOzd9yfDsu_Capture%20d’écran%202015-10-12%20à%2009.32.25%20(3).png", "Capture d’écran 2015-10-12 à 09.32.25 (3).png", "567", "559", "#d35234", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "5. Create a project" } [/block] Our wrapper function allows you to create a project and retreive a new link with one call: https://tilkee.readme.io/docs/wrapper-1 [block:image] { "images": [ { "image": [ "https://files.readme.io/9avKA3BGQiODEuF2SZuZ_Capture%20d’écran%202015-10-12%20à%2009.51.27%20(5).png", "Capture d’écran 2015-10-12 à 09.51.27 (5).png", "558", "567", "#d55035", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/YqQElMHFTNuWAa5yMNbT_Capture%20d’écran%202015-10-12%20à%2009.32.25%20(4).png", "Capture d’écran 2015-10-12 à 09.32.25 (4).png", "567", "559", "#d35234", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "6. Archive a project" } [/block] When the opportunity is closed, you must archive the project in Tilkee (https://tilkee.readme.io/docs/archive), with a status (won/lost/na) [block:api-header] { "type": "basic", "title": "7. Misc" } [/block] If you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers: [block:parameters] { "data": { "0-0": "USER_ID", "1-0": "USER_EMAIL", "2-0": "USER_SF_ID", "h-0": "Header field name", "h-1": "Description", "h-2": "Example", "0-1": "Tilkee internal user id", "1-1": "Tilkee user login", "2-1": "External id", "0-2": "USER_ID: 3245", "1-2": "USER_EMAIL: test@tilkee.com", "2-2": "USER_SF_ID: 00524099011kl0FFF" }, "cols": 3, "rows": 3 } [/block]
In a standard integration, just follow these steps: [block:api-header] { "type": "basic", "title": "1. Authentication" } [/block] You must retreive an oAuth2 access_token, using one of the provided calls: https://tilkee.readme.io/docs/authentication [block:image] { "images": [ { "image": [ "https://files.readme.io/W5jJ55WJRYKVgOckFxTN_Capture%20d’écran%202015-10-12%20à%2009.32.03.png", "Capture d’écran 2015-10-12 à 09.32.03.png", "582", "568", "#d35333", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "2. Get projects" } [/block] You may list projects using https://tilkee.readme.io/docs/list-2 To retreive templates, just add "is_template=true" in the GET request [block:image] { "images": [ { "image": [ "https://files.readme.io/GUoz0zwRdSGfwBkfyzIY_Capture%20d’écran%202015-10-12%20à%2009.51.27.png", "Capture d’écran 2015-10-12 à 09.51.27.png", "558", "567", "#d25333", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/iOaGZTEmTFKsSJnunqWI_Capture%20d’écran%202015-10-12%20à%2009.32.25%20(2).png", "Capture d’écran 2015-10-12 à 09.32.25 (2).png", "567", "559", "#d45135", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "3. Add a link to an existing project" } [/block] Just POST prospect's name as a title using https://tilkee.readme.io/docs/create [block:image] { "images": [ { "image": [ "https://files.readme.io/VU4cImxRBC7g0M2oBJiq_Capture%20d’écran%202015-10-12%20à%2009.32.17.png", "Capture d’écran 2015-10-12 à 09.32.17.png", "552", "548", "#d35434", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "4. Send file to Tilkee" } [/block] You may use direct HTTP upload to send us files (PDF, PPT, DOC, etc...) https://tilkee.readme.io/docs/direct-upload [block:image] { "images": [ { "image": [ "https://files.readme.io/mkzzvjDfQTqOzd9yfDsu_Capture%20d’écran%202015-10-12%20à%2009.32.25%20(3).png", "Capture d’écran 2015-10-12 à 09.32.25 (3).png", "567", "559", "#d35234", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "5. Create a project" } [/block] Our wrapper function allows you to create a project and retreive a new link with one call: https://tilkee.readme.io/docs/wrapper-1 [block:image] { "images": [ { "image": [ "https://files.readme.io/9avKA3BGQiODEuF2SZuZ_Capture%20d’écran%202015-10-12%20à%2009.51.27%20(5).png", "Capture d’écran 2015-10-12 à 09.51.27 (5).png", "558", "567", "#d55035", "" ] } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/YqQElMHFTNuWAa5yMNbT_Capture%20d’écran%202015-10-12%20à%2009.32.25%20(4).png", "Capture d’écran 2015-10-12 à 09.32.25 (4).png", "567", "559", "#d35234", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "6. Archive a project" } [/block] When the opportunity is closed, you must archive the project in Tilkee (https://tilkee.readme.io/docs/archive), with a status (won/lost/na) [block:api-header] { "type": "basic", "title": "7. Misc" } [/block] If you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers: [block:parameters] { "data": { "0-0": "USER_ID", "1-0": "USER_EMAIL", "2-0": "USER_SF_ID", "h-0": "Header field name", "h-1": "Description", "h-2": "Example", "0-1": "Tilkee internal user id", "1-1": "Tilkee user login", "2-1": "External id", "0-2": "USER_ID: 3245", "1-2": "USER_EMAIL: test@tilkee.com", "2-2": "USER_SF_ID: 00524099011kl0FFF" }, "cols": 3, "rows": 3 } [/block]
{"__v":2,"_id":"5620ab016e20d40d00731006","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"The primary goal of OAuth is to allow developers to interact with Tilkee without requiring them to store sensitive credentials. Our implementation also allows users to manage their own connections.\nIf you are new to the world of OAuth, you can read more at http://oauth.net.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"\"\n}\n[/block]","category":"561539a0beee6f0d009df20e","createdAt":"2015-10-16T07:45:05.102Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"authentication","sync_unique":"","title":"Authentication - oAuth2","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

Authentication - oAuth2


The primary goal of OAuth is to allow developers to interact with Tilkee without requiring them to store sensitive credentials. Our implementation also allows users to manage their own connections. If you are new to the world of OAuth, you can read more at http://oauth.net. [block:api-header] { "type": "basic", "title": "" } [/block]
The primary goal of OAuth is to allow developers to interact with Tilkee without requiring them to store sensitive credentials. Our implementation also allows users to manage their own connections. If you are new to the world of OAuth, you can read more at http://oauth.net. [block:api-header] { "type": "basic", "title": "" } [/block]
{"__v":0,"_id":"561539904c7b1c0d00fc3082","api":{"auth":"optional","examples":{"codes":[{"language":"json","code":"{\n  \"password\": \"defdef\",\n  \"username\": \"paul2@tilkee.com\",\n  \"grant_type\": \"password\"\n  }","name":""}]},"params":[{"_id":"561539904c7b1c0d00fc3085","required":true,"desc":"Password of your Tilkee account","default":"","type":"string","name":"password","in":"body"},{"_id":"561539904c7b1c0d00fc3084","required":true,"desc":"Username of your Tilkee account","default":"","type":"string","name":"username","in":"body"},{"_id":"561539904c7b1c0d00fc3083","required":true,"desc":"","default":"password","type":"string","name":"grant_type","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"access_token\": \"409ce238be04ae42022c78b41f593c2934c6586283cb79d93e183309c180968a\",\n  \"token_type\": \"bearer\",\n  \"expires_in\": 1209600,\n  \"refresh_token\": \"a02364b4d26e23e4179ef66c5fde433301208b643cc04622974999fdf0af5591\",\n  \"scope\": \"public\",\n  \"created_at\": 1444231303\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/oauth/token"},"body":"","category":"561539a0beee6f0d009df20e","createdAt":"2015-10-07T15:26:08.797Z","editedParams":true,"editedParams2":true,"excerpt":"To get an access token you need to go through the access token flow and prompt the user to authorize your application to act on his or her behalf.","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"authentification","sync_unique":"","title":"Access Token","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postAccess Token

To get an access token you need to go through the access token flow and prompt the user to authorize your application to act on his or her behalf.

Body JSON

password:
required
string
Password of your Tilkee account
username:
required
string
Username of your Tilkee account
grant_type:
required
stringpassword

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":3,"_id":"561b7053868acd0d0043ad4c","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"If your users are logged using any oAuth2 providers, you may retreive access tokens using these URL:\n\nGoogle: https://api.tilkee.com/users/auth/google_oauth2?redirect_token_to=json\nSalesforce: https://api.tilkee.com/users/auth/salesforce?redirect_token_to=json\nLinkedin: https://api.tilkee.com/users/auth/linkedin?redirect_token_to=json\nAzure:  https://api.tilkee.com/users/auth/azure_oauth2?redirect_token_to=json","category":"561539a0beee6f0d009df20e","createdAt":"2015-10-12T08:33:23.631Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"with-external-oauth2","sync_unique":"","title":"External provider","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

External provider


If your users are logged using any oAuth2 providers, you may retreive access tokens using these URL: Google: https://api.tilkee.com/users/auth/google_oauth2?redirect_token_to=json Salesforce: https://api.tilkee.com/users/auth/salesforce?redirect_token_to=json Linkedin: https://api.tilkee.com/users/auth/linkedin?redirect_token_to=json Azure: https://api.tilkee.com/users/auth/azure_oauth2?redirect_token_to=json
If your users are logged using any oAuth2 providers, you may retreive access tokens using these URL: Google: https://api.tilkee.com/users/auth/google_oauth2?redirect_token_to=json Salesforce: https://api.tilkee.com/users/auth/salesforce?redirect_token_to=json Linkedin: https://api.tilkee.com/users/auth/linkedin?redirect_token_to=json Azure: https://api.tilkee.com/users/auth/azure_oauth2?redirect_token_to=json
{"__v":1,"_id":"561b7082f619210d00a85c2f","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"As a registered partner, you may request a unique ClientID, allowing your user to login to Tilkee and redirect to your application with a valid access_token:\n\nhttps://api.tilkee.com/oauth/authorize?response_type=token&client_id=99999cb2a1c3ecbb5211e7d70cce574aeb16710597387cf3a&redirect_uri=https://APPLI_URL\n\nMore info: https://tools.ietf.org/html/rfc6749#section-4.1.1","category":"561539a0beee6f0d009df20e","createdAt":"2015-10-12T08:34:10.396Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"with-oauth-clientid","sync_unique":"","title":"oAuth2 clientID","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

oAuth2 clientID


As a registered partner, you may request a unique ClientID, allowing your user to login to Tilkee and redirect to your application with a valid access_token: https://api.tilkee.com/oauth/authorize?response_type=token&client_id=99999cb2a1c3ecbb5211e7d70cce574aeb16710597387cf3a&redirect_uri=https://APPLI_URL More info: https://tools.ietf.org/html/rfc6749#section-4.1.1
As a registered partner, you may request a unique ClientID, allowing your user to login to Tilkee and redirect to your application with a valid access_token: https://api.tilkee.com/oauth/authorize?response_type=token&client_id=99999cb2a1c3ecbb5211e7d70cce574aeb16710597387cf3a&redirect_uri=https://APPLI_URL More info: https://tools.ietf.org/html/rfc6749#section-4.1.1
{"__v":6,"_id":"56153c958113d20d00082ed9","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","code":"{\n  \"access_token\": \"2d6fe5f9bfc37a827e62c8c85613cf77a76ec397a9c432f54f8b4e6c69a961cd\",\n  \"token_type\": \"bearer\",\n  \"expires_in\": 1209600,\n  \"refresh_token\": \"cfe4028435c17271e35909fbd1a437efdcbd8d725c9d24ea19f040718ca6fc55\",\n  \"scope\": \"public\",\n  \"created_at\": 1444232309\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"560e512539fad419002ae15d","url":"/api_keys/"},"body":"If you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers: https://tilkee.readme.io/docs/standard-workflow#7-misc","category":"561539a0beee6f0d009df20e","createdAt":"2015-10-07T15:39:01.353Z","excerpt":"You may need a global access to all the company projects & ressources, without expiry (API Key).\n\nSince your API keys allow privileged access it is imperative that you keep them secret.\nAPI Keys can be revoked via API (POST).\n\nTo get an API Key you need to go through the API.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"generate-an-api-key","sync_unique":"","title":"Global company API key","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postGlobal company API key

You may need a global access to all the company projects & ressources, without expiry (API Key). Since your API keys allow privileged access it is imperative that you keep them secret. API Keys can be revoked via API (POST). To get an API Key you need to go through the API.

If you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers: https://tilkee.readme.io/docs/standard-workflow#7-misc

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



If you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers: https://tilkee.readme.io/docs/standard-workflow#7-misc
{"__v":2,"_id":"56153cc5a4ccab0d00e6991a","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"contents\": [\n    {\n      \"id\": 13636,\n      \"api_key\": \"dbdb8781959dd37dd5acba8c119d37dd2a9e454623aaa2ac12d9ee7c2dfb3ff2\",\n      \"created_at\": \"2015-10-09T16:00:07.900+02:00\"\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/api_keys"},"body":"","category":"561539a0beee6f0d009df20e","createdAt":"2015-10-07T15:39:49.993Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"check-your-api-key","sync_unique":"","title":"Check your API key","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getCheck your API key



User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"5624dfec54736219006894dc","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"null","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/api_keys/:api_key_id"},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","category":"561539a0beee6f0d009df20e","createdAt":"2015-10-19T12:19:56.378Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"revoke-api-key","sync_unique":"","title":"Revoke API key","type":"delete","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

deleteRevoke API key


Lorem ipsum dolor sit amet, consectetur adipiscing elit.

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit.
{"__v":7,"_id":"561546968113d20d00082f76","api":{"auth":"required","examples":{"codes":[{"name":"","code":"{\n \"project\": {\n \"id\": 29328,\n   \"name\": \"Wrapper test project\"\n },\n \"person\": {\n \n \"name\": \"paul+finaltest@tilkee.com\"\n },\n \"documents\": [\n {\"name\": \"JuryHEI4.pdf\", \"s3_url\": \"https://datatlk.s3.amazonaws.com/uploads%2F3013%2F9c0193efc7816a2bb4828414c1a957f8%2FJury+HEI4+du+26+juin+2015.pdf\"},\n {\"name\": \"finance2013/2014.pdf\", \"s3_url\": \"https://datatlk.s3.amazonaws.com/uploads%2F3013%2F9c0193efc7816a2bb4828414c1a957f8%2FComptabilit%EF%BF%BD+Finance+2013-2014.pdf\",\"signable\": true}\n ]\n }","language":"json"}]},"params":[{"_id":"561546968113d20d00082f7b","ref":"","in":"body","required":true,"desc":"Title of the new project (if creation)","default":"","type":"string","name":"project.name"},{"_id":"561546968113d20d00082f7c","ref":"","in":"body","required":false,"desc":"Id of an existing project that will be duplicated","default":"","type":"int","name":"project.id"},{"_id":"573db385daba6a1900e0cd64","ref":"","in":"body","required":false,"desc":"Theme ID","default":"","type":"int","name":"project.theme_id"},{"_id":"5742c61815bb500e00fd8870","ref":"","in":"body","required":false,"desc":"Date to archive the project at","default":"","type":"yyyy-mm-dd","name":"project.archived_at"},{"_id":"573db385daba6a1900e0cd62","ref":"","in":"body","required":false,"desc":"Is it a starred project?","default":"false","type":"boolean","name":"project.starred"},{"_id":"573db385daba6a1900e0cd61","ref":"","in":"body","required":false,"desc":"Is the project downloadable?","default":"true","type":"boolean","name":"project.can_be_downloaded"},{"_id":"5742c61815bb500e00fd886f","default":"","desc":"ID of the project in your system","in":"body","name":"project.external_id","ref":"","required":false,"type":"string"},{"_id":"561546968113d20d00082f79","ref":"","in":"body","required":true,"desc":"Name of the link","default":"","type":"string","name":"person.name"},{"_id":"57bb131f7c05760e0034542a","default":"","desc":"ID of the contact in your system","in":"body","name":"person.external_id","ref":"","required":false,"type":"string"},{"_id":"561546968113d20d00082f78","ref":"","in":"body","required":false,"desc":"Name of the document","default":"","type":"string","name":"documents.name"},{"_id":"561546968113d20d00082f77","ref":"","in":"body","required":false,"desc":"Url of the document","default":"","type":"string","name":"documents.s3_url"},{"_id":"56f2c0d8e08906190084b965","ref":"","in":"body","required":false,"desc":"True if signature should be activated on document (PDF)","default":"false","type":"boolean","name":"documents.signable"}],"results":{"codes":[{"name":"","code":"{\n  \"project\": {\n    \"id\": 37989,\n    \"preview_url\": \"https://api-beta2.tilkee.com/projects/37989/preview?signature=RXZXn%2FEiy8xZK%2FZH7SVWs4cEBGbTHUXdAeSsIZ7hKDY%3D%0A\"\n  },\n  \"token\": {\n    \"id\": 144271,\n    \"url\": \"https://api-beta2.tilkee.com/v/ac0aa223ad\"\n  }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"560e512539fad419002ae15d","url":"/wrapper/token_from_files"},"body":"If you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers: https://tilkee.readme.io/docs/standard-workflow#7-misc\nParameter :name or :id is required, both can do too.\nIf you only set :id, the new project will have the same name as the original one.\nThe key 'person' either contains the object 'person' or an array of 'person' objects","category":"561b70f903bce90d00c4bd57","createdAt":"2015-10-07T16:21:42.099Z","editedParams":true,"editedParams2":true,"excerpt":"This section is used for creating projects with documents directly added in. To use this section you need to have a project already created or a template, and your documents have to be on the S3.\n\nIn response you have a new project with your uploaded documents and a tilk.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"wrapper","sync_unique":"","title":"Wrapper","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postWrapper

This section is used for creating projects with documents directly added in. To use this section you need to have a project already created or a template, and your documents have to be on the S3. In response you have a new project with your uploaded documents and a tilk.

Body JSON

project.name:
required
string
Title of the new project (if creation)
project.id:
integer
Id of an existing project that will be duplicated
project.theme_id:
integer
Theme ID
project.archived_at:
yyyy-mm-dd
Date to archive the project at
project.starred:
booleanfalse
Is it a starred project?
project.can_be_downloaded:
booleantrue
Is the project downloadable?
project.external_id:
string
ID of the project in your system
person.name:
required
string
Name of the link
person.external_id:
string
ID of the contact in your system
documents.name:
string
Name of the document
documents.s3_url:
string
Url of the document
documents.signable:
booleanfalse
True if signature should be activated on document (PDF)
If you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers: https://tilkee.readme.io/docs/standard-workflow#7-misc Parameter :name or :id is required, both can do too. If you only set :id, the new project will have the same name as the original one. The key 'person' either contains the object 'person' or an array of 'person' objects

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



If you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers: https://tilkee.readme.io/docs/standard-workflow#7-misc Parameter :name or :id is required, both can do too. If you only set :id, the new project will have the same name as the original one. The key 'person' either contains the object 'person' or an array of 'person' objects
{"__v":0,"_id":"561b72eec89cc30d00821589","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"You can consult statistics of a project:\n\n- directly from API requests\n- from a webhook request\n- in an HTML iframe\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"1. By the code (API)\"\n}\n[/block]\nTo read your project stats in code, use this request:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$ curl https://api.tilkee.com/<ID PROJECT>/connexions\\n-X GET \\\\\\n-H 'Accept: application/json' \\\\\\n-H 'Authorization:Bearer dsbsdfdfsohghf326fdfv6sdf6gffg6dfg8dfg' \\n-d '{\\\"tokens\\\": \\\"113289,112982\\\", \\\"start_date\\\":\\\"2015-01-01\\\", \\\"end_date\\\":\\\"2015-12-31\\\",}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"2. Webhooks\"\n}\n[/block]\nYou may create weebhook to receive notifications (JSON) directly in your application on these events: ConnexionStart/ConnexionEnd/Signature/Token/ArchiveProject\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"3. By HTML iframe\"\n}\n[/block]\nYou have 2 possibilities to access Tilkee’s Iframe:\n\n- Your user is already connected to Tilkee’s application (your token is stored in your cookies):\nhttps://app2.tilkee.com/fr/#/project/<ID PROJECT>/stats\n\n- Your user is not connected:\nhttps://app2.tilkee.com/fr/#/login/oauth?token=<YOUR TOKEN>&redirect_to=%2Fproject%2F<ID PROJECT>%2Fstats","category":"561b70f903bce90d00c4bd57","createdAt":"2015-10-12T08:44:30.025Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"check-your-stats","sync_unique":"","title":"Check your stats","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

Check your stats


You can consult statistics of a project: - directly from API requests - from a webhook request - in an HTML iframe [block:api-header] { "type": "basic", "title": "1. By the code (API)" } [/block] To read your project stats in code, use this request: [block:code] { "codes": [ { "code": "$ curl https://api.tilkee.com/<ID PROJECT>/connexions\n-X GET \\\n-H 'Accept: application/json' \\\n-H 'Authorization:Bearer dsbsdfdfsohghf326fdfv6sdf6gffg6dfg8dfg' \n-d '{\"tokens\": \"113289,112982\", \"start_date\":\"2015-01-01\", \"end_date\":\"2015-12-31\",}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "2. Webhooks" } [/block] You may create weebhook to receive notifications (JSON) directly in your application on these events: ConnexionStart/ConnexionEnd/Signature/Token/ArchiveProject [block:api-header] { "type": "basic", "title": "3. By HTML iframe" } [/block] You have 2 possibilities to access Tilkee’s Iframe: - Your user is already connected to Tilkee’s application (your token is stored in your cookies): https://app2.tilkee.com/fr/#/project/<ID PROJECT>/stats - Your user is not connected: https://app2.tilkee.com/fr/#/login/oauth?token=<YOUR TOKEN>&redirect_to=%2Fproject%2F<ID PROJECT>%2Fstats
You can consult statistics of a project: - directly from API requests - from a webhook request - in an HTML iframe [block:api-header] { "type": "basic", "title": "1. By the code (API)" } [/block] To read your project stats in code, use this request: [block:code] { "codes": [ { "code": "$ curl https://api.tilkee.com/<ID PROJECT>/connexions\n-X GET \\\n-H 'Accept: application/json' \\\n-H 'Authorization:Bearer dsbsdfdfsohghf326fdfv6sdf6gffg6dfg8dfg' \n-d '{\"tokens\": \"113289,112982\", \"start_date\":\"2015-01-01\", \"end_date\":\"2015-12-31\",}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "2. Webhooks" } [/block] You may create weebhook to receive notifications (JSON) directly in your application on these events: ConnexionStart/ConnexionEnd/Signature/Token/ArchiveProject [block:api-header] { "type": "basic", "title": "3. By HTML iframe" } [/block] You have 2 possibilities to access Tilkee’s Iframe: - Your user is already connected to Tilkee’s application (your token is stored in your cookies): https://app2.tilkee.com/fr/#/project/<ID PROJECT>/stats - Your user is not connected: https://app2.tilkee.com/fr/#/login/oauth?token=<YOUR TOKEN>&redirect_to=%2Fproject%2F<ID PROJECT>%2Fstats
{"__v":0,"_id":"561b7316f619210d00a85c39","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{ \"won\":\"won\"\n}","name":""}]},"params":[{"_id":"560e584dcac9dc0d007af7e4","required":false,"desc":"To specify id a project is won or not, values accepted are « won », « lost » and « ac »","default":"","type":"string","name":"won","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 37974,\n  \"name\": \"TEST CREA SIMPLIFIEE\",\n  \"created_at\": \"2015-11-18T17:19:33.552+01:00\",\n  \"updated_at\": \"2015-11-19T09:59:43.008+01:00\",\n  \"archived_at\": \"2015-11-19T09:59:42.829+01:00\",\n  \"status\": \"won\",\n  \"won\": \"won\",\n  \"is_template\": false,\n  \"can_be_downloaded\": true,\n  \"preview\": \"https://api-beta2.tilkee.com/projects/37974/preview?signature=a6BSJv%2BeLIf3k5oJqc826j%2BDqcX2tPzlTLXk1kADobY%3D%0A\",\n  \"is_or_was_signable\": false,\n  \"last_sign_in_at\": \"2015-11-18T17:20:10.565+01:00\",\n  \"signed\": false,\n  \"collaborators_count\": null,\n  \"theme\": {\n    \"id\": 4402,\n    \"name\": \"Theme #1\",\n    \"logo\": null,\n    \"main_color\": \"#4fada3\",\n    \"secondary_color\": \"#479c93\",\n    \"text_color\": \"#FFFFFF\",\n    \"default\": true\n  }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/archive"},"body":"Note: If you want to restore your project use https://api.tilkee.com/projects/:project_id/restore","category":"561b70f903bce90d00c4bd57","createdAt":"2015-10-12T08:45:10.980Z","editedParams":true,"editedParams2":true,"excerpt":"Use this method to archive a project, you can use the won parameter to archive won, lost or undefined","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"archive-2","sync_unique":"","title":"Archive a project","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postArchive a project

Use this method to archive a project, you can use the won parameter to archive won, lost or undefined

Body JSON

won:
string
To specify id a project is won or not, values accepted are « won », « lost » and « ac »
Note: If you want to restore your project use https://api.tilkee.com/projects/:project_id/restore

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Note: If you want to restore your project use https://api.tilkee.com/projects/:project_id/restore
{"__v":0,"_id":"5639da8ec63a22190018dbd3","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"A project is made of all documents you address to a contact.\nIn a project, you can add as many documents as you wish, and in different formats. \nYou can insert: Photos (jpg, jpeg, png), Videos (.mov, .mp4), PDF, Word, External links (Youtube, Vimeo, Dailymotion, Websites, etc).","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-11-04T10:14:38.426Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"what-is-it-1","sync_unique":"","title":"What is it ?","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

What is it ?


A project is made of all documents you address to a contact. In a project, you can add as many documents as you wish, and in different formats. You can insert: Photos (jpg, jpeg, png), Videos (.mov, .mp4), PDF, Word, External links (Youtube, Vimeo, Dailymotion, Websites, etc).
A project is made of all documents you address to a contact. In a project, you can add as many documents as you wish, and in different formats. You can insert: Photos (jpg, jpeg, png), Videos (.mov, .mp4), PDF, Word, External links (Youtube, Vimeo, Dailymotion, Websites, etc).
{"__v":3,"_id":"560e5025cac9dc0d007af7d6","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n  \"name\": \"My first project\",\n  \"archived_at \": null,\n  \"can_be_downloaded\": true,\n  \"external_id\": \"PIPEDRIVE_DEAL:21654\",\n  \"duration\": 30\n  }","name":""}]},"params":[{"_id":"560e5025cac9dc0d007af7d8","ref":"","required":true,"desc":"Name of the project (any alphanumeric info)","default":"","type":"string","name":"name","in":"body"},{"_id":"560e559259cb8d0d0015cccc","ref":"","required":false,"desc":"Date to choose when a project is archived (only if company has right « end_date_option »)","default":"","type":"yyyy-mm-dd","name":"archived_at","in":"body"},{"_id":"560e559259cb8d0d0015cccb","ref":"","required":false,"desc":"To choose if visitor can download all of the project (only if company have right « download_option »)","default":"","type":"boolean","name":"can_be_downloaded","in":"body"},{"_id":"56a114918b2e6f0d0018e975","ref":"","required":false,"desc":"ID of the project in your system","default":"","type":"string","name":"external_id","in":"body"},{"_id":"57178cfe4b807b0e0040f019","ref":"","required":false,"desc":"Used only for templates, you can create projects from this template that will expire <duration> days later.","default":"","type":"int","name":"duration","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 37980,\n  \"name\": \"My first project\",\n  \"created_at\": \"2015-11-19T10:02:05.322+01:00\",\n  \"updated_at\": \"2015-11-19T10:02:05.322+01:00\",\n  \"archived_at\": null,\n  \"status\": \"activated\",\n  \"won\": \"na\",\n  \"is_template\": false,\n  \"can_be_downloaded\": true,\n  \"preview\": \"https://api-beta2.tilkee.com/projects/37980/preview?signature=Vgr7G1fDo0WaquJOAL69rQuFSO6Aw6QmyxLOmqfvenY%3D%0A\",\n  \"duration\": 30,\n  \"is_or_was_signable\": false,\n  \"last_sign_in_at\": null,\n  \"signed\": false,\n  \"nb_connections\": 0,\n  \"total_time\": 0,\n  \"leader\": {\n    \"id\": 4658,\n    \"first_name\": null,\n    \"last_name\": null,\n    \"full_name\": \"paul+test@tilkee.com\",\n    \"email\": \"paul+test@tilkee.com\",\n    \"cell_phone_number\": null,\n    \"phone_number\": null,\n    \"contact_email\": \"paul+test@tilkee.com\",\n    \"should_receive_emails\": true,\n    \"level_id\": 1,\n    \"devices\": [],\n    \"is_owner\": true,\n    \"is_orange_user\": false,\n    \"locale\": \"en\",\n    \"should_receive_connexion_email\": true,\n    \"frequency_proposal_sumup_email\": 7,\n    \"position\": null,\n    \"avatar\": null,\n    \"linkedin_account_url\": \"\",\n    \"twitter_account_url\": \"\",\n    \"facebook_account_url\": \"\",\n    \"last_sign_in_at\": 1447923437\n  },\n  \"collaborators\": [],\n  \"collaborators_count\": null,\n  \"theme\": {\n    \"id\": 4402,\n    \"name\": \"Theme #1\",\n    \"logo\": null,\n    \"main_color\": \"#4fada3\",\n    \"secondary_color\": \"#479c93\",\n    \"text_color\": \"#FFFFFF\",\n    \"default\": true\n  },\n  \"tokens\": [\n    {\n      \"id\": 144261,\n      \"name\": \"My first project\",\n      \"project_name\": \"My first project\",\n      \"link\": \"https://api-beta2.tilkee.com/v/3822dc17b5\",\n      \"won\": null,\n      \"created_at\": \"2015-11-19T10:02:05.967+01:00\",\n      \"consulted\": false,\n      \"signed_status\": \"no_init\",\n      \"archived_at\": null,\n      \"signed\": false,\n      \"signed_docs\": [],\n      \"interest\": null\n    }\n  ],\n  \"external_id\": \"PIPEDRIVE_DEAL:21654\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects"},"body":"Note: If the connection token is invalid, the sent error will be « 401 Unauthorized ». Accents in the project’s name are allowed.\n\nIf you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers: https://tilkee.readme.io/docs/standard-workflow#7-misc","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-02T09:36:37.878Z","editedParams":true,"editedParams2":true,"excerpt":"Creating a project in this way you need to add everything; name, items, properties, etc.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"projects","sync_unique":"","title":"Create","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postCreate

Creating a project in this way you need to add everything; name, items, properties, etc.

Body JSON

name:
required
string
Name of the project (any alphanumeric info)
archived_at:
yyyy-mm-dd
Date to choose when a project is archived (only if company has right « end_date_option »)
can_be_downloaded:
boolean
To choose if visitor can download all of the project (only if company have right « download_option »)
external_id:
string
ID of the project in your system
duration:
integer
Used only for templates, you can create projects from this template that will expire <duration> days later.
Note: If the connection token is invalid, the sent error will be « 401 Unauthorized ». Accents in the project’s name are allowed. If you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers: https://tilkee.readme.io/docs/standard-workflow#7-misc

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Note: If the connection token is invalid, the sent error will be « 401 Unauthorized ». Accents in the project’s name are allowed. If you are using a company global API key, you may need to indicate which user is actually connected. In this case, just add any of these http headers: https://tilkee.readme.io/docs/standard-workflow#7-misc
{"__v":3,"_id":"56168744a6767c0d00166a2a","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"56168744a6767c0d00166a30","required":false,"desc":"Name","default":"","type":"string","name":"search","in":"query"},{"_id":"56168744a6767c0d00166a2f","required":false,"desc":"","default":"","type":"int","name":"limit","in":"query"},{"_id":"56168744a6767c0d00166a2e","required":false,"desc":"","default":"","type":"int","name":"offset","in":"query"},{"_id":"56168744a6767c0d00166a2d","required":false,"desc":"","default":"","type":"string","name":"order","in":"query"},{"_id":"56168744a6767c0d00166a2c","required":false,"desc":"","default":"","type":"string","name":"status","in":"query"},{"_id":"56168744a6767c0d00166a2b","required":false,"desc":"To see projects to specific user. Management need to be active in company.","default":"","type":"int","name":"user_id","in":"query"},{"_id":"561fc6e45624f5190004ca36","required":false,"desc":"","default":"","type":"boolean","name":"is_template","in":"query"},{"_id":"56815d0725ea3717002a02d3","required":false,"desc":"","default":"","type":"string","name":"name","in":"query"},{"_id":"56815d0725ea3717002a02d2","required":false,"desc":"","default":"","type":"boolean","name":"won","in":"query"},{"_id":"56815d0725ea3717002a02d1","required":false,"desc":"","default":"","type":"boolean","name":"can_be_downloaded","in":"query"},{"_id":"56815d0725ea3717002a02d0","required":false,"desc":"","default":"","type":"boolean","name":"is_or_was_signable","in":"query"},{"_id":"56815d0725ea3717002a02cf","required":false,"desc":"","default":"","type":"boolean","name":"signed","in":"query"},{"_id":"56815d0725ea3717002a02ce","required":false,"desc":"","default":"","type":"boolean","name":"starred","in":"query"},{"_id":"56815d0725ea3717002a02cd","required":false,"desc":"","default":"","type":"int","name":"nb_connections","in":"query"},{"_id":"56815d0725ea3717002a02cc","required":false,"desc":"","default":"","type":"int","name":"leader_id","in":"query"},{"_id":"56a114f4aca0730d003e34f7","required":false,"desc":"","default":"","type":"string","name":"external_id","in":"query"}],"results":{"codes":[{"name":"","code":"{\n  \"search\": null,\n  \"limit\": 50,\n  \"offset\": 0,\n  \"total\": 2,\n  \"order\": \"-projects.created_at\",\n  \"contents\": [\n    {\n      \"id\": 37980,\n      \"name\": \"My first project\",\n      \"created_at\": \"2015-11-19T10:02:05.322+01:00\",\n      \"updated_at\": \"2015-11-19T10:02:05.322+01:00\",\n      \"archived_at\": null,\n      \"status\": \"activated\",\n      \"won\": \"na\",\n      \"is_template\": false,\n      \"can_be_downloaded\": true,\n      \"preview\": \"https://api-beta2.tilkee.com/projects/37980/preview?signature=Vgr7G1fDo0WaquJOAL69rQuFSO6Aw6QmyxLOmqfvenY%3D%0A\",\n      \"is_or_was_signable\": false,\n      \"last_sign_in_at\": null,\n      \"signed\": false,\n      \"nb_connections\": 0,\n      \"total_time\": 0,\n      \"leader_first_name\": null,\n      \"leader_last_name\": null,\n      \"leader_id\": 4658,\n      \"collaborators_count\": 0,\n      \"external_id\": null\n    },\n    {\n      \"id\": 37878,\n      \"name\": \"Titre du projet\",\n      \"created_at\": \"2015-11-18T10:04:28.691+01:00\",\n      \"updated_at\": \"2015-11-18T10:10:15.524+01:00\",\n      \"archived_at\": null,\n      \"status\": \"activated\",\n      \"won\": \"na\",\n      \"is_template\": false,\n      \"can_be_downloaded\": true,\n      \"preview\": \"https://api-beta2.tilkee.com/projects/37878/preview?signature=WV4LCPEsiMEiQhcYrmmRmXBuMfuQOsJRCfTkrG2XFGs%3D%0A\",\n      \"is_or_was_signable\": false,\n      \"last_sign_in_at\": \"2015-11-18T10:12:44.212+01:00\",\n      \"signed\": false,\n      \"nb_connections\": 2,\n      \"total_time\": 41148,\n      \"leader_first_name\": null,\n      \"leader_last_name\": null,\n      \"leader_id\": 4658,\n      \"collaborators_count\": 0,\n      \"external_id\": null\n    }\n  ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"560e512539fad419002ae15d","url":"/projects"},"body":"","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-08T15:09:56.784Z","editedParams":true,"editedParams2":true,"excerpt":"Used to get a list of all your projects","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"list-2","sync_unique":"","title":"List","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getList

Used to get a list of all your projects

Query Params

search:
string
Name
limit:
integer
offset:
integer
order:
string
status:
string
user_id:
integer
To see projects to specific user. Management need to be active in company.
is_template:
boolean
name:
string
won:
boolean
can_be_downloaded:
boolean
is_or_was_signable:
boolean
signed:
boolean
starred:
boolean
nb_connections:
integer
leader_id:
integer
external_id:
string

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"5630f3adeae7ef0d00270df7","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"56742bbdf79ca90d00ad2fc6","required":false,"desc":"« activated » or « archived »","default":"","type":"string","name":"status","in":"query"},{"_id":"56742bbdf79ca90d00ad2fc5","required":false,"desc":"","default":"","type":"boolean","name":"is_template","in":"query"},{"_id":"56742bbdf79ca90d00ad2fc4","required":false,"desc":"","default":"","type":"int","name":"owner_id","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"id\": 77585,\n    \"position\": 1,\n    \"type\": \"ProjectItem\",\n\t  \"title\": \"title\",\n    \"signable\": null,\n    \"item\": {\n      \"id\": 44534,\n\t\t\"title\": \"filename\",\n      \"element_type\": \"image\",\n      \"extension\": \"jpg\",\n      \"type\": \"Image:jpg\",\n      \"content_url\": \"https://datatlk.tilkee.com/uploads/...\",\n      \"thumbnail_url\": \"https://datatlk.tilkee.com/uploads/...\",\n      \"visible\": false,\n      \"created_at\": \"2015-06-01T15:42:20.194+02:00\"\n    }\n  },\n  {\n    \"id\": 77581,\n    \"position\": 2,\n    \"type\": \"ProjectItem\",\n\t  \"title\": \"title2\",\n    \"signable\": null,\n    \"item\": {\n      \"id\": 39337,\n\t\t\"title\": \"filename 2\",\n      \"element_type\": \"doc\",\n      \"extension\": \"pdf\",\n      \"type\": \"Doc:pdf\",\n      \"content_url\": \"\",\n      \"thumbnail_url\": \"https://datatlk.tilkee.com/front/illustration/thumbnails/doc.jpg\",\n      \"visible\": false,\n      \"created_at\": \"2015-04-01T10:12:26.779+02:00\"\n    }\n  }\n]\n","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/items"},"body":"","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-28T16:11:25.585Z","editedParams":true,"editedParams2":true,"excerpt":"Use that section to consult all items in a project","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"list-of-items-in-a-project-1","sync_unique":"","title":"List of items in a project","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getList of items in a project

Use that section to consult all items in a project

Query Params

status:
string
« activated » or « archived »
is_template:
boolean
owner_id:
integer

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":4,"_id":"561687acc8c5e70d00a8a173","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 37980,\n  \"name\": \"My first project\",\n  \"created_at\": \"2015-11-19T10:02:05.322+01:00\",\n  \"updated_at\": \"2015-11-19T10:02:05.322+01:00\",\n  \"archived_at\": null,\n  \"status\": \"activated\",\n  \"won\": \"na\",\n  \"is_template\": false,\n  \"can_be_downloaded\": true,\n  \"preview\": \"https://api-beta2.tilkee.com/projects/37980/preview?signature=Vgr7G1fDo0WaquJOAL69rQuFSO6Aw6QmyxLOmqfvenY%3D%0A\",\n  \"is_or_was_signable\": false,\n  \"last_sign_in_at\": null,\n  \"signed\": false,\n  \"nb_connections\": 0,\n  \"total_time\": 0,\n  \"leader\": {\n    \"id\": 4658,\n    \"first_name\": null,\n    \"last_name\": null,\n    \"full_name\": \"paul+test@tilkee.com\",\n    \"email\": \"paul+test@tilkee.com\",\n    \"cell_phone_number\": null,\n    \"phone_number\": null,\n    \"contact_email\": \"paul+test@tilkee.com\",\n    \"should_receive_emails\": true,\n    \"level_id\": 1,\n    \"devices\": [],\n    \"is_owner\": true,\n    \"is_orange_user\": false,\n    \"locale\": \"en\",\n    \"should_receive_connexion_email\": true,\n    \"frequency_proposal_sumup_email\": 7,\n    \"position\": null,\n    \"avatar\": null,\n    \"linkedin_account_url\": \"\",\n    \"twitter_account_url\": \"\",\n    \"facebook_account_url\": \"\",\n    \"last_sign_in_at\": 1447923965\n  },\n  \"collaborators\": [],\n  \"collaborators_count\": null,\n  \"theme\": {\n    \"id\": 4402,\n    \"name\": \"Theme #1\",\n    \"logo\": null,\n    \"main_color\": \"#4fada3\",\n    \"secondary_color\": \"#479c93\",\n    \"text_color\": \"#FFFFFF\",\n    \"default\": true\n  },\n  \"external_id\": \"PIPEDRIVE_DEAL:21654\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id"},"body":"","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-08T15:11:40.216Z","excerpt":"Used to get all details of a specific project","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"get-details-of-a-project","sync_unique":"","title":"Get (details of a project)","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getGet (details of a project)

Used to get all details of a specific project


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":3,"_id":"560e561139fad419002ae15f","api":{"auth":"required","examples":{"codes":[{"language":"text","code":"{}","name":""}]},"params":[{"_id":"563c8a76d8f2d20d00448c0f","default":"","desc":"Name of the project (any alphanumeric info)","in":"body","name":"name","ref":"","required":false,"type":"string"},{"_id":"563c8a76d8f2d20d00448c0e","default":"","desc":"To choose if visitor can download all of the project (only if company have right « download_option »)","in":"body","name":"can_be_downloaded","ref":"","required":false,"type":"boolean"},{"_id":"563c8a76d8f2d20d00448c0d","default":"","desc":"Date to choose when a project is archived (only if company has right « end_date_option »)","in":"body","name":"archived_at","ref":"","required":false,"type":"yyyy-mm-dd"},{"_id":"563c8a76d8f2d20d00448c0c","default":"","desc":"To choose if project assignments should be kept","in":"body","name":"should_duplicate_assignments","ref":"","required":false,"type":"boolean"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 37984,\n  \"name\": \"Copie de My first project\",\n  \"created_at\": \"2015-11-19T10:18:19.692+01:00\",\n  \"updated_at\": \"2015-11-19T10:18:19.692+01:00\",\n  \"archived_at\": null,\n  \"status\": \"activated\",\n  \"won\": \"na\",\n  \"is_template\": false,\n  \"can_be_downloaded\": true,\n  \"preview\": \"https://api-beta2.tilkee.com/projects/37984/preview?signature=Tj5mrG7AbJonsI3X9KX7aG2HBzV1HYlMAuHOXQMi3qc%3D%0A\",\n  \"is_or_was_signable\": false,\n  \"last_sign_in_at\": null,\n  \"signed\": false,\n  \"collaborators_count\": null,\n  \"external_id\": null,\n  \"theme\": {\n    \"id\": 4402,\n    \"name\": \"Theme #1\",\n    \"logo\": null,\n    \"main_color\": \"#4fada3\",\n    \"secondary_color\": \"#479c93\",\n    \"text_color\": \"#FFFFFF\",\n    \"default\": true\n  }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/duplicate"},"body":"","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-02T10:01:53.677Z","editedParams":true,"editedParams2":true,"excerpt":"In this section you can create a project using an existing one (copying it). Every part of the new project will be the same except the tilks.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"from-an-existing-project","sync_unique":"","title":"Duplicate","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postDuplicate

In this section you can create a project using an existing one (copying it). Every part of the new project will be the same except the tilks.

Body JSON

name:
string
Name of the project (any alphanumeric info)
can_be_downloaded:
boolean
To choose if visitor can download all of the project (only if company have right « download_option »)
archived_at:
yyyy-mm-dd
Date to choose when a project is archived (only if company has right « end_date_option »)
should_duplicate_assignments:
boolean
To choose if project assignments should be kept

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":2,"_id":"560e571159cb8d0d0015ccce","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n  \"name\": \"My first project updated\",\n\"external_id\": \"PIPEDRIVE_DEAL:21654\",\n  \"duration\": 30\n}","name":""}]},"params":[{"_id":"560e571159cb8d0d0015ccd1","ref":"","required":true,"desc":"","default":"","type":"string","name":"name (required)","in":"body"},{"_id":"560e571159cb8d0d0015ccd0","ref":"","required":false,"desc":"date to choose when a project is archived (only if company has right « end_date_option »)","default":"","type":"yyyy-mm-dd","name":"archived_at (optional)","in":"body"},{"_id":"560e571159cb8d0d0015cccf","ref":"","required":false,"desc":"to choose if visitor can download all of the project (only if company have right « download_option »)","default":"","type":"boolean","name":"can_be_downloaded (optional)","in":"body"},{"_id":"56a114d5470ae00d00c305b9","ref":"","required":false,"desc":"ID of the project in your system","default":"","type":"string","name":"external_id","in":"body"},{"_id":"57178da79610f71900a3d313","ref":"","required":false,"desc":"Used only for templates, you can create projects from this template that will expire <duration> days later.","default":"","type":"int","name":"duration","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 37980,\n  \"name\": \"My first project updated\",\n  \"created_at\": \"2015-11-19T10:02:05.322+01:00\",\n  \"updated_at\": \"2015-11-19T10:19:14.361+01:00\",\n  \"archived_at\": null,\n  \"status\": \"activated\",\n  \"won\": \"na\",\n  \"is_template\": false,\n  \"can_be_downloaded\": true,\n  \"preview\": \"https://api-beta2.tilkee.com/projects/37980/preview?signature=Vgr7G1fDo0WaquJOAL69rQuFSO6Aw6QmyxLOmqfvenY%3D%0A\",\n  \"duration\": 30,\n  \"is_or_was_signable\": false,\n  \"last_sign_in_at\": null,\n  \"signed\": false,\n  \"nb_connections\": 0,\n  \"total_time\": 0,\n  \"leader\": {\n    \"id\": 4658,\n    \"first_name\": null,\n    \"last_name\": null,\n    \"full_name\": \"paul+test@tilkee.com\",\n    \"email\": \"paul+test@tilkee.com\",\n    \"cell_phone_number\": null,\n    \"phone_number\": null,\n    \"contact_email\": \"paul+test@tilkee.com\",\n    \"should_receive_emails\": true,\n    \"level_id\": 1,\n    \"devices\": [],\n    \"is_owner\": true,\n    \"is_orange_user\": false,\n    \"locale\": \"en\",\n    \"should_receive_connexion_email\": true,\n    \"frequency_proposal_sumup_email\": 7,\n    \"position\": null,\n    \"avatar\": null,\n    \"linkedin_account_url\": \"\",\n    \"twitter_account_url\": \"\",\n    \"facebook_account_url\": \"\",\n    \"last_sign_in_at\": 1447924730\n  },\n  \"collaborators\": [],\n  \"collaborators_count\": null,\n  \"theme\": {\n    \"id\": 4402,\n    \"name\": \"Theme #1\",\n    \"logo\": null,\n    \"main_color\": \"#4fada3\",\n    \"secondary_color\": \"#479c93\",\n    \"text_color\": \"#FFFFFF\",\n    \"default\": true\n  },\n  \"external_id\": \"PIPEDRIVE_DEAL:21654\"","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id"},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-02T10:06:09.136Z","editedParams":true,"editedParams2":true,"excerpt":"This method can change a Tilkee project, in the following cases:\n\n    --> Say that a project is won\n    --> Archive a project\n    --> Change its name\n    --> Modify options like downloadable","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"testinput-1","sync_unique":"","title":"Update","type":"put","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

putUpdate

This method can change a Tilkee project, in the following cases: --> Say that a project is won --> Archive a project --> Change its name --> Modify options like downloadable

Body JSON

name:
required
string
archived_at:
yyyy-mm-dd
date to choose when a project is archived (only if company has right « end_date_option »)
can_be_downloaded:
boolean
to choose if visitor can download all of the project (only if company have right « download_option »)
external_id:
string
ID of the project in your system
duration:
integer
Used only for templates, you can create projects from this template that will expire <duration> days later.
Lorem ipsum dolor sit amet, consectetur adipiscing elit.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit.
{"__v":2,"_id":"56168ba121e9110d0078037a","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"5625195572ac510d00e49202","default":"","desc":"","in":"body","name":"project_items_ids","ref":"","required":false,"type":"array_int"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"zones\": [\n    {\n      \"name\": \"New section\",\n      \"items\": [\n        {\n          \"id\": 245845,\n          \"title\": \"Présentation de mon produit\",\n          \"signable\": null,\n          \"item\": {\n            \"id\": 57799,\n            \"title\": \"Présentation de mon produit\",\n            \"element_type\": \"doc\",\n            \"extension\": \"pdf\",\n            \"type\": \"Doc:pdf\",\n            \"content_url\": \"//api.tilkee.com/docs/33617/crocodoc_player/?signature=tnrq6djVq8q33Xo0QZM9MplED04bSXKia2%2FjW0TCF38%3D%0A\",\n            \"thumbnail_url\": \"https://datatlk.tilkee.com/front/illustration/thumbnails/doc.jpg\",\n            \"visible\": false,\n            \"created_at\": \"2015-09-28T10:45:42.981+02:00\"\n          }\n        }\n      ]\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/remove_items"},"body":"Note: The response is the list of items in your project","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-08T15:28:33.648Z","editedParams":true,"editedParams2":true,"excerpt":"Use this command to remove items from a project by ids","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"remove-items","sync_unique":"","title":"Remove items","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postRemove items

Use this command to remove items from a project by ids

Body JSON

project_items_ids:
array of integers
Note: The response is the list of items in your project

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Note: The response is the list of items in your project
{"__v":0,"_id":"560e584dcac9dc0d007af7e3","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{ \"won\":\"won\"\n}","name":""}]},"params":[{"_id":"560e584dcac9dc0d007af7e4","default":"","desc":"To specify id a project is won or not, values accepted are « won », « lost » and « ac »","name":"won","required":false,"type":"string","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 37974,\n  \"name\": \"TEST CREA SIMPLIFIEE\",\n  \"created_at\": \"2015-11-18T17:19:33.552+01:00\",\n  \"updated_at\": \"2015-11-19T09:59:43.008+01:00\",\n  \"archived_at\": \"2015-11-19T09:59:42.829+01:00\",\n  \"status\": \"won\",\n  \"won\": \"won\",\n  \"is_template\": false,\n  \"can_be_downloaded\": true,\n  \"preview\": \"https://api-beta2.tilkee.com/projects/37974/preview?signature=a6BSJv%2BeLIf3k5oJqc826j%2BDqcX2tPzlTLXk1kADobY%3D%0A\",\n  \"is_or_was_signable\": false,\n  \"last_sign_in_at\": \"2015-11-18T17:20:10.565+01:00\",\n  \"signed\": false,\n  \"collaborators_count\": null,\n  \"external_id\": null,\n  \"theme\": {\n    \"id\": 4402,\n    \"name\": \"Theme #1\",\n    \"logo\": null,\n    \"main_color\": \"#4fada3\",\n    \"secondary_color\": \"#479c93\",\n    \"text_color\": \"#FFFFFF\",\n    \"default\": true\n  }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/archive"},"body":"Note: If you want to restore your project use https://api.tilkee.com/projects/<ID PROJECT>/restore","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-02T10:11:25.615Z","editedParams":true,"editedParams2":true,"excerpt":"Use this method to archive a project, you can use the won parameter to archive won, lost or undefined","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"archive","sync_unique":"","title":"Archive","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postArchive

Use this method to archive a project, you can use the won parameter to archive won, lost or undefined

Body JSON

won:
string
To specify id a project is won or not, values accepted are « won », « lost » and « ac »
Note: If you want to restore your project use https://api.tilkee.com/projects/<ID PROJECT>/restore

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Note: If you want to restore your project use https://api.tilkee.com/projects/<ID PROJECT>/restore
{"__v":0,"_id":"561bdb8aab412a0d004d86a9","api":{"auth":"required","examples":{"codes":[{"language":"text","code":"https://api.tilkee.com/projects/batch?projects_id=4242,4243&won=won"}]},"params":[{"_id":"561bdb8aab412a0d004d86ab","default":"","desc":"","name":"projects_id","ref":"","required":false,"type":"array_int","in":"path"},{"_id":"561bdb8aab412a0d004d86aa","default":"","desc":"won, lost or na","name":"won","ref":"","required":false,"type":"string","in":"path"}],"results":{"codes":[{"name":"","code":"[{\n    \"id\": 10493,\n    \"name\": \"demo2\",\n    \"status\": null,\n    \"potential\": 60,\n    \"download\": true,\n    \"is_template\": false,\n    \"end_date\": \"2014-12-19T10:30:05+01:00\",\n    \"external_id\": null,\n    \"leader\": {\n        \"id\": 1785,\n        \"first_name\": \"Joseph\",\n        \"last_name\": \"BLANC\",\n        \"cell_phone_number\": \"+3362...\",\n        \"phone_number\": \"\",\n        \"email\": \"example@gmail.com\",\n        \"last_connection\": 1418891213\n    },\n    \"collaborators\": [],\n    \"theme\": {\n        \"id\": 161,\n        \"name\": \"Theme #1\",\n        \"logo_url\": \"\",\n        \"primary_color\": \"#6fad4e\",\n        \"secondary_color\": \"#4444db\",\n        \"text_color\": \"#d6b549\"\n    }\n},{\n    \"id\": 10495,\n    \"name\": \"demo3\",\n    \"status\": null,\n    \"potential\": 60,\n    \"download\": true,\n    \"is_template\": false,\n    \"end_date\": \"2014-14-19T10:30:05+01:00\",\n    \"external_id\": null,\n    \"leader\": {\n        \"id\": 1785,\n        \"first_name\": \"Joseph\",\n        \"last_name\": \"BLANC\",\n        \"cell_phone_number\": \"+3362...\",\n        \"phone_number\": \"\",\n        \"email\": \"example@gmail.com\",\n        \"last_connection\": 1418891213\n    },\n    \"collaborators\": [],\n    \"theme\": {\n        \"id\": 161,\n        \"name\": \"Theme #1\",\n        \"logo_url\": \"\",\n        \"primary_color\": \"#6fad4e\",\n        \"secondary_color\": \"#4444db\",\n        \"text_color\": \"#d6b549\"\n    }\n}\n\n]","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/projects/batch?:projects_id=<project_id1><project_id2>&:won=<status>"},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-12T16:10:50.684Z","editedParams":true,"editedParams2":true,"excerpt":"Used to archive a batch of project. You need the ids of these projects","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":9,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"testinput","sync_unique":"","title":"Archive an array of project by ids","type":"put","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

putArchive an array of project by ids

Used to archive a batch of project. You need the ids of these projects

Path Params

projects_id:
array of integers
won:
string
won, lost or na
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"__v":4,"_id":"561689e1cf2a1e0d002478ff","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 37981,\n  \"name\": \"Copie de My first project\",\n  \"created_at\": \"2015-11-19T10:13:53.987+01:00\",\n  \"updated_at\": \"2015-11-19T10:21:21.597+01:00\",\n  \"archived_at\": null,\n  \"status\": \"activated\",\n  \"won\": \"na\",\n  \"is_template\": false,\n  \"can_be_downloaded\": true,\n  \"preview\": \"https://api-beta2.tilkee.com/projects/37981/preview?signature=GAzk0qpZuMN%2BxpyikAZjwSuWZd8QxRqAW4gSYFQwd10%3D%0A\",\n  \"is_or_was_signable\": false,\n  \"last_sign_in_at\": null,\n  \"signed\": false,\n  \"collaborators_count\": null,\n  \"external_id\": null,\n  \"theme\": {\n    \"id\": 4402,\n    \"name\": \"Theme #1\",\n    \"logo\": null,\n    \"main_color\": \"#4fada3\",\n    \"secondary_color\": \"#479c93\",\n    \"text_color\": \"#FFFFFF\",\n    \"default\": true\n  }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/restore"},"body":"","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-08T15:21:05.567Z","excerpt":"Use this command to restore an archived project. Id is needed","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":10,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"restore","sync_unique":"","title":"Restore","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postRestore

Use this command to restore an archived project. Id is needed


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"56168819c8c5e70d00a8a175","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"null","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id"},"body":"","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-08T15:13:29.032Z","excerpt":"Permanently deletes a specific project","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":11,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"delete-4","sync_unique":"","title":"Delete","type":"delete","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

deleteDelete

Permanently deletes a specific project


User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"5624fd465a86b42300946314","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"null","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/batch?project_id=:id1,:id2"},"body":"","category":"560e5350cac9dc0d007af7dc","createdAt":"2015-10-19T14:25:10.401Z","excerpt":"Permanently deletes a batch of projects","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":12,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"batch-delete-1","sync_unique":"","title":"Batch delete","type":"delete","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

deleteBatch delete

Permanently deletes a batch of projects


User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"56e19133a71e9e200066cdf8","api":{"settings":"560e512539fad419002ae15d","results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"item_id\": \"67261\",\n    \"title\": \"ppt_court\",\n    \"position\": \"2\",\n    \"page\": \"1\",\n    \"connections\": \"6\",\n    \"time\": \"18\"\n  },\n  {\n    \"item_id\": \"67261\",\n    \"title\": \"ppt_court\",\n    \"position\": \"2\",\n    \"page\": \"2\",\n    \"connections\": \"3\",\n    \"time\": \"32\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"56e19133a71e9e200066cdf9","ref":"","required":false,"desc":"Array of item_ids (in the specific project)","default":"","type":"array_int","name":"items","in":"path"}],"url":"/projects/:project_id/export_stats?:items=<item_id1>,<item_id2>"},"body":"","category":"560e5350cac9dc0d007af7dc","createdAt":"2016-03-10T15:22:27.467Z","editedParams":true,"editedParams2":true,"excerpt":"Used to get statistics about items in a specific project in CSV.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":13,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"export-stats-csv","sync_unique":"","title":"Export stats (CSV)","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getExport stats (CSV)

Used to get statistics about items in a specific project in CSV.

Path Params

items:
array of integers
Array of item_ids (in the specific project)

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5639dac31846790d0089528a","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"A Tilk is a link generated for your lead or contact in a project. The link is tracked and gives you back statistics about your lead's behavior.","category":"561269523cf4bc0d00554e7b","createdAt":"2015-11-04T10:15:31.647Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"what-is-it-2","sync_unique":"","title":"What is it ?","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

What is it ?


A Tilk is a link generated for your lead or contact in a project. The link is tracked and gives you back statistics about your lead's behavior.
A Tilk is a link generated for your lead or contact in a project. The link is tracked and gives you back statistics about your lead's behavior.
{"__v":2,"_id":"56126ae109bdc51700696fc7","api":{"auth":"required","examples":{"codes":[{"name":"","code":"{\n  \"persons\":[\n    {\"name\":\"jean\"},\n    {\"name\":\"pierre\"},\n  \t{\"name\":\"paul\", \"external_id\": \"1234\"}\n\t]\n}","language":"json"}]},"params":[{"_id":"56126ae109bdc51700696fca","default":"","desc":"Array of name","name":"persons","ref":"","required":true,"type":"array_string","in":"body"},{"_id":"56126ae109bdc51700696fc8","default":"","desc":"contact name","name":"name","ref":"","required":true,"type":"string","in":"body"},{"_id":"56ba14c8c275570d00ce7030","default":"","desc":"ID of the contact in your system","name":"external_id","ref":"","required":false,"type":"string","in":"body"}],"results":{"codes":[{"name":"","code":"{\n \"contents\": [\n {\n \"id\": 112985,\n \"name\": \"paul\",\n \"project_name\": \"My first project updated\",\n \"link\": \"https://api.tilk.us/v/09bf23ce92\",\n \"won\": null,\n \"created_at\": \"2015-09-07T14:34:18.074+02:00\",\n \"consulted\": false,\n \"signed_status\": \"no_init\",\n \"archived_at\": null,\n \"signed\": false,\n \"signed_docs\": [],\n \"person_contact\": null,\n \"external_id\": \"my_personal_id:1234\"\n }\n ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/tokens"},"body":"","category":"561269523cf4bc0d00554e7b","createdAt":"2015-10-05T12:19:45.054Z","editedParams":true,"editedParams2":true,"excerpt":"This method creates a \"Tilk\", which is a unique link to send your project to your prospect. \nYou can create up to 200 \"Tilks\" with one call to this method.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"create","sync_unique":"","title":"Create","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postCreate

This method creates a "Tilk", which is a unique link to send your project to your prospect. You can create up to 200 "Tilks" with one call to this method.

Body JSON

persons:
required
array of strings
Array of name
name:
required
string
contact name
external_id:
string
ID of the contact in your system

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"5717881f9610f71900a3d305","api":{"settings":"560e512539fad419002ae15d","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"search\": null,\n  \"limit\": 10,\n  \"offset\": 0,\n  \"order\": null,\n  \"total\": 476,\n  \"contents\": [\n    {\n      \"id\": 123456,\n      \"name\": \"Jean DUPONT\",\n      \"project_name\": \"Projet test\",\n      \"link\": \"http://view.tilkee.com/v/6166a63c95\",\n      \"won\": null,\n      \"created_at\": \"2016-04-20T11:45:33.828+02:00\",\n      \"consulted\": false,\n      \"signed_status\": \"no_init\",\n      \"archived_at\": null,\n      \"signed\": false,\n      \"signed_docs\": [],\n      \"interest\": 0,\n      \"project_id\": 12345,\n      \"preview_url\": \"http://view.tilkee.com/projects/12345/preview?signature=xJ0zLxl0CwwfCtiAWfBEDLO13nuNVdMpc9odk1ey1coabc\",\n      \"external_id\": null,\n      \"total_time\": 0,\n      \"last_sign_in_at\": null,\n      \"nb_connections\": 0,\n      \"person_contact\": null\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"56168e4da6767c0d00166a3c","ref":"","required":false,"desc":"","default":"","type":"int","name":"limit","in":"query"},{"_id":"56168e4da6767c0d00166a3b","ref":"","required":false,"desc":"","default":"","type":"int","name":"offset","in":"query"},{"_id":"56168e4da6767c0d00166a3a","ref":"","required":false,"desc":"","default":"","type":"string","name":"order","in":"query"},{"_id":"56168e4da6767c0d00166a3d","ref":"","required":false,"desc":"","default":"","type":"boolean","name":"is_owner","in":"query"},{"_id":"56742c074b2a680d00524f1f","ref":"","required":false,"desc":"","default":"","type":"boolean","name":"archived_tokens","in":"query"},{"_id":"5681591225ea3717002a02c0","ref":"","required":false,"desc":"Not archived tokens in not archived projects","default":"","type":"boolean","name":"accessible_tokens","in":"query"},{"_id":"5681591225ea3717002a02c2","ref":"","required":false,"desc":"","default":"","type":"boolean","name":"consulted","in":"query"},{"_id":"5681591225ea3717002a02bf","ref":"","required":false,"desc":"","default":"","type":"int","name":"project_id","in":"query"},{"_id":"5681591225ea3717002a02be","ref":"","required":false,"desc":"","default":"","type":"int","name":"nb_connections","in":"query"},{"_id":"5681591225ea3717002a02bd","ref":"","required":false,"desc":"","default":"","type":"int","name":"interest","in":"query"},{"_id":"56bb0180b9b78c0d0029126a","ref":"","required":false,"desc":"","default":"","type":"string","name":"external_id","in":"query"}],"url":"/tokens"},"body":"","category":"561269523cf4bc0d00554e7b","createdAt":"2016-04-20T13:46:07.045Z","editedParams":true,"editedParams2":true,"excerpt":"This command is used to retrieve all of your tilks, this way you can filter them (by interest for instance).","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"list-of-tilks","sync_unique":"","title":"List of Tilks","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getList of Tilks

This command is used to retrieve all of your tilks, this way you can filter them (by interest for instance).

Query Params

limit:
integer
offset:
integer
order:
string
is_owner:
boolean
archived_tokens:
boolean
accessible_tokens:
boolean
Not archived tokens in not archived projects
consulted:
boolean
project_id:
integer
nb_connections:
integer
interest:
integer
external_id:
string

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":4,"_id":"56168e4da6767c0d00166a39","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"56168e4da6767c0d00166a3d","ref":"","required":false,"desc":"Title, name, email, token_url","default":"","type":"string","name":"search","in":"query"},{"_id":"56168e4da6767c0d00166a3c","ref":"","required":false,"desc":"","default":"","type":"int","name":"limit","in":"query"},{"_id":"56168e4da6767c0d00166a3b","ref":"","required":false,"desc":"","default":"","type":"int","name":"offset","in":"query"},{"_id":"56168e4da6767c0d00166a3a","ref":"","required":false,"desc":"","default":"","type":"string","name":"order","in":"query"},{"_id":"56742c074b2a680d00524f1f","ref":"","required":false,"desc":"","default":"","type":"boolean","name":"archived_tokens","in":"query"},{"_id":"5681591225ea3717002a02c3","ref":"","required":false,"desc":"[\"init\", \"waiting\", \"signed\", \"signed_complete\"]","default":"","type":"string","name":"signed_status","in":"query"},{"_id":"5681591225ea3717002a02c2","ref":"","required":false,"desc":"","default":"","type":"boolean","name":"consulted","in":"query"},{"_id":"5681591225ea3717002a02c0","ref":"","required":false,"desc":"","default":"","type":"boolean","name":"signed","in":"query"},{"_id":"5681591225ea3717002a02bf","ref":"","required":false,"desc":"","default":"","type":"int","name":"project_id","in":"path"},{"_id":"5681591225ea3717002a02be","ref":"","required":false,"desc":"","default":"","type":"int","name":"nb_connections","in":"query"},{"_id":"5681591225ea3717002a02bd","ref":"","required":false,"desc":"","default":"","type":"int","name":"interest","in":"query"},{"_id":"56bb0180b9b78c0d0029126a","ref":"","required":false,"desc":"","default":"","type":"string","name":"external_id","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"search\": null,\n  \"limit\": 50,\n  \"offset\": 0,\n  \"order\": \"-tokens.created_at\",\n  \"total\": 2,\n  \"contents\": [\n    {\n      \"id\": 119091,\n      \"name\": \"Tilk2\",\n      \"project_name\": \"My first project\",\n      \"link\": \"https://api.tilk.us/v/1ae3ad47f0\",\n      \"won\": null,\n      \"created_at\": \"2015-10-08T17:38:47.920+02:00\",\n      \"consulted\": false,\n      \"signed_status\": \"no_init\",\n      \"archived_at\": null,\n      \"signed\": false,\n      \"signed_docs\": [],\n      \"total_time\": 0,\n      \"last_sign_in_at\": null,\n      \"nb_connections\": 0,\n      \"person_contact\": null\n    },\n    {\n      \"id\": 118840,\n      \"name\": \"paul+finaltest\",\n      \"project_name\": \"My first project\",\n      \"link\": \"https://api.tilk.us/v/5d53f65a41\",\n      \"won\": null,\n      \"created_at\": \"2015-10-07T18:18:31.569+02:00\",\n      \"consulted\": false,\n      \"signed_status\": \"no_init\",\n      \"archived_at\": null,\n      \"signed\": false,\n      \"signed_docs\": [],\n      \"total_time\": 0,\n      \"last_sign_in_at\": null,\n      \"nb_connections\": 0,\n      \"person_contact\": {\n        \"id\": 109375,\n        \"name\": \"paul+finaltest\",\n        \"email\": \"paul+finaltest@tilkee.com\",\n        \"phone\": null,\n        \"keywords\": null,\n        \"organization_contact\": null\n      }\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/tokens"},"body":"","category":"561269523cf4bc0d00554e7b","createdAt":"2015-10-08T15:39:57.105Z","editedParams":true,"editedParams2":true,"excerpt":"You can have several links (Tilks) for a project. This command is used to retrieve all of them. A project id is needed","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"list-of-tilks-in-a-project","sync_unique":"","title":"List of Tilks in a project","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getList of Tilks in a project

You can have several links (Tilks) for a project. This command is used to retrieve all of them. A project id is needed

Path Params

project_id:
integer

Query Params

search:
string
Title, name, email, token_url
limit:
integer
offset:
integer
order:
string
archived_tokens:
boolean
signed_status:
string
["init", "waiting", "signed", "signed_complete"]
consulted:
boolean
signed:
boolean
nb_connections:
integer
interest:
integer
external_id:
string

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":3,"_id":"56168efbbb557f0d00056f9d","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 119091,\n  \"name\": \"Tilk2\",\n  \"project_name\": \"My first project\",\n  \"link\": \"https://api.tilk.us/v/1ae3ad47f0\",\n  \"won\": null,\n  \"created_at\": \"2015-10-08T17:38:47.920+02:00\",\n  \"consulted\": false,\n  \"signed_status\": \"no_init\",\n  \"archived_at\": null,\n  \"signed\": false,\n  \"signed_docs\": [],\n  \"external_id\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/projects/:project_id/tokens/:id"},"body":"","category":"561269523cf4bc0d00554e7b","createdAt":"2015-10-08T15:42:51.869Z","excerpt":"Used to get every details of a link (Tilk). You need a project id and a Tilk id.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"get-details-of-a-tilk","sync_unique":"","title":"Get (details of a Tilk)","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getGet (details of a Tilk)

Used to get every details of a link (Tilk). You need a project id and a Tilk id.


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":2,"_id":"56126bf409bdc51700696fcf","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{ \n\"name\" : \"toto\",\n\"external_id\": \"my_personal_id:3278\"\n}'","name":""}]},"params":[{"_id":"56126bf409bdc51700696fd0","default":"","desc":"Update your project name","in":"body","name":"name","ref":"","required":false,"type":"string"},{"_id":"561bd22bc89cc30d00821610","default":"","desc":"Specify if the tilk succeeded","in":"body","name":"won","ref":"","required":false,"type":"boolean"},{"_id":"56bb01b787f3f82300c8b772","default":"","desc":"","in":"body","name":"external_id","ref":"","required":false,"type":"string"}],"results":{"codes":[{"name":"","code":"{\n  \"id\": 116856,\n  \"name\": \"toto\",\n  \"project_name\": \"Généré via Gmail\",\n  \"link\": \"https://api.tilk.us/v/1350054001\",\n  \"won\": null,\n  \"created_at\": \"2015-09-29T16:13:54.518+02:00\",\n  \"consulted\": true,\n  \"signed_status\": null,\n  \"archived_at\": null,\n  \"signed\": false,\n  \"signed_docs\": [],\n  \"person_contact\": null,\n  \"external_id\": \"my_personal_id:3278\"\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/tokens/:token_id/"},"body":"Note: If you want to restore an archived tilk use https://api.tilkee.com/tokens/<ID TILK>/restore","category":"561269523cf4bc0d00554e7b","createdAt":"2015-10-05T12:24:20.768Z","editedParams":true,"editedParams2":true,"excerpt":"Used to update Tilk parameters like name or status","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"update","sync_unique":"","title":"Update","type":"put","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

putUpdate

Used to update Tilk parameters like name or status

Body JSON

name:
string
Update your project name
won:
boolean
Specify if the tilk succeeded
external_id:
string
Note: If you want to restore an archived tilk use https://api.tilkee.com/tokens/<ID TILK>/restore

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Note: If you want to restore an archived tilk use https://api.tilkee.com/tokens/<ID TILK>/restore
{"__v":3,"_id":"56126c662afc821700a5b203","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 116840,\n  \"name\": \"test1\",\n  \"project_name\": \"Généré via Gmail\",\n  \"link\": \"https://api.tilk.us/v/d2306260be\",\n  \"won\": null,\n  \"created_at\": \"2015-09-29T15:54:59.463+02:00\",\n  \"consulted\": true,\n  \"signed_status\": null,\n  \"archived_at\": \"2015-10-12T18:03:11.054+02:00\",\n  \"signed\": false,\n  \"signed_docs\": [],\n  \"external_id\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/tokens/:token_id/archive/"},"body":"","category":"561269523cf4bc0d00554e7b","createdAt":"2015-10-05T12:26:14.410Z","excerpt":"In this section you can archive your tilks","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"archive-1","sync_unique":"","title":"Archive","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postArchive

In this section you can archive your tilks


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":3,"_id":"5624fc7e5a86b42300946312","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 119091,\n  \"name\": \"Tilk2\",\n  \"project_name\": \"My first project\",\n  \"link\": \"https://api.tilk.us/v/1ae3ad47f0\",\n  \"won\": null,\n  \"created_at\": \"2015-10-08T17:38:47.920+02:00\",\n  \"consulted\": false,\n  \"signed_status\": \"no_init\",\n  \"archived_at\": null,\n  \"signed\": false,\n  \"signed_docs\": [],\n  \"external_id\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/tokens/:token_id/restore"},"body":"","category":"561269523cf4bc0d00554e7b","createdAt":"2015-10-19T14:21:50.406Z","excerpt":"Used to restore an archived Tilk, you need a Tilk id","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"restore-1","sync_unique":"","title":"Restore","type":"put","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

putRestore

Used to restore an archived Tilk, you need a Tilk id


User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5639daeed25e8919005f3e52","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"Items are the different docs you add to a project. An item can be a picture, a video, a text, a doc, an external website.","category":"56153e21da0f380d00689046","createdAt":"2015-11-04T10:16:14.093Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"what-is-it-3","sync_unique":"","title":"What is it ?","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

What is it ?


Items are the different docs you add to a project. An item can be a picture, a video, a text, a doc, an external website.
Items are the different docs you add to a project. An item can be a picture, a video, a text, a doc, an external website.
{"__v":6,"_id":"56153ef1f8f2890d006d9fdd","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","code":"{\n  \"key\": \"uploads/3712/50939bb82e019c06bd77800b3160cf49/${filename}\",\n  \"acl\": \"public-read\",\n  \"policy\": \"eyJleHBpcmF0aW9uIjoiMjAxNS0xMS0xOVQxMDo0NToxN1oiLCJjb25kaXRpb25zIjpbWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIiXSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDEwNDg1NzYwMF0seyJidWNrZXQiOiJkYXRhdGxrIn0seyJhY2wiOiJwdWJsaWMtcmVhZCJ9LHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn1dfQ==\",\n  \"signature\": \"ZRYkX5nCfpe/eeRJq6nWcIvDN1Q=\",\n  \"AWSAccessKeyId\": \"AKIAIYJYD7IOKXPAG54A\",\n  \"success_action_status\": \"201\",\n  \"s3_endpoint\": \"https://datatlk.tilkee.com/\",\n  \"name\": \"aws\"\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"560e512539fad419002ae15d","url":"/direct_upload_data/"},"body":"Then you have to create a HTML form using previous information and replacing ${filename} by NOM_FICHIER.pdf\nThe file’s URL on the S3 will be “direct_upload_data.s3_endpoint.direct_upload_data.key” (after replaced “${filename}” by NOM_FICHIER.pdf)\nAmazon’s response is the URL you need to create your item in Tilkee.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<form action=\\\"https://datatlk.tilkee.com\\\" method=\\\"post\\\" enctype=\\\"multipart/form-data\\\">\\n<input type=\\\"hidden\\\" name=\\\"key\\\" value=\\\"uploads/3260/15e54d71fbfe7984792abad1bdf9127e/${filename}\\\" /><br />\\n<input type=\\\"hidden\\\" name=\\\"acl\\\" value=\\\"public-read\\\" />\\n<input type=\\\"hidden\\\" name=\\\"policy\\\" value=\\\"eyJleHBpcmF0aW9uIjoiMjAxNS0wOS0xNFQxNToyMjoyNloiLCJjb25kaXRpb25zIjpbWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIiXSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDEwNDg1NzYwMF0seyJidWNrZXQiOiJkYXRhdGxrIn0seyJhY2wiOiJwdWJsaWMtcmVhZCJ9LHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn1dfQ==\\\" />\\n<input type=\\\"hidden\\\" name=\\\"Signature\\\" value=\\\"Yxd3kzyAnWFCdvVrVj3OGq+Qmgk=\\\" />\\n<input type=\\\"hidden\\\" name=\\\"AWSAccessKeyId\\\" value=\\\"AKIAIYJYD7IOKXPAG54A\\\" />\\n \\n<input type=\\\"hidden\\\" name=\\\"success_action_status\\\" value=\\\"201\\\" />\\n<input type=\\\"file\\\" name=\\\"file\\\" />\\n \\n<input type=\\\"submit\\\" name=\\\"submit\\\" value=\\\"Upload to Amazon S3\\\" />\\n</form>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]","category":"56153e21da0f380d00689046","createdAt":"2015-10-07T15:49:05.077Z","excerpt":"You have the possibility to upload any file directly from your computer to the amazon server. To do that you have to get connection information from the S3 server.\n\n\nNote: to collect this information you have to be connected with an admin token.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"direct-upload","sync_unique":"","title":"Direct upload","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getDirect upload

You have the possibility to upload any file directly from your computer to the amazon server. To do that you have to get connection information from the S3 server. Note: to collect this information you have to be connected with an admin token.

Then you have to create a HTML form using previous information and replacing ${filename} by NOM_FICHIER.pdf The file’s URL on the S3 will be “direct_upload_data.s3_endpoint.direct_upload_data.key” (after replaced “${filename}” by NOM_FICHIER.pdf) Amazon’s response is the URL you need to create your item in Tilkee. [block:code] { "codes": [ { "code": "<form action=\"https://datatlk.tilkee.com\" method=\"post\" enctype=\"multipart/form-data\">\n<input type=\"hidden\" name=\"key\" value=\"uploads/3260/15e54d71fbfe7984792abad1bdf9127e/${filename}\" /><br />\n<input type=\"hidden\" name=\"acl\" value=\"public-read\" />\n<input type=\"hidden\" name=\"policy\" value=\"eyJleHBpcmF0aW9uIjoiMjAxNS0wOS0xNFQxNToyMjoyNloiLCJjb25kaXRpb25zIjpbWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIiXSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDEwNDg1NzYwMF0seyJidWNrZXQiOiJkYXRhdGxrIn0seyJhY2wiOiJwdWJsaWMtcmVhZCJ9LHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn1dfQ==\" />\n<input type=\"hidden\" name=\"Signature\" value=\"Yxd3kzyAnWFCdvVrVj3OGq+Qmgk=\" />\n<input type=\"hidden\" name=\"AWSAccessKeyId\" value=\"AKIAIYJYD7IOKXPAG54A\" />\n \n<input type=\"hidden\" name=\"success_action_status\" value=\"201\" />\n<input type=\"file\" name=\"file\" />\n \n<input type=\"submit\" name=\"submit\" value=\"Upload to Amazon S3\" />\n</form>", "language": "html" } ] } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Then you have to create a HTML form using previous information and replacing ${filename} by NOM_FICHIER.pdf The file’s URL on the S3 will be “direct_upload_data.s3_endpoint.direct_upload_data.key” (after replaced “${filename}” by NOM_FICHIER.pdf) Amazon’s response is the URL you need to create your item in Tilkee. [block:code] { "codes": [ { "code": "<form action=\"https://datatlk.tilkee.com\" method=\"post\" enctype=\"multipart/form-data\">\n<input type=\"hidden\" name=\"key\" value=\"uploads/3260/15e54d71fbfe7984792abad1bdf9127e/${filename}\" /><br />\n<input type=\"hidden\" name=\"acl\" value=\"public-read\" />\n<input type=\"hidden\" name=\"policy\" value=\"eyJleHBpcmF0aW9uIjoiMjAxNS0wOS0xNFQxNToyMjoyNloiLCJjb25kaXRpb25zIjpbWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIiXSxbImNvbnRlbnQtbGVuZ3RoLXJhbmdlIiwwLDEwNDg1NzYwMF0seyJidWNrZXQiOiJkYXRhdGxrIn0seyJhY2wiOiJwdWJsaWMtcmVhZCJ9LHsic3VjY2Vzc19hY3Rpb25fc3RhdHVzIjoiMjAxIn1dfQ==\" />\n<input type=\"hidden\" name=\"Signature\" value=\"Yxd3kzyAnWFCdvVrVj3OGq+Qmgk=\" />\n<input type=\"hidden\" name=\"AWSAccessKeyId\" value=\"AKIAIYJYD7IOKXPAG54A\" />\n \n<input type=\"hidden\" name=\"success_action_status\" value=\"201\" />\n<input type=\"file\" name=\"file\" />\n \n<input type=\"submit\" name=\"submit\" value=\"Upload to Amazon S3\" />\n</form>", "language": "html" } ] } [/block]
{"__v":4,"_id":"56153fd2beee6f0d009df227","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"[\n {\n  \"name\": \"my_new_file\",\n  \"from_url\": true,\n  \"s3_url\": \"http://www.tilkee.com/wp-content/uploads/sites/17/2015/09/Logo_blanc1.png\",\n  \"type\": \"file\"\n }\n ]","name":""}]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"id\": 67900,\n    \"title\": \"my_new_file\",\n    \"element_type\": \"doc\",\n    \"extension\": \"png\",\n    \"type\": \"Doc:png\",\n    \"owner\": {\n      \"id\": 4482,\n      \"first_name\": \"PAUL\",\n      \"last_name\": \"DEFLANDRE\",\n      \"position\": null,\n      \"email\": \"paul@tilkee.com\",\n      \"phone_number\": null,\n      \"cell_phone_number\": null,\n      \"created_at\": \"2015-10-23T18:01:10.065+02:00\",\n      \"updated_at\": \"2015-11-23T10:58:33.184+01:00\",\n      \"company_id\": 33,\n      \"avatar\": null,\n      \"contact_email\": \"paul@tilkee.com\",\n      \"should_receive_emails\": true,\n      \"deleted_at\": null,\n      \"level_id\": 1,\n      \"locale\": \"fr\",\n      \"should_receive_connexion_email\": true,\n      \"frequency_proposal_sumup_email\": 7,\n      \"proposal_sumup_sent_at\": null,\n      \"devices\": [],\n      \"sf_id\": null,\n      \"frequency_noread_sumup_email\": null,\n      \"intercom_id\": \"56011205ae566f09bd000001\",\n      \"default_theme_id\": null,\n      \"utm\": null,\n      \"linkedin_account_url\": \"\",\n      \"twitter_account_url\": \"\",\n      \"facebook_account_url\": \"\"\n    },\n    \"content_url\": \"//tilkee-v2-beta2.herokuapp.com/docs/42851/crocodoc_player/?signature=btVjNasqNcbOAyt9iW3RKDvuvkkI5TKPJdtDZM%2BZXY0%3D%0A\",\n    \"thumbnail_url\": \"https://datatlk.tilkee.com/front/illustration/thumbnails/doc.jpg\",\n    \"visible\": false,\n    \"created_at\": \"2015-11-26T10:07:00.963+01:00\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/items/"},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","category":"56153e21da0f380d00689046","createdAt":"2015-10-07T15:52:50.176Z","excerpt":"This section allows you to create items. You have 3 possibilities: add a document from a URL, add text or add external content.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"create-a-file","sync_unique":"","title":"Create items from a file","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postCreate items from a file

This section allows you to create items. You have 3 possibilities: add a document from a URL, add text or add external content.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"__v":4,"_id":"56153ff5dc11550d00045749","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"[\n {\n \"content\": \"<p>this is some html content</p>\",\n \"title\": \"This is my title\",\n \"type\": \"text\"\n }\n]","name":""}]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"id\": 67897,\n    \"title\": \"This is my title\",\n    \"element_type\": \"texte\",\n    \"extension\": null,\n    \"type\": \"Texte:\",\n    \"owner\": {\n      \"id\": 4658,\n      \"first_name\": null,\n      \"last_name\": null,\n      \"position\": null,\n      \"email\": \"paul+test@tilkee.com\",\n      \"phone_number\": null,\n      \"cell_phone_number\": null,\n      \"created_at\": \"2015-11-18T10:02:43.645+01:00\",\n      \"updated_at\": \"2015-11-23T15:57:30.036+01:00\",\n      \"company_id\": 3712,\n      \"avatar\": null,\n      \"contact_email\": \"paul+test@tilkee.com\",\n      \"should_receive_emails\": true,\n      \"deleted_at\": null,\n      \"level_id\": 1,\n      \"locale\": \"en\",\n      \"should_receive_connexion_email\": true,\n      \"frequency_proposal_sumup_email\": 7,\n      \"proposal_sumup_sent_at\": null,\n      \"devices\": [],\n      \"sf_id\": null,\n      \"frequency_noread_sumup_email\": null,\n      \"intercom_id\": \"564c3eb8d11b28b124000056\",\n      \"default_theme_id\": null,\n      \"utm\": [\n        {\n          \"url_referer\": \"https://app2.tilkee.com/fr/\",\n          \"UTM\": null\n        }\n      ],\n      \"linkedin_account_url\": \"\",\n      \"twitter_account_url\": \"\",\n      \"facebook_account_url\": \"\"\n    },\n    \"content\": \"<p>this is some html content</p>\",\n    \"thumbnail_url\": \"https://datatlk.tilkee.com/front/illustration/thumbnails/doc.jpg\",\n    \"visible\": false,\n    \"created_at\": \"2015-11-23T16:38:13.419+01:00\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/items/"},"body":"","category":"56153e21da0f380d00689046","createdAt":"2015-10-07T15:53:25.088Z","excerpt":"This section allows you to create items. You have 3 possibilities: add a document from a URL, add text or add external content.","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"create-a-text","sync_unique":"","title":"Create items from a text","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postCreate items from a text

This section allows you to create items. You have 3 possibilities: add a document from a URL, add text or add external content.


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":3,"_id":"5615402fa4ccab0d00e6991f","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"[\n {\n \"title\": \"My awesome website\",\n \"type\": \"link\",\n \"url\": \"http://www.tilkee.fr\"\n }\n ]","name":""}]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"id\": 67898,\n    \"title\": \"My awesome website\",\n    \"element_type\": \"iframe\",\n    \"extension\": null,\n    \"type\": \"Iframe:\",\n    \"owner\": {\n      \"id\": 4658,\n      \"first_name\": null,\n      \"last_name\": null,\n      \"position\": null,\n      \"email\": \"paul+test@tilkee.com\",\n      \"phone_number\": null,\n      \"cell_phone_number\": null,\n      \"created_at\": \"2015-11-18T10:02:43.645+01:00\",\n      \"updated_at\": \"2015-11-23T15:57:30.036+01:00\",\n      \"company_id\": 3712,\n      \"avatar\": null,\n      \"contact_email\": \"paul+test@tilkee.com\",\n      \"should_receive_emails\": true,\n      \"deleted_at\": null,\n      \"level_id\": 1,\n      \"locale\": \"en\",\n      \"should_receive_connexion_email\": true,\n      \"frequency_proposal_sumup_email\": 7,\n      \"proposal_sumup_sent_at\": null,\n      \"devices\": [],\n      \"sf_id\": null,\n      \"frequency_noread_sumup_email\": null,\n      \"intercom_id\": \"564c3eb8d11b28b124000056\",\n      \"default_theme_id\": null,\n      \"utm\": [\n        {\n          \"url_referer\": \"https://app2.tilkee.com/fr/\",\n          \"UTM\": null\n        }\n      ],\n      \"linkedin_account_url\": \"\",\n      \"twitter_account_url\": \"\",\n      \"facebook_account_url\": \"\"\n    },\n    \"content_url\": \"http://www.tilkee.fr\",\n    \"thumbnail_url\": \"https://datatlk.tilkee.com/front/illustration/thumbnails/iframe.jpg\",\n    \"visible\": false,\n    \"created_at\": \"2015-11-23T16:38:45.293+01:00\"\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/items/"},"body":"","category":"56153e21da0f380d00689046","createdAt":"2015-10-07T15:54:23.426Z","excerpt":"This section allows you to create items. You have 3 possibilities: add a document from a URL, add text or add external content..","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"create-items-from-external-content","sync_unique":"","title":"Create items from external content","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postCreate items from external content

This section allows you to create items. You have 3 possibilities: add a document from a URL, add text or add external content..


User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"561542e2beee6f0d009df231","api":{"auth":"required","examples":{"codes":[{"language":"text","code":"","name":""}]},"params":[{"_id":"561542e2beee6f0d009df235","default":"","desc":"Title, owner name","name":"search","required":false,"type":"string","in":"query"},{"_id":"561542e2beee6f0d009df234","required":false,"desc":"","default":"","type":"int","name":"limit","in":"query"},{"_id":"561542e2beee6f0d009df233","required":false,"desc":"","default":"","type":"int","name":"offset","in":"query"},{"_id":"561542e2beee6f0d009df232","required":false,"desc":"","default":"","type":"string","name":"order","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"//With limit=2\n\n{\n  \"search\": null,\n  \"limit\": 2,\n  \"offset\": 0,\n  \"total\": 15,\n  \"order\": \"-items.created_at\",\n  \"contents\": [\n    {\n      \"id\": 60190,\n      \"title\": \"2014\",\n      \"element_type\": \"doc\",\n      \"extension\": \"pdf\",\n      \"type\": \"Doc:pdf\",\n      \"owner\": {\n        \"id\": 4076,\n        \"first_name\": \"PAUL\",\n        \"last_name\": \"DEFLANDRE\",\n        \"position\": null,\n        \"email\": \"paul2@tilkee.com\",\n        \"phone_number\": null,\n        \"cell_phone_number\": \"0669029839\",\n        \"created_at\": \"2015-09-03T18:00:06.640+02:00\",\n        \"updated_at\": \"2015-10-07T21:36:37.491+02:00\",\n        \"company_id\": 3260,\n        \"avatar\": null,\n        \"contact_email\": \"paul@tilkee.com\",\n        \"should_receive_emails\": true,\n        \"deleted_at\": null,\n        \"level_id\": 1,\n        \"locale\": \"en\",\n        \"should_receive_connexion_email\": true,\n        \"frequency_proposal_sumup_email\": 7,\n        \"proposal_sumup_sent_at\": null,\n        \"devices\": [],\n        \"sf_id\": null,\n        \"frequency_noread_sumup_email\": null,\n        \"intercom_id\": \"55e86e8ee341a878d0000b5b\",\n        \"default_theme_id\": null,\n        \"utm\": [\n          {\n            \"url_referer\": \"https://app2.tilkee.com/en/\",\n            \"UTM\": null\n          }\n        ],\n        \"linkedin_account_url\": \"\",\n        \"twitter_account_url\": \"\",\n        \"facebook_account_url\": \"\"\n      },\n      \"content_url\": \"//api.tilkee.com/docs/35800/crocodoc_player/?signature=nlUfvsk5Q%2F%2Be04mnei6XFC3qFntRdvhUpzTPp56SPE4%3D%0A\",\n      \"thumbnail_url\": \"https://s3-eu-west-1.amazonaws.com/tilkee-beta/uploads/illustration/thumbnails/doc.jpg\",\n      \"visible\": true,\n      \"created_at\": \"2015-10-07T18:18:27.094+02:00\",\n      \"projects\": [\n        {\n          \"name\": \"My first project\"\n        }\n      ],\n      \"projects_count\": 1\n    },\n    {\n      \"id\": 60189,\n      \"title\": \"JuryHEI4\",\n      \"element_type\": \"doc\",\n      \"extension\": \"pdf\",\n      \"type\": \"Doc:pdf\",\n      \"owner\": {\n        \"id\": 4076,\n        \"first_name\": \"PAUL\",\n        \"last_name\": \"DEFLANDRE\",\n        \"position\": null,\n        \"email\": \"paul2@tilkee.com\",\n        \"phone_number\": null,\n        \"cell_phone_number\": \"0669029839\",\n        \"created_at\": \"2015-09-03T18:00:06.640+02:00\",\n        \"updated_at\": \"2015-10-07T21:36:37.491+02:00\",\n        \"company_id\": 3260,\n        \"avatar\": null,\n        \"contact_email\": \"paul@tilkee.com\",\n        \"should_receive_emails\": true,\n        \"deleted_at\": null,\n        \"level_id\": 1,\n        \"locale\": \"en\",\n        \"should_receive_connexion_email\": true,\n        \"frequency_proposal_sumup_email\": 7,\n        \"proposal_sumup_sent_at\": null,\n        \"devices\": [],\n        \"sf_id\": null,\n        \"frequency_noread_sumup_email\": null,\n        \"intercom_id\": \"55e86e8ee341a878d0000b5b\",\n        \"default_theme_id\": null,\n        \"utm\": [\n          {\n            \"url_referer\": \"https://app2.tilkee.com/en/\",\n            \"UTM\": null\n          }\n        ],\n        \"linkedin_account_url\": \"\",\n        \"twitter_account_url\": \"\",\n        \"facebook_account_url\": \"\"\n      },\n      \"content_url\": \"//api.tilkee.com/docs/35799/crocodoc_player/?signature=iq8EXLUPZ%2B8ELW0xV6spuZMY04sDX%2Fa8J6hkxwr3NYE%3D%0A\",\n      \"thumbnail_url\": \"https://s3-eu-west-1.amazonaws.com/tilkee-beta/uploads/illustration/thumbnails/doc.jpg\",\n      \"visible\": true,\n      \"created_at\": \"2015-10-07T18:18:26.625+02:00\",\n      \"projects\": [\n        {\n          \"name\": \"My first project\"\n        }\n      ],\n      \"projects_count\": 1\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/items/"},"body":"","category":"56153e21da0f380d00689046","createdAt":"2015-10-07T16:05:54.628Z","editedParams":true,"editedParams2":true,"excerpt":"Use this to get the list of items you added to your Tilkee account","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"list-of-items","sync_unique":"","title":"List of items","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getList of items

Use this to get the list of items you added to your Tilkee account

Query Params

search:
string
Title, owner name
limit:
integer
offset:
integer
order:
string

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":2,"_id":"56154385da0f380d0068904f","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"id\": 77585,\n    \"position\": 1,\n    \"type\": \"ProjectItem\",\n\t  \"title\": \"title\",\n    \"signable\": null,\n    \"item\": {\n      \"id\": 44534,\n\t\t\"title\": \"filename\",\n      \"element_type\": \"image\",\n      \"extension\": \"jpg\",\n      \"type\": \"Image:jpg\",\n      \"content_url\": \"https://datatlk.tilkee.com/uploads/...\",\n      \"thumbnail_url\": \"https://datatlk.tilkee.com/uploads/...\",\n      \"visible\": false,\n      \"created_at\": \"2015-06-01T15:42:20.194+02:00\"\n    }\n  },\n  {\n    \"id\": 77581,\n    \"position\": 2,\n    \"type\": \"ProjectItem\",\n\t  \"title\": \"title2\",\n    \"signable\": null,\n    \"item\": {\n      \"id\": 39337,\n\t\t\"title\": \"filename 2\",\n      \"element_type\": \"doc\",\n      \"extension\": \"pdf\",\n      \"type\": \"Doc:pdf\",\n      \"content_url\": \"\",\n      \"thumbnail_url\": \"https://datatlk.tilkee.com/front/illustration/thumbnails/doc.jpg\",\n      \"visible\": false,\n      \"created_at\": \"2015-04-01T10:12:26.779+02:00\"\n    }\n  }\n]\n","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/items"},"body":"","category":"56153e21da0f380d00689046","createdAt":"2015-10-07T16:08:37.373Z","excerpt":"Use this section to consult all items in a project","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"list-of-items-in-a-project","sync_unique":"","title":"List of Items in a project","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getList of Items in a project

Use this section to consult all items in a project


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":2,"_id":"561545578113d20d00082f72","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n  \"items\" : [{ \n    \"content_url\": \"https://datatlk.tilkee.com/uploads/...\",\n    \"created_at\": \"Thu, 25 Jun 2015 14:59:59 CEST +02:00\",\n    \"element_type\": \"Doc\",\n    \"extension\": \"pdf\",\n    \"id\": 47215,\n    \"owner\": {\n        \"id\": 2479\n        },\n    \"signable\": false,\n    \"thumbnail_url\": \"https://datatlk.s3.amazonaws.com/uploads/...\",\n    \"title\": \"Capture d’écran 2015-10-24 à 19.22.24\",\n    \"type\": \"Image:png\",\n    \"visible\": false\n   }]\n}\n","name":""}]},"params":[{"_id":"5630ec837581b80d00c51d16","default":"","desc":"There are 3 parameters in the array: id (Integer), title (String), signable (Boolean)","in":"body","name":"items","ref":"","required":false,"type":"array_int"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"id\": 104199,\n    \"position\": 1,\n    \"type\": \"ProjectItem\",\n    \"title\": \"Capture d’écran 2015-10-24 à 19.22.24\",\n    \"signable\": false,\n    \"item\": {\n      \"id\": 47215,\n\t\t\"title\": \"title\",\n      \"element_type\": \"doc\",\n      \"extension\": \"pdf\",\n      \"type\": \"Doc:pdf\",\n      \"content_url\": \"//localhost:3000/docs/24449/crocodoc_pla...\",\n      \"thumbnail_url\": \"https://datatlk.tilkee.com/front/illustration/thumbnails/doc.jpg\",\n      \"visible\": false,\n      \"created_at\": \"2015-06-25T14:56:11.520+02:00\"\n    }\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/add_items"},"body":"","category":"56153e21da0f380d00689046","createdAt":"2015-10-07T16:16:23.764Z","editedParams":true,"editedParams2":true,"excerpt":"Use this section to add an existing item to a project","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"add-item-in-project","sync_unique":"","title":"Add item in project","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postAdd item in project

Use this section to add an existing item to a project

Body JSON

items:
array of integers
There are 3 parameters in the array: id (Integer), title (String), signable (Boolean)

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"56165d1721e9110d00780324","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"[\n  {\n    \"id\": 104199,\n    \"position\": 1,\n    \"type\": \"ProjectItem\",\n\t  \"title\": \"pi title\",\n    \"signable\": false,\n    \"item\": {\n      \"id\": 47215,\n\t\t\"title\": \"title\",\n      \"element_type\": \"doc\",\n      \"extension\": \"pdf\",\n      \"type\": \"Doc:pdf\",\n      \"content_url\": \"//localhost:3000/docs/24449/crocodoc_play...\",\n      \"thumbnail_url\": \"https://datatlk.tilkee.com/front/illustration/thumbnails/doc.jpg\",\n      \"visible\": false,\n      \"created_at\": \"2015-06-25T14:56:11.520+02:00\"\n    }\n  }\n]","name":""}]},"params":[{"_id":"56165d1721e9110d0078032a","required":true,"desc":"","default":"","type":"array_mixed","name":"zones","in":"body"},{"_id":"56165d1721e9110d00780329","required":true,"desc":"Name of the zone. Appear on the tilk viewer menu","default":"","type":"string","name":"name","in":"body"},{"_id":"56165d1721e9110d00780328","required":true,"desc":"","default":"","type":"string","name":"project_items","in":"body"},{"_id":"56165d1721e9110d00780327","required":true,"desc":"id of the project_item.","default":"","type":"int","name":"id","in":"body"},{"_id":"56165d1721e9110d00780326","required":true,"desc":"title of the project_item. A item can have different name per project","default":"","type":"string","name":"title","in":"body"},{"_id":"56165d1721e9110d00780325","required":false,"desc":"for pdf only, you can activate the signature","default":"","type":"boolean","name":"signable","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"id\": 104199,\n    \"position\": 1,\n    \"type\": \"ProjectItem\",\n\t  \"title\": \"pi title\",\n    \"signable\": false,\n    \"item\": {\n      \"id\": 47215,\n\t\t\"title\": \"title\",\n      \"element_type\": \"doc\",\n      \"extension\": \"pdf\",\n      \"type\": \"Doc:pdf\",\n      \"content_url\": \"//localhost:3000/docs/24449/crocodoc_play...\",\n      \"thumbnail_url\": \"https://datatlk.tilkee.com/front/illustration/thumbnails/doc.jpg\",\n      \"visible\": false,\n      \"created_at\": \"2015-06-25T14:56:11.520+02:00\"\n    }\n  }\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/items"},"body":"","category":"56153e21da0f380d00689046","createdAt":"2015-10-08T12:09:59.776Z","editedParams":true,"editedParams2":true,"excerpt":"Used to update an item in a specific project. A project id is needed","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":8,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"update-pb-type-param","sync_unique":"","title":"Update","type":"put","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

putUpdate

Used to update an item in a specific project. A project id is needed

Body JSON

zones:
required
array of mixed
name:
required
string
Name of the zone. Appear on the tilk viewer menu
project_items:
required
string
id:
required
integer
id of the project_item.
title:
required
string
title of the project_item. A item can have different name per project
signable:
boolean
for pdf only, you can activate the signature

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":1,"_id":"56165d7ae98f551700562741","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"null","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/Items/:item_id"},"body":"","category":"56153e21da0f380d00689046","createdAt":"2015-10-08T12:11:38.411Z","excerpt":"Permanently deletes a specific item","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":9,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"delete-1","sync_unique":"","title":"Delete","type":"delete","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

deleteDelete

Permanently deletes a specific item


User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"56165de9c8c5e70d00a8a12f","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"null","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/items/batch?items_id"},"body":"","category":"56153e21da0f380d00689046","createdAt":"2015-10-08T12:13:29.526Z","excerpt":"Permanently deletes a batch of items","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":10,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"delete-an-array-of-item","sync_unique":"","title":"Delete an array of item","type":"delete","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

deleteDelete an array of item

Permanently deletes a batch of items


User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":2,"_id":"561620d321e9110d007802db","api":{"auth":"required","examples":{"codes":[{"name":"","code":"","language":"json"}]},"params":[{"_id":"5616220621e9110d007802e4","default":"","desc":"Comma-separated list of token ids to filter","in":"query","name":"tokens","ref":"","required":false,"type":"string"},{"_id":"5616220621e9110d007802e3","default":"","desc":"Timestamp of start limit","in":"query","name":"start_date","ref":"","required":false,"type":"string"},{"_id":"5616220621e9110d007802e2","default":"","desc":"Timestamp of end limit","in":"query","name":"end_date","ref":"","required":false,"type":"string"},{"_id":"5616220621e9110d007802e0","default":"","desc":"Number of objects to returns","in":"query","name":"limit","ref":"","required":false,"type":"string"},{"_id":"5616220621e9110d007802df","default":"","desc":"Number of objects to skip from start","in":"query","name":"offset","ref":"","required":false,"type":"string"},{"_id":"5616220621e9110d007802de","default":"","desc":"Name of the field to order by, separated by commas and preceded by – if descending","in":"query","name":"sort","ref":"","required":false,"type":"string"}],"results":{"codes":[{"name":"","code":"{\n  \"search\": null,\n  \"limit\": 2,\n  \"offset\": 0,\n  \"order\": \"-connexions.created_at\",\n  \"total\": 6,\n  \"contents\": [\n    {\n      \"id\": 120695,\n      \"title\": \"test\",\n      \"access_date\": \"2015-10-15T14:31:22.758+02:00\",\n      \"fully_charged\": \"2015-10-15T14:31:40.146+02:00\",\n      \"data_present\": false,\n      \"total_time\": 17,\n      \"percentage_read\": 100,\n      \"downloaded\": false,\n      \"signed\": false,\n      \"platform\": {\n        \"device_type\": \"Computer\",\n        \"device_number\": 1,\n        \"ip\": \"109.190.141.XXX\",\n        \"location\": null,\n        \"os\": \"Windows\",\n        \"browser\": \"Chrome\"\n      },\n      \"token_id\": 122856\n    },\n    {\n      \"id\": 120694,\n      \"title\": \"test\",\n      \"access_date\": \"2015-10-15T14:31:13.460+02:00\",\n      \"fully_charged\": \"2015-10-15T14:31:19.795+02:00\",\n      \"data_present\": true,\n      \"total_time\": 2978,\n      \"percentage_read\": 100,\n      \"downloaded\": false,\n      \"signed\": false,\n      \"platform\": {\n        \"device_type\": \"Computer\",\n        \"device_number\": 1,\n        \"ip\": \"109.190.141.XXX\",\n        \"location\": null,\n        \"os\": \"Windows\",\n        \"browser\": \"Chrome\"\n      },\n      \"token_id\": 122856\n    }\n  ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/connexions"},"body":"","category":"561546a4f098952100ed1eb2","createdAt":"2015-10-08T07:52:51.170Z","editedParams":true,"editedParams2":true,"excerpt":"This section allows you collect your projects’s statistics","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"list-of-connexions-on-a-project","sync_unique":"","title":"List of connections on a project","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getList of connections on a project

This section allows you collect your projects’s statistics

Query Params

tokens:
string
Comma-separated list of token ids to filter
start_date:
string
Timestamp of start limit
end_date:
string
Timestamp of end limit
limit:
string
Number of objects to returns
offset:
string
Number of objects to skip from start
sort:
string
Name of the field to order by, separated by commas and preceded by – if descending

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":3,"_id":"561622dadaf2ba0d001162f7","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 112284,\n  \"title\": \"Zapier\",\n  \"access_date\": \"2015-09-21T10:42:31.762+02:00\",\n  \"data_present\": true,\n  \"total_time\": 3255,\n  \"percentage_read\": 25,\n  \"downloaded\": false,\n  \"signed\": false,\n  \"platform\": {\n    \"device_type\": \"Computer\",\n    \"device_number\": 1,\n    \"ip\": \"109.190.141.XXX\",\n    \"location\": \"Lyon, France\",\n    \"os\": \"Windows\",\n    \"browser\": \"Chrome\"\n  },\n  \"token_id\": 115193,\n  \"contents\": [\n    {\n      \"position\": 1,\n      \"title\": \"INSCRIPTIONS EXAMENS DE CAMBRIDGE NOVEMBRE ET DECEMBRE 2014\",\n      \"deleted_date\": null,\n      \"total_time\": 1993,\n      \"downloaded\": null,\n      \"pages\": [\n        {\n          \"item_tracker_id\": 334179,\n          \"id\": 258304,\n          \"created_at\": \"2015-09-21T10:42:34.851+02:00\",\n          \"updated_at\": \"2015-09-21T10:42:34.851+02:00\",\n          \"page\": null,\n          \"time\": 1993\n        }\n      ]\n    },\n    {\n      \"position\": 2,\n      \"title\": \"INSCRIPTIONS EXAMENS DE CAMBRIDGE NOVEMBRE ET DECEMBRE 2014\",\n      \"deleted_date\": null,\n      \"total_time\": 1262,\n      \"downloaded\": null,\n      \"pages\": [\n        {\n          \"item_tracker_id\": 334285,\n          \"id\": 258692,\n          \"created_at\": \"2015-09-21T11:18:30.926+02:00\",\n          \"updated_at\": \"2015-09-21T11:18:30.926+02:00\",\n          \"page\": 1,\n          \"time\": 1262\n        }\n      ]\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/connexions/:id_connexion/"},"body":"","category":"561546a4f098952100ed1eb2","createdAt":"2015-10-08T08:01:30.237Z","excerpt":"This command allows you to collect the details of a specific connection on a specific project. An id project and an id connection are needed","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"details-of-a-connexion-on-a-project","sync_unique":"","title":"Details of a connection on a project","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getDetails of a connection on a project

This command allows you to collect the details of a specific connection on a specific project. An id project and an id connection are needed


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":2,"_id":"5616234621e9110d007802e6","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"contents\": [\n    {\n      \"id\": 227123,\n      \"doc_name\": \"This is my title\",\n      \"total_time\": 7701\n    },\n    {\n      \"id\": 228728,\n      \"doc_name\": \"p3-offre_technique_et_financiere\",\n      \"total_time\": 35391\n    },\n    {\n      \"id\": 226660,\n      \"doc_name\": \"INSCRIPTIONS EXAMENS DE CAMBRIDGE NOVEMBRE ET DECEMBRE 2014\",\n      \"total_time\": 213539\n    },\n    {\n      \"id\": 237880,\n      \"doc_name\": \"Tilkee\",\n      \"total_time\": null\n    },\n    {\n      \"id\": 216749,\n      \"doc_name\": \"INSCRIPTIONS EXAMENS DE CAMBRIDGE NOVEMBRE ET DECEMBRE 2014\",\n      \"total_time\": 33735\n    },\n    {\n      \"id\": 228727,\n      \"doc_name\": \"uploads-direct-47243244eb61bca654d74de963fd55ba-standard+Massilia\",\n      \"total_time\": 12769\n    }\n  ],\n  \"total_time\": 302239,\n  \"session_count\": 13,\n  \"ip_count\": 1\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/projects/:project_id/stats/"},"body":"","category":"561546a4f098952100ed1eb2","createdAt":"2015-10-08T08:03:18.650Z","excerpt":"Use that command to retrieve stats from a project","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"stats-of-a-project","sync_unique":"","title":"Stats of a project","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getStats of a project

Use that command to retrieve stats from a project


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"564b59f9e5d9d61700d580fb","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"https://app-beta2.tilkee.com/fr/#/project/id_project/stats","category":"561546a4f098952100ed1eb2","createdAt":"2015-11-17T16:46:49.966Z","excerpt":"You have to replace 'id_project'","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"iframe-connected-1","sync_unique":"","title":"Iframe (connected)","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

Iframe (connected)

You have to replace 'id_project'

https://app-beta2.tilkee.com/fr/#/project/id_project/stats
https://app-beta2.tilkee.com/fr/#/project/id_project/stats
{"__v":0,"_id":"564b59ae55cfbe0d00de3b9e","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"https://app2.tilkee.com/fr/#/login/oauth?token=id_token&redirect_to=%2Fproject%2Fid_project%2Fstats","category":"561546a4f098952100ed1eb2","createdAt":"2015-11-17T16:45:34.578Z","excerpt":"You have to replace 'id_token' and 'id_project'","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"iframe-not-connected-1","sync_unique":"","title":"Iframe (not connected)","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

Iframe (not connected)

You have to replace 'id_token' and 'id_project'

https://app2.tilkee.com/fr/#/login/oauth?token=id_token&redirect_to=%2Fproject%2Fid_project%2Fstats
https://app2.tilkee.com/fr/#/login/oauth?token=id_token&redirect_to=%2Fproject%2Fid_project%2Fstats
{"__v":0,"_id":"5639db251846790d0089528c","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"A user is a person using Tilkee, who has a Tilkee account.","category":"561780c1488a011700dd2d39","createdAt":"2015-11-04T10:17:09.074Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"what-is-it-4","sync_unique":"","title":"What is it ?","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

What is it ?


A user is a person using Tilkee, who has a Tilkee account.
A user is a person using Tilkee, who has a Tilkee account.
{"__v":0,"_id":"56178335488a011700dd2d3a","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n  \"first_name\": \"new user\",\n  \"last_name\": \"new user name\",\n  \"email\": \"newuser@man.com\",\n  \"company_attributes\": {\n    \"name\": \"test\",\n    \"cgvs\": \"ok\"\n  }\n}","name":""}]},"params":[{"_id":"56178335488a011700dd2d3e","default":"","desc":"","name":"first_name","ref":"","required":true,"type":"string","in":"body"},{"_id":"56178335488a011700dd2d3d","default":"","desc":"","name":"last_name","ref":"","required":true,"type":"string","in":"body"},{"_id":"56178335488a011700dd2d3c","default":"","desc":"","name":"email","ref":"","required":true,"type":"string","in":"body"},{"_id":"56178335488a011700dd2d3b","default":"","desc":"","name":"company_attributes","ref":"","required":false,"type":"string","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 4357,\n  \"first_name\": \"new user\",\n  \"last_name\": \"new user name\",\n  \"email\": \"newuser@man.com\",\n  \"cell_phone_number\": null,\n  \"phone_number\": null,\n  \"contact_email\": \"newuser@man.com\",\n  \"should_receive_emails\": true,\n  \"level_id\": 3,\n  \"devices\": [],\n  \"rights\": [\n    \"show_project_if_assigned\",\n    \"create_project\",\n    \"archive_project_if_assigned\",\n    \"duplicate_project_if_assigned\",\n    \"delete_project_if_assigned\",\n    \"edit_project_if_assigned\",\n    \"add_document_if_assigned\",\n    \"add_token_if_assigned\",\n    \"archive_token_if_assigned\",\n    \"assign_user_if_assigned\",\n    \"unassign_user_if_assigned\",\n    \"change_leadership_if_assigned\",\n    \"show_stats_if_assigned\",\n    \"delete_file_from_library_if_only_i_use_it\",\n    \"export_projects\",\n    \"delete_document_if_assigned\",\n    \"edit_document_if_assigned\",\n    \"manage_toc_if_only_i_use_it\",\n    \"manage_external_access\",\n    \"access_all_items\",\n    \"archive_project\"\n  ],\n  \"is_owner\": false,\n  \"is_orange_user\": false,\n  \"locale\": \"en\",\n  \"should_receive_connexion_email\": true,\n  \"frequency_proposal_sumup_email\": 7,\n  \"position\": null,\n  \"avatar\": null,\n  \"linkedin_account_url\": \"\",\n  \"twitter_account_url\": \"\",\n  \"facebook_account_url\": \"\",\n  \"last_sign_in_at\": 0,\n  \"location\": null,\n  \"company\": {\n    \"id\": 3260,\n    \"name\": null,\n    \"users_to_charge_counter\": 4,\n    \"have_yousign\": false,\n    \"have_management\": false,\n    \"subdomain\": \"api\",\n    \"domain\": \"tilk.us\",\n    \"customer_type\": null,\n    \"has_custom_branding\": false,\n    \"company_rights\": [\n      \"integration_gmail\",\n      \"acces_stats\",\n      \"can_modify_company\",\n      \"marque_blanche\",\n      \"can_create_project\",\n      \"acces_tilkee\",\n      \"files_import_services\",\n      \"download_option\",\n      \"end_date_option\",\n      \"team_gestion\",\n      \"templated_projects\"\n    ],\n    \"slimpay_url\": \"http://slimpay.tilkee.fr/subscribe/414c5442f78128577b4dc3aeb1eb7699\",\n    \"nb_employees\": 5,\n    \"has_proabono\": false,\n    \"has_to_pay\": 95,\n    \"has_to_pay_ttc\": 114,\n    \"plan\": {\n      \"id\": 66,\n      \"hex\": \"e08932\",\n      \"name\": \"Pro\",\n      \"mode\": 0,\n      \"trial_period\": 30,\n      \"monthly_fee\": 19,\n      \"created_at\": \"2015-03-19T18:02:20.276+01:00\",\n      \"updated_at\": \"2015-04-23T11:58:08.678+02:00\",\n      \"monthly_product_id\": 144852,\n      \"months\": 1,\n      \"per_user_product_id\": 144853,\n      \"per_user_fee\": 19,\n      \"max_users\": null,\n      \"max_active_projects\": null,\n      \"max_tokens_per_project\": null,\n      \"file_quota\": 5000,\n      \"features_set_id\": 2\n    },\n    \"slimpay_validated\": true,\n    \"filepicker_options\": [\n      \"COMPUTER\",\n      \"DROPBOX\",\n      \"BOX\",\n      \"GOOGLE_DRIVE\",\n      \"GMAIL\",\n      \"EVERNOTE\"\n    ]\n  },\n  \"status\": \"awaiting confirmation\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/users"},"body":"","category":"561780c1488a011700dd2d39","createdAt":"2015-10-09T09:04:53.610Z","editedParams":true,"editedParams2":true,"excerpt":"Used to add a new user","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"new-user-param","sync_unique":"","title":"New user","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postNew user

Used to add a new user

Body JSON

first_name:
required
string
last_name:
required
string
email:
required
string
company_attributes:
string

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"5617813f7f74330d00dfd7b8","api":{"auth":"required","params":[{"_id":"5617813f7f74330d00dfd7bc","default":"","desc":"First name, last name, phone, email","name":"search","required":false,"type":"string","in":"query"},{"_id":"5617813f7f74330d00dfd7bb","required":false,"desc":"","default":"","type":"int","name":"limit","in":"query"},{"_id":"5617813f7f74330d00dfd7ba","required":false,"desc":"","default":"","type":"int","name":"offset","in":"query"},{"_id":"5617813f7f74330d00dfd7b9","required":false,"desc":"","default":"","type":"string","name":"order","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"search\": null,\n  \"limit\": 2,\n  \"offset\": 0,\n  \"total\": 3,\n  \"order\": \"-users.created_at\",\n  \"contents\": [\n    {\n      \"id\": 4355,\n      \"first_name\": \"Collaborator#2\",\n      \"last_name\": \"Collaborator#2\",\n      \"email\": \"collaborator#2@tilkee.com\",\n      \"cell_phone_number\": null,\n      \"phone_number\": null,\n      \"contact_email\": \"collaborator#2@tilkee.com\",\n      \"should_receive_emails\": true,\n      \"level_id\": 1,\n      \"devices\": [],\n      \"is_owner\": false,\n      \"is_orange_user\": false,\n      \"locale\": \"en\",\n      \"should_receive_connexion_email\": true,\n      \"frequency_proposal_sumup_email\": 7,\n      \"position\": null,\n      \"avatar\": null,\n      \"linkedin_account_url\": \"\",\n      \"twitter_account_url\": \"\",\n      \"facebook_account_url\": \"\",\n      \"last_sign_in_at\": 0\n    },\n    {\n      \"id\": 4354,\n      \"first_name\": \"Collaborator#1\",\n      \"last_name\": \"Collaborator#1\",\n      \"email\": \"collaborator#1@tilkee.com\",\n      \"cell_phone_number\": null,\n      \"phone_number\": null,\n      \"contact_email\": \"collaborator#1@tilkee.com\",\n      \"should_receive_emails\": true,\n      \"level_id\": 2,\n      \"devices\": [],\n      \"is_owner\": false,\n      \"is_orange_user\": false,\n      \"locale\": \"en\",\n      \"should_receive_connexion_email\": true,\n      \"frequency_proposal_sumup_email\": 7,\n      \"position\": null,\n      \"avatar\": null,\n      \"linkedin_account_url\": \"\",\n      \"twitter_account_url\": \"\",\n      \"facebook_account_url\": \"\",\n      \"last_sign_in_at\": 0\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/users"},"body":"","category":"561780c1488a011700dd2d39","createdAt":"2015-10-09T08:56:31.299Z","editedParams":true,"editedParams2":true,"excerpt":"Used to get a list of all users","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"list-4","sync_unique":"","title":"List","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getList

Used to get a list of all users

Query Params

search:
string
First name, last name, phone, email
limit:
integer
offset:
integer
order:
string

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"561784074d9e4a17002a0e25","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 4354,\n  \"first_name\": \"Collaborator#1\",\n  \"last_name\": \"Collaborator#1\",\n  \"email\": \"collaborator#1@tilkee.com\",\n  \"cell_phone_number\": null,\n  \"phone_number\": null,\n  \"contact_email\": \"collaborator#1@tilkee.com\",\n  \"should_receive_emails\": true,\n  \"level_id\": 2,\n  \"devices\": [],\n  \"rights\": [\n    \"show_project\",\n    \"create_project\",\n    \"archive_project\",\n    \"duplicate_project\",\n    \"delete_project\",\n    \"edit_project\",\n    \"add_document\",\n    \"add_token\",\n    \"archive_token\",\n    \"assign_user\",\n    \"unassign_user\",\n    \"change_leadership\",\n    \"show_stats\",\n    \"create_reference\",\n    \"edit_reference\",\n    \"delete_reference\",\n    \"show_library\",\n    \"delete_file_from_library\",\n    \"export_projects\",\n    \"delete_document\",\n    \"edit_document\",\n    \"manage_external_access\",\n    \"approve_project\",\n    \"access_all_items\",\n    \"access_all_project\"\n  ],\n  \"is_owner\": false,\n  \"is_orange_user\": false,\n  \"locale\": \"en\",\n  \"should_receive_connexion_email\": true,\n  \"frequency_proposal_sumup_email\": 7,\n  \"position\": null,\n  \"avatar\": null,\n  \"linkedin_account_url\": \"\",\n  \"twitter_account_url\": \"\",\n  \"facebook_account_url\": \"\",\n  \"last_sign_in_at\": 0,\n  \"location\": null,\n  \"company\": {\n    \"id\": 3260,\n    \"name\": null,\n    \"users_to_charge_counter\": 4,\n    \"have_yousign\": false,\n    \"have_management\": false,\n    \"subdomain\": \"api\",\n    \"domain\": \"tilk.us\",\n    \"customer_type\": null,\n    \"has_custom_branding\": false,\n    \"company_rights\": [\n      \"integration_gmail\",\n      \"acces_stats\",\n      \"can_modify_company\",\n      \"marque_blanche\",\n      \"can_create_project\",\n      \"acces_tilkee\",\n      \"files_import_services\",\n      \"download_option\",\n      \"end_date_option\",\n      \"team_gestion\",\n      \"templated_projects\"\n    ],\n    \"slimpay_url\": \"http://slimpay.tilkee.fr/subscribe/414c5442f78128577b4dc3aeb1eb7699\",\n    \"nb_employees\": 5,\n    \"has_proabono\": false,\n    \"has_to_pay\": 95,\n    \"has_to_pay_ttc\": 114,\n    \"plan\": {\n      \"id\": 66,\n      \"hex\": \"e08932\",\n      \"name\": \"Pro\",\n      \"mode\": 0,\n      \"trial_period\": 30,\n      \"monthly_fee\": 19,\n      \"created_at\": \"2015-03-19T18:02:20.276+01:00\",\n      \"updated_at\": \"2015-04-23T11:58:08.678+02:00\",\n      \"monthly_product_id\": 144852,\n      \"months\": 1,\n      \"per_user_product_id\": 144853,\n      \"per_user_fee\": 19,\n      \"max_users\": null,\n      \"max_active_projects\": null,\n      \"max_tokens_per_project\": null,\n      \"file_quota\": 5000,\n      \"features_set_id\": 2\n    },\n    \"slimpay_validated\": true,\n    \"filepicker_options\": [\n      \"COMPUTER\",\n      \"DROPBOX\",\n      \"BOX\",\n      \"GOOGLE_DRIVE\",\n      \"GMAIL\",\n      \"EVERNOTE\"\n    ]\n  }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/users/:user_id"},"body":"","category":"561780c1488a011700dd2d39","createdAt":"2015-10-09T09:08:23.967Z","excerpt":"Used to get details on a specific user","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"get-details-of-a-user","sync_unique":"","title":"Get (details of a user)","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getGet (details of a user)

Used to get details on a specific user


User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5617823c4d9e4a17002a0e1f","api":{"examples":{"codes":[{"language":"json","code":"{\n  \"first_name\": \"Bastien\",\n  \"last_name\": \"Pruvost\",\n  \"email\": \"bastmanman13@man.com\"\n}","name":""}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 4356,\n  \"first_name\": \"Bastien\",\n  \"last_name\": \"Pruvost\",\n  \"email\": \"tilkee@tilkee.com\",\n  \"cell_phone_number\": null,\n  \"phone_number\": null,\n  \"contact_email\": \"tilkee@tilkee.com\",\n  \"should_receive_emails\": true,\n  \"level_id\": 3,\n  \"devices\": [],\n  \"rights\": [\n    \"show_project_if_assigned\",\n    \"create_project\",\n    \"archive_project_if_assigned\",\n    \"duplicate_project_if_assigned\",\n    \"delete_project_if_assigned\",\n    \"edit_project_if_assigned\",\n    \"add_document_if_assigned\",\n    \"add_token_if_assigned\",\n    \"archive_token_if_assigned\",\n    \"assign_user_if_assigned\",\n    \"unassign_user_if_assigned\",\n    \"change_leadership_if_assigned\",\n    \"show_stats_if_assigned\",\n    \"delete_file_from_library_if_only_i_use_it\",\n    \"export_projects\",\n    \"delete_document_if_assigned\",\n    \"edit_document_if_assigned\",\n    \"manage_toc_if_only_i_use_it\",\n    \"manage_external_access\",\n    \"access_all_items\",\n    \"archive_project\"\n  ],\n  \"is_owner\": false,\n  \"is_orange_user\": false,\n  \"locale\": \"en\",\n  \"should_receive_connexion_email\": true,\n  \"frequency_proposal_sumup_email\": 7,\n  \"position\": null,\n  \"avatar\": null,\n  \"linkedin_account_url\": \"\",\n  \"twitter_account_url\": \"\",\n  \"facebook_account_url\": \"\",\n  \"last_sign_in_at\": 0,\n  \"location\": null,\n  \"company\": {\n    \"id\": 3260,\n    \"name\": null,\n    \"users_to_charge_counter\": 3,\n    \"have_yousign\": false,\n    \"have_management\": false,\n    \"subdomain\": \"api\",\n    \"domain\": \"tilk.us\",\n    \"customer_type\": null,\n    \"has_custom_branding\": false,\n    \"company_rights\": [\n      \"integration_gmail\",\n      \"acces_stats\",\n      \"can_modify_company\",\n      \"marque_blanche\",\n      \"can_create_project\",\n      \"acces_tilkee\",\n      \"files_import_services\",\n      \"download_option\",\n      \"end_date_option\",\n      \"team_gestion\",\n      \"templated_projects\"\n    ],\n    \"slimpay_url\": \"http://slimpay.tilkee.fr/subscribe/414c5442f78128577b4dc3aeb1eb7699\",\n    \"nb_employees\": 4,\n    \"has_proabono\": false,\n    \"has_to_pay\": 76,\n    \"has_to_pay_ttc\": 91.2,\n    \"plan\": {\n      \"id\": 66,\n      \"hex\": \"e08932\",\n      \"name\": \"Pro\",\n      \"mode\": 0,\n      \"trial_period\": 30,\n      \"monthly_fee\": 19,\n      \"created_at\": \"2015-03-19T18:02:20.276+01:00\",\n      \"updated_at\": \"2015-04-23T11:58:08.678+02:00\",\n      \"monthly_product_id\": 144852,\n      \"months\": 1,\n      \"per_user_product_id\": 144853,\n      \"per_user_fee\": 19,\n      \"max_users\": null,\n      \"max_active_projects\": null,\n      \"max_tokens_per_project\": null,\n      \"file_quota\": 5000,\n      \"features_set_id\": 2\n    },\n    \"slimpay_validated\": true,\n    \"filepicker_options\": [\n      \"COMPUTER\",\n      \"DROPBOX\",\n      \"BOX\",\n      \"GOOGLE_DRIVE\",\n      \"GMAIL\",\n      \"EVERNOTE\"\n    ]\n  },\n  \"status\": \"awaiting confirmation\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","auth":"required","params":[{"_id":"5617823c4d9e4a17002a0e22","required":true,"desc":"","default":"","type":"string","name":"first_name","in":"body"},{"_id":"5617823c4d9e4a17002a0e21","required":true,"desc":"","default":"","type":"string","name":"last_name","in":"body"},{"_id":"5617823c4d9e4a17002a0e20","required":true,"desc":"","default":"","type":"string","name":"email","in":"body"}],"url":"/users"},"body":"","category":"561780c1488a011700dd2d39","createdAt":"2015-10-09T09:00:44.172Z","editedParams":true,"editedParams2":true,"excerpt":"A collaborator is a Tilkee user. Every collaborator has a part and specific access on Tilkee. He can be administrator, manager or independent sales rep. \n\nUsed to add a new collaborator","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"create-collaborator","sync_unique":"","title":"Create collaborator","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postCreate collaborator

A collaborator is a Tilkee user. Every collaborator has a part and specific access on Tilkee. He can be administrator, manager or independent sales rep. Used to add a new collaborator

Body JSON

first_name:
required
string
last_name:
required
string
email:
required
string

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":1,"_id":"561785f98213e91700a0a027","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n  \"first_name\": \"MARC\",\n  \"last_name\": \"TEST\",\n  \"superior\": {\n        \"id\": 1234\n    }\n  \n}","name":""}]},"params":[{"_id":"561785f98213e91700a0a035","ref":"","required":false,"desc":"","default":"","type":"string","name":"first_name","in":"body"},{"_id":"561785f98213e91700a0a034","ref":"","required":false,"desc":"","default":"","type":"string","name":"last_name","in":"body"},{"_id":"561785f98213e91700a0a033","ref":"","required":false,"desc":"","default":"","type":"string","name":"email","in":"body"},{"_id":"561785f98213e91700a0a032","ref":"","required":false,"desc":"","default":"","type":"string","name":"phone_number","in":"body"},{"_id":"561785f98213e91700a0a031","ref":"","required":false,"desc":"","default":"","type":"string","name":"cell_phone_number","in":"body"},{"_id":"561785f98213e91700a0a030","ref":"","required":false,"desc":"","default":"","type":"string","name":"contact_email","in":"body"},{"_id":"561785f98213e91700a0a02f","ref":"","required":false,"desc":"","default":"","type":"string","name":"should_receive_emails","in":"body"},{"_id":"561785f98213e91700a0a02e","ref":"","required":false,"desc":"","default":"","type":"string","name":"level_id","in":"body"},{"_id":"561785f98213e91700a0a02d","ref":"","required":false,"desc":"","default":"","type":"array_string","name":"devices","in":"body"},{"_id":"561785f98213e91700a0a02c","ref":"","required":false,"desc":"","default":"","type":"string","name":"locale","in":"body"},{"_id":"561785f98213e91700a0a02b","ref":"","required":false,"desc":"","default":"","type":"string","name":"should_receive_connexion_email","in":"body"},{"_id":"561785f98213e91700a0a02a","ref":"","required":false,"desc":"","default":"","type":"string","name":"frequency_proposal_sumup_email","in":"body"},{"_id":"561785f98213e91700a0a029","ref":"","required":false,"desc":"","default":"","type":"string","name":"proposal_sumup_sent_at","in":"body"},{"_id":"561785f98213e91700a0a028","ref":"","required":false,"desc":"","default":"","type":"object","name":"location","in":"body"},{"_id":"56f427b354c3ff2000533fda","ref":"","required":false,"desc":"ID of manager","default":"","type":"int","name":"superior.id","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 4206,\n  \"first_name\": \"MARC\",\n  \"last_name\": \"TEST\",\n  \"full_name\": \"MARC TEST\",\n  \"email\": \"mtest@tilkee.fr\",\n  \"cell_phone_number\": \"000000\",\n  \"phone_number\": null,\n  \"contact_email\": \"mtest@tilkee.fr\"\",\n  \"should_receive_emails\": true,\n  \"level_id\": 3,\n  \"devices\": [],\n  \"rights\": [\n    \"show_project_if_assigned\",\n    \"create_project\",\n    \"archive_project_if_assigned\",\n    \"duplicate_project_if_assigned\",\n    \"delete_project_if_assigned\",\n    \"edit_project_if_assigned\",\n    \"add_document_if_assigned\",\n    \"add_token_if_assigned\",\n    \"archive_token_if_assigned\",\n    \"assign_user_if_assigned\",\n    \"unassign_user_if_assigned\",\n    \"change_leadership_if_assigned\",\n    \"show_stats_if_assigned\",\n    \"delete_file_from_library_if_only_i_use_it\",\n    \"export_projects\",\n    \"delete_document_if_assigned\",\n    \"edit_document_if_assigned\",\n    \"manage_toc_if_only_i_use_it\",\n    \"manage_external_access\",\n    \"access_all_items\",\n    \"archive_project\"\n  ],\n  \"is_owner\": false,\n  \"can_see_stats\": false,\n  \"is_orange_user\": false,\n  \"locale\": \"fr\",\n  \"should_receive_connexion_email\": true,\n  \"frequency_proposal_sumup_email\": 7,\n  \"position\": null,\n  \"avatar\": null,\n  \"linkedin_account_url\": \"\",\n  \"twitter_account_url\": \"\",\n  \"facebook_account_url\": \"\",\n  \"last_sign_in_at\": 1458837490,\n  \"location\": null,\n  \"company\": {\n    \"id\": 127543,\n    \"name\": \"Tilkee\",\n    \"users_to_charge_counter\": 26,\n    \"have_yousign\": true,\n    \"have_management\": true,\n    \"subdomain\": \"tilkee\",\n    \"domain\": \"proposition-commerciale.fr\",\n    \"customer_type\": \"\",\n    \"has_custom_branding\": false,\n    \"company_rights\": [\n      \"nb_users\",\n      \"marque_blanche\",\n      \"can_create_project\",\n      \"yousign\",\n      \"collaborators_management\",\n      \"support_complet\",\n      \"full_access\",\n      \"themes_management\",\n      \"download_option\",\n      \"dashboard\",\n      \"end_date_option\",\n      \"team_gestion\",\n      \"templated_projects\",\n      \"detailed_stats\",\n      \"crm_integration\",\n      \"api_access\",\n      \"all_filepicker_options\",\n      \"integration_gmail\"\n    ],\n    \"nb_employees\": 27,\n    \"has_proabono\": true,\n    \"subscription_has_payment\": true,\n    \"subscription_segment\": \"eu\",\n    \"slimpay_validated\": true,\n    \"location\": null\n  },\n  \"superior\": {\n    \"id\": 1234,\n    \"first_name\": \"Christophe\",\n    \"last_name\": \"test\",\n    \"full_name\": \"Christophe test\",\n    \"email\": \"ctest@tilkee.fr\"\n  }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/users/:user_id?with_superior=true"},"body":"","category":"561780c1488a011700dd2d39","createdAt":"2015-10-09T09:16:41.176Z","editedParams":true,"editedParams2":true,"excerpt":"Used to update user's settings","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"edit","sync_unique":"","title":"Edit","type":"put","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

putEdit

Used to update user's settings

Body JSON

first_name:
string
last_name:
string
email:
string
phone_number:
string
cell_phone_number:
string
contact_email:
string
should_receive_emails:
string
level_id:
string
devices:
array of strings
locale:
string
should_receive_connexion_email:
string
frequency_proposal_sumup_email:
string
proposal_sumup_sent_at:
string
location:
object
superior.id:
integer
ID of manager

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":1,"_id":"5617877b6d4d760d003e2e8b","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"null","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/users/:user_id"},"body":"","category":"561780c1488a011700dd2d39","createdAt":"2015-10-09T09:23:07.796Z","excerpt":"Permanently deletes a specific user","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"delete-5","sync_unique":"","title":"Delete","type":"delete","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

deleteDelete

Permanently deletes a specific user


User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5639db483539050d000821b0","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"A company is the enterprise in which all employees are attached","category":"56163d8521e9110d00780302","createdAt":"2015-11-04T10:17:44.719Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"what-is-it-5","sync_unique":"","title":"What  is it ?","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

What is it ?


A company is the enterprise in which all employees are attached
A company is the enterprise in which all employees are attached
{"__v":4,"_id":"56164485bb557f0d00056f4a","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 3712,\n  \"name\": null,\n  \"users_to_charge_counter\": 1,\n  \"have_yousign\": false,\n  \"have_management\": false,\n  \"subdomain\": \"api\",\n  \"domain\": \"tilkee.com\",\n  \"customer_type\": null,\n  \"has_custom_branding\": false,\n  \"company_rights\": [\n    \"full_access\",\n    \"support_base\",\n    \"can_create_project\",\n    \"collaborators_management\",\n    \"all_filepicker_options\",\n    \"templated_projects\",\n    \"end_date_option\",\n    \"download_option\",\n    \"marque_blanche\",\n    \"integration_gmail\",\n    \"nb_users\"\n  ],\n  \"slimpay_url\": \"\",\n  \"nb_employees\": 2,\n  \"has_proabono\": true,\n  \"slimpay_validated\": true,\n  \"location\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/companies/:company_id"},"body":"Note :Put \"mine\" as an ID to get your company","category":"56163d8521e9110d00780302","createdAt":"2015-10-08T10:25:09.851Z","excerpt":"Use this command to show your company info","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"show-your-info","sync_unique":"","title":"Show your info","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getShow your info

Use this command to show your company info

Note :Put "mine" as an ID to get your company

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Note :Put "mine" as an ID to get your company
{"__v":2,"_id":"561644e5bb557f0d00056f4c","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n  \"name\": \"company name\",\n  \"email\": \"example@gmail.com\",\n  \"subdomain\": \"joseph\",\n  \"domain\": \"proposition-commerciale.fr\",\n  \"customer_type\": null\n}","name":""}]},"params":[{"_id":"5617cc3aa410c90d00c61346","required":false,"desc":"","default":"","type":"string","name":"name","in":"body"},{"_id":"5617cc3aa410c90d00c61345","required":false,"desc":"","default":"","type":"string","name":"custom_domain","in":"body"},{"_id":"5617cc3aa410c90d00c61344","required":false,"desc":"","default":"","type":"string","name":"customer_type","in":"body"},{"_id":"5617cc3aa410c90d00c61343","required":false,"desc":"","default":"","type":"object","name":"location","in":"body"},{"_id":"5617cc3aa410c90d00c61342","required":false,"desc":"","default":"","type":"int","name":"location[id]","in":"body"},{"_id":"5617cfe86d4d760d003e2eff","required":false,"desc":"","default":"","type":"string","name":"location[address]","in":"body"},{"_id":"5617cfe86d4d760d003e2efe","required":false,"desc":"","default":"","type":"string","name":"location[postal_code]","in":"body"},{"_id":"5617cfe86d4d760d003e2efd","required":false,"desc":"","default":"","type":"string","name":"location[city]","in":"body"},{"_id":"5617cfe86d4d760d003e2efc","required":false,"desc":"","default":"","type":"string","name":"location[country]","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 3712,\n  \"name\": \"company name\",\n  \"users_to_charge_counter\": 1,\n  \"have_yousign\": false,\n  \"have_management\": false,\n  \"subdomain\": \"joseph\",\n  \"domain\": \"proposition-commerciale.fr\",\n  \"customer_type\": null,\n  \"has_custom_branding\": false,\n  \"company_rights\": [\n    \"full_access\",\n    \"support_base\",\n    \"can_create_project\",\n    \"collaborators_management\",\n    \"all_filepicker_options\",\n    \"templated_projects\",\n    \"end_date_option\",\n    \"download_option\",\n    \"marque_blanche\",\n    \"integration_gmail\",\n    \"nb_users\"\n  ],\n  \"slimpay_url\": \"\",\n  \"nb_employees\": 2,\n  \"has_proabono\": true,\n  \"slimpay_validated\": true\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/companies/:id"},"body":"","category":"56163d8521e9110d00780302","createdAt":"2015-10-08T10:26:45.451Z","editedParams":true,"editedParams2":true,"excerpt":"Used to update your company info","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"update-1","sync_unique":"","title":"Update","type":"put","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

putUpdate

Used to update your company info

Body JSON

name:
string
custom_domain:
string
customer_type:
string
location:
object
location[id]:
integer
location[address]:
string
location[postal_code]:
string
location[city]:
string
location[country]:
string

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"5639da55d25e8919005f3e4f","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"body":"A connection is an access to a created project","category":"561657e2a6767c0d001669dd","createdAt":"2015-11-04T10:13:41.315Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"what-is-it","sync_unique":"","title":"What is it ?","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

What is it ?


A connection is an access to a created project
A connection is an access to a created project
{"__v":0,"_id":"5616599621e9110d0078031a","api":{"auth":"required","examples":{"codes":[]},"params":[{"_id":"5616599621e9110d00780321","default":"","desc":"Comma-separated list of token ids to filter","in":"query","name":"tokens","ref":"","required":false,"type":"string"},{"_id":"5616599621e9110d00780320","default":"","desc":"timestamp of start limit","in":"query","name":"start_date","ref":"","required":false,"type":"string"},{"_id":"5616599621e9110d0078031f","default":"","desc":"timestamp of end limit","in":"query","name":"end_date","ref":"","required":false,"type":"string"},{"_id":"5616599621e9110d0078031e","default":"","desc":"search string to filter the results","in":"query","name":"search","ref":"","required":false,"type":"string"},{"_id":"5616599621e9110d0078031d","default":"","desc":"number of objects to returns","in":"query","name":"limit","ref":"","required":false,"type":"string"},{"_id":"5616599621e9110d0078031c","default":"","desc":"number of objects to skip from start","in":"query","name":"offset","ref":"","required":false,"type":"string"},{"_id":"5616599621e9110d0078031b","default":"","desc":"name of the field to order by, separated by commas and preceded by - if descending","in":"query","name":"sort","ref":"","required":false,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"search\": null,\n  \"limit\": 50,\n  \"offset\": 0,\n  \"order\": \"-connexions.created_at\",\n  \"total\": 2,\n  \"contents\": [\n    {\n      \"id\": 130735,\n      \"title\": \"Test2\",\n      \"access_date\": \"2015-11-18T10:12:44.212+01:00\",\n      \"fully_charged\": \"2015-11-18T10:12:46.315+01:00\",\n      \"data_present\": true,\n      \"total_time\": 11810,\n      \"percentage_read\": 73,\n      \"downloaded\": false,\n      \"signed\": false,\n      \"in_progress\": false,\n      \"platform\": {\n        \"device_type\": \"Computer\",\n        \"device_number\": 1,\n        \"ip\": \"109.190.141.XXX\",\n        \"location\": \"Lyon, France\",\n        \"os\": \"Windows\",\n        \"browser\": \"Chrome\"\n      },\n      \"token_id\": 130943,\n      \"project\": {\n        \"id\": 37878,\n        \"name\": \"Titre du projet\",\n        \"created_at\": \"2015-11-18T10:04:28.691+01:00\",\n        \"updated_at\": \"2015-11-18T10:10:15.524+01:00\",\n        \"archived_at\": null,\n        \"status\": \"activated\",\n        \"won\": \"na\",\n        \"is_template\": false,\n        \"can_be_downloaded\": true,\n        \"preview\": \"https://api-beta2.tilkee.com/projects/37878/preview?signature=WV4LCPEsiMEiQhcYrmmRmXBuMfuQOsJRCfTkrG2XFGs%3D%0A\",\n        \"is_or_was_signable\": false,\n        \"last_sign_in_at\": \"2015-11-18T10:12:44.212+01:00\",\n        \"signed\": false,\n        \"collaborators_count\": null\n      }\n    },\n    {\n      \"id\": 130732,\n      \"title\": \"Test 1\",\n      \"access_date\": \"2015-11-18T10:10:26.629+01:00\",\n      \"fully_charged\": \"2015-11-18T10:10:37.712+01:00\",\n      \"data_present\": true,\n      \"total_time\": 29338,\n      \"percentage_read\": 73,\n      \"downloaded\": false,\n      \"signed\": false,\n      \"in_progress\": false,\n      \"platform\": {\n        \"device_type\": \"Computer\",\n        \"device_number\": 1,\n        \"ip\": \"109.190.141.XXX\",\n        \"location\": \"Lyon, France\",\n        \"os\": \"Windows\",\n        \"browser\": \"Chrome\"\n      },\n      \"token_id\": 130944,\n      \"project\": {\n        \"id\": 37878,\n        \"name\": \"Titre du projet\",\n        \"created_at\": \"2015-11-18T10:04:28.691+01:00\",\n        \"updated_at\": \"2015-11-18T10:10:15.524+01:00\",\n        \"archived_at\": null,\n        \"status\": \"activated\",\n        \"won\": \"na\",\n        \"is_template\": false,\n        \"can_be_downloaded\": true,\n        \"preview\": \"https://api-beta2.tilkee.com/projects/37878/preview?signature=WV4LCPEsiMEiQhcYrmmRmXBuMfuQOsJRCfTkrG2XFGs%3D%0A\",\n        \"is_or_was_signable\": false,\n        \"last_sign_in_at\": \"2015-11-18T10:12:44.212+01:00\",\n        \"signed\": false,\n        \"collaborators_count\": null\n      }\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/connexions"},"body":"","category":"561657e2a6767c0d001669dd","createdAt":"2015-10-08T11:55:02.891Z","editedParams":true,"editedParams2":true,"excerpt":"Used to get the details of every connection for a user","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"list-of-connexions-for-a-user","sync_unique":"","title":"List of connections for a user","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getList of connections for a user

Used to get the details of every connection for a user

Query Params

tokens:
string
Comma-separated list of token ids to filter
start_date:
string
timestamp of start limit
end_date:
string
timestamp of end limit
search:
string
search string to filter the results
limit:
string
number of objects to returns
offset:
string
number of objects to skip from start
sort:
string
name of the field to order by, separated by commas and preceded by - if descending

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"56165a521651730d00504940","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 120693,\n  \"title\": \"test\",\n  \"access_date\": \"2015-10-15T14:30:36.544+02:00\",\n  \"fully_charged\": \"2015-10-15T14:30:44.464+02:00\",\n  \"data_present\": true,\n  \"total_time\": 29015,\n  \"percentage_read\": 100,\n  \"downloaded\": false,\n  \"signed\": false,\n  \"platform\": {\n    \"device_type\": \"Computer\",\n    \"device_number\": 1,\n    \"ip\": \"109.190.141.XXX\",\n    \"location\": null,\n    \"os\": \"Windows\",\n    \"browser\": \"Chrome\"\n  },\n  \"token_id\": 122856,\n  \"contents\": [\n    {\n      \"position\": 1,\n      \"title\": \"(a)P3-Offre_technique_et_financière\",\n      \"deleted_date\": null,\n      \"total_time\": 29015,\n      \"downloaded\": null,\n      \"pages\": [\n        {\n          \"id\": 367819,\n          \"created_at\": \"2015-10-15T14:31:12.576+02:00\",\n          \"updated_at\": \"2015-10-15T14:31:12.576+02:00\",\n          \"item_tracker_id\": 368085,\n          \"page\": 1,\n          \"time\": 29016\n        }\n      ]\n    },\n    {\n      \"position\": 2,\n      \"title\": \"(a)P3-Offre_technique_et_financière\",\n      \"deleted_date\": null,\n      \"total_time\": 0,\n      \"downloaded\": null,\n      \"pages\": []\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/connexions/:connexion_id"},"body":"","category":"561657e2a6767c0d001669dd","createdAt":"2015-10-08T11:58:10.666Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"details-of-a-connexion","sync_unique":"","title":"Details of a connection","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getDetails of a connection



User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":5,"_id":"563a11a8c47c3f0d009b5286","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"The concept of a WebHook is simple. A WebHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST.\n \nA web application implementing WebHooks will POST a message to a URL when certain things happen\n\nWe currently support 4 different webhooks:\n- ConnexionStart: start of connection\n- ConnexionEnd: end of connection\n- Signature: signature of a project\n- ArchiveProject: archive of a project\n- Token: creation of an access (Tilk)\n\nExemple of ConnexionEnd webhook:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\\"web_type\\\":\\\"ConnexionEnd\\\",\\\"project\\\":{\\\"id\\\":53063,\\\"name\\\":\\\"Tilkee - TEST\\\",\\\"total_time\\\":53,\\\"downloaded\\\":false,\\\"connexion_count\\\":1,\\\"avg_time\\\":26,\\\"avg_user_acces\\\":1.0,\\\"platform_ids\\\":1,\\\"archived_at\\\":null,\\\"most_visited_title\\\":\\\"Detailed informations\\\",\\\"most_visited_time\\\":46667,\\\"external_id\\\":null},\\\"token\\\":{\\\"id\\\":363509,\\\"name\\\":\\\"Name\\\",\\\"project_name\\\":\\\"Tilkee Test\\\",\\\"url\\\":\\\"https://presentation.tilkee.com/v/37503a0rfr\\\",\\\"won\\\":null,\\\"created_at\\\":\\\"2016-05-10T17:25:34.513+02:00\\\",\\\"archived_at\\\":null,\\\"signed\\\":false,\\\"downloaded\\\":false,\\\"connexion_count\\\":1,\\\"total_time\\\":53,\\\"percentage_read\\\":87,\\\"interest\\\":2.5,\\\"most_visited_title\\\":\\\"Detailed informations\\\",\\\"most_visited_time\\\":46667,\\\"external_id\\\":null},\\\"connexion\\\":{\\\"id\\\":185550,\\\"title\\\":\\\"Name\\\",\\\"access_date\\\":\\\"2016-05-10T17:25:39.419+02:00\\\",\\\"total_time\\\":53,\\\"percentage_read\\\":87,\\\"downloaded\\\":false,\\\"item_trackers\\\":[{\\\"id\\\":612658,\\\"title\\\":\\\"Detailed informations\\\",\\\"deleted_date\\\":null,\\\"total_time\\\":46667,\\\"\\n downloaded\\\":null,\\\"pages\\\":[{\\\"id\\\":1105240,\\\"created_at\\\":\\\"2016-05-10T17:26:20.270+02:00\\\",\\\"updated_at\\\":\\\"2016-05-10T17:26:20.270+02:00\\\",\\\"item_tracker_id\\\":612658,\\\"page\\\":1,\\\"time\\\":37098},{\\\"id\\\":1105241,\\\"created_at\\\":\\\"2016-05-10T17:26:20.664+02:00\\\",\\\"updated_at\\\":\\\"2016-05-10T17:26:20.664+02:00\\\",\\\"item_tracker_id\\\":612658,\\\"page\\\":2,\\\"time\\\":400},{\\\"id\\\":1105242,\\\"created_at\\\":\\\"2016-05-10T17:26:22.502+02:00\\\",\\\"updated_at\\\":\\\"2016-05-10T17:26:22.502+02:00\\\",\\\"item_tracker_id\\\":612658,\\\"page\\\":3,\\\"time\\\":1813},{\\\"id\\\":1105244,\\\"created_at\\\":\\\"2016-05-10T17:26:25.398+02:00\\\",\\\"updated_at\\\":\\\"2016-05-10T17:26:25.398+02:00\\\",\\\"item_tracker_id\\\":612658,\\\"page\\\":4,\\\"time\\\":2914},{\\\"id\\\":1105248,\\\"created_at\\\":\\\"2016-05-10T17:26:27.751+02:00\\\",\\\"updated_at\\\":\\\"2016-05-10T17:26:27.751+02:00\\\",\\\"item_tracker_id\\\":612658,\\\"page\\\":5,\\\"time\\\":2347},{\\\"id\\\":1105249,\\\"created_at\\\":\\\"2016-05-10T17:26:29.857+02:00\\\",\\\"updated_at\\\":\\\"2016-05-10T17:26:29.857+02:00\\\",\\\"item_tracker_id\\\":612658,\\\"page\\\":6,\\\"time\\\":2095}]},{\\\"id\\\":612665,\\\"title\\\":\\\"Prices\\\",\\\"deleted_date\\\":null,\\\"tota\\n l_time\\\":7275,\\\"downloaded\\\":null,\\\"pages\\\":[{\\\"id\\\":1105250,\\\"created_at\\\":\\\"2016-05-10T17:26:31.585+02:00\\\",\\\"updated_at\\\":\\\"2016-05-10T17:26:31.585+02:00\\\",\\\"item_tracker_id\\\":612665,\\\"page\\\":1,\\\"time\\\":1721},{\\\"id\\\":1105253,\\\"created_at\\\":\\\"2016-05-10T17:26:33.573+02:00\\\",\\\"updated_at\\\":\\\"2016-05-10T17:26:33.573+02:00\\\",\\\"item_tracker_id\\\":612665,\\\"page\\\":2,\\\"time\\\":2017},{\\\"id\\\":1105258,\\\"created_at\\\":\\\"2016-05-10T17:26:37.129+02:00\\\",\\\"updated_at\\\":\\\"2016-05-10T17:26:37.129+02:00\\\",\\\"item_tracker_id\\\":612665,\\\"page\\\":1,\\\"time\\\":3537}]}],\\\"most_visited_title\\\":\\\"Detailed informations\\\",\\\"most_visited_time\\\":46667}}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nExemple of Signature webhook:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\\"web_type\\\":\\\"Signature\\\",\\\"project\\\":{\\\"id\\\":4157,\\\"name\\\":\\\"Annonciade\\\",\\\"archived_at\\\":null},\\\"token\\\":{\\\"id\\\":139213,\\\"name\\\":\\\"Annonciade\\\",\\\"project_name\\\":\\\"Annonciade\\\",\\\"url\\\":\\\"https://presentation.tilkee.com/v/094fcb26ER\\\",\\\"won\\\":null,\\\"created_at\\\":\\\"2015-12-23T11:13:28.687+01:00\\\",\\\"archived_at\\\":null},\\\"ys_token\\\":{\\\"iddemande\\\":49596,\\\"ystoken\\\":\\\"fvj1aIr1gLSd1EZzULK4O6n8kjUX2tn4\\\",\\\"phone\\\":\\\"+3368400000\\\",\\\"status\\\":\\\"signed_complete\\\",\\\"connexion_success_id\\\":141793,\\\"signed_docs\\\":[{\\\"Reglement interieur-Mondocteur-signed.pdf\\\":\\\"https://datatlk.s3-eu-west-1.amazonaws.com/uploads/direct/d46730bf79275079/Mondoc.pdf\\\"},{\\\"CMD - MonDoc-signed.pdf\\\":\\\"https://datatlk.s3-eu-west-1.amazonaws.com/uploads/direct/5002760aa814712dsvv/CMD - MonDoc v2.pdf\\\"}]}}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","category":"561787cf6d4d760d003e2e8d","createdAt":"2015-11-04T14:09:44.419Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"what-is-it-9","sync_unique":"","title":"What is it ?","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

What is it ?


The concept of a WebHook is simple. A WebHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST. A web application implementing WebHooks will POST a message to a URL when certain things happen We currently support 4 different webhooks: - ConnexionStart: start of connection - ConnexionEnd: end of connection - Signature: signature of a project - ArchiveProject: archive of a project - Token: creation of an access (Tilk) Exemple of ConnexionEnd webhook: [block:code] { "codes": [ { "code": "{\"web_type\":\"ConnexionEnd\",\"project\":{\"id\":53063,\"name\":\"Tilkee - TEST\",\"total_time\":53,\"downloaded\":false,\"connexion_count\":1,\"avg_time\":26,\"avg_user_acces\":1.0,\"platform_ids\":1,\"archived_at\":null,\"most_visited_title\":\"Detailed informations\",\"most_visited_time\":46667,\"external_id\":null},\"token\":{\"id\":363509,\"name\":\"Name\",\"project_name\":\"Tilkee Test\",\"url\":\"https://presentation.tilkee.com/v/37503a0rfr\",\"won\":null,\"created_at\":\"2016-05-10T17:25:34.513+02:00\",\"archived_at\":null,\"signed\":false,\"downloaded\":false,\"connexion_count\":1,\"total_time\":53,\"percentage_read\":87,\"interest\":2.5,\"most_visited_title\":\"Detailed informations\",\"most_visited_time\":46667,\"external_id\":null},\"connexion\":{\"id\":185550,\"title\":\"Name\",\"access_date\":\"2016-05-10T17:25:39.419+02:00\",\"total_time\":53,\"percentage_read\":87,\"downloaded\":false,\"item_trackers\":[{\"id\":612658,\"title\":\"Detailed informations\",\"deleted_date\":null,\"total_time\":46667,\"\n downloaded\":null,\"pages\":[{\"id\":1105240,\"created_at\":\"2016-05-10T17:26:20.270+02:00\",\"updated_at\":\"2016-05-10T17:26:20.270+02:00\",\"item_tracker_id\":612658,\"page\":1,\"time\":37098},{\"id\":1105241,\"created_at\":\"2016-05-10T17:26:20.664+02:00\",\"updated_at\":\"2016-05-10T17:26:20.664+02:00\",\"item_tracker_id\":612658,\"page\":2,\"time\":400},{\"id\":1105242,\"created_at\":\"2016-05-10T17:26:22.502+02:00\",\"updated_at\":\"2016-05-10T17:26:22.502+02:00\",\"item_tracker_id\":612658,\"page\":3,\"time\":1813},{\"id\":1105244,\"created_at\":\"2016-05-10T17:26:25.398+02:00\",\"updated_at\":\"2016-05-10T17:26:25.398+02:00\",\"item_tracker_id\":612658,\"page\":4,\"time\":2914},{\"id\":1105248,\"created_at\":\"2016-05-10T17:26:27.751+02:00\",\"updated_at\":\"2016-05-10T17:26:27.751+02:00\",\"item_tracker_id\":612658,\"page\":5,\"time\":2347},{\"id\":1105249,\"created_at\":\"2016-05-10T17:26:29.857+02:00\",\"updated_at\":\"2016-05-10T17:26:29.857+02:00\",\"item_tracker_id\":612658,\"page\":6,\"time\":2095}]},{\"id\":612665,\"title\":\"Prices\",\"deleted_date\":null,\"tota\n l_time\":7275,\"downloaded\":null,\"pages\":[{\"id\":1105250,\"created_at\":\"2016-05-10T17:26:31.585+02:00\",\"updated_at\":\"2016-05-10T17:26:31.585+02:00\",\"item_tracker_id\":612665,\"page\":1,\"time\":1721},{\"id\":1105253,\"created_at\":\"2016-05-10T17:26:33.573+02:00\",\"updated_at\":\"2016-05-10T17:26:33.573+02:00\",\"item_tracker_id\":612665,\"page\":2,\"time\":2017},{\"id\":1105258,\"created_at\":\"2016-05-10T17:26:37.129+02:00\",\"updated_at\":\"2016-05-10T17:26:37.129+02:00\",\"item_tracker_id\":612665,\"page\":1,\"time\":3537}]}],\"most_visited_title\":\"Detailed informations\",\"most_visited_time\":46667}}", "language": "json" } ] } [/block] Exemple of Signature webhook: [block:code] { "codes": [ { "code": "{\"web_type\":\"Signature\",\"project\":{\"id\":4157,\"name\":\"Annonciade\",\"archived_at\":null},\"token\":{\"id\":139213,\"name\":\"Annonciade\",\"project_name\":\"Annonciade\",\"url\":\"https://presentation.tilkee.com/v/094fcb26ER\",\"won\":null,\"created_at\":\"2015-12-23T11:13:28.687+01:00\",\"archived_at\":null},\"ys_token\":{\"iddemande\":49596,\"ystoken\":\"fvj1aIr1gLSd1EZzULK4O6n8kjUX2tn4\",\"phone\":\"+3368400000\",\"status\":\"signed_complete\",\"connexion_success_id\":141793,\"signed_docs\":[{\"Reglement interieur-Mondocteur-signed.pdf\":\"https://datatlk.s3-eu-west-1.amazonaws.com/uploads/direct/d46730bf79275079/Mondoc.pdf\"},{\"CMD - MonDoc-signed.pdf\":\"https://datatlk.s3-eu-west-1.amazonaws.com/uploads/direct/5002760aa814712dsvv/CMD - MonDoc v2.pdf\"}]}}", "language": "json" } ] } [/block]
The concept of a WebHook is simple. A WebHook is an HTTP callback: an HTTP POST that occurs when something happens; a simple event-notification via HTTP POST. A web application implementing WebHooks will POST a message to a URL when certain things happen We currently support 4 different webhooks: - ConnexionStart: start of connection - ConnexionEnd: end of connection - Signature: signature of a project - ArchiveProject: archive of a project - Token: creation of an access (Tilk) Exemple of ConnexionEnd webhook: [block:code] { "codes": [ { "code": "{\"web_type\":\"ConnexionEnd\",\"project\":{\"id\":53063,\"name\":\"Tilkee - TEST\",\"total_time\":53,\"downloaded\":false,\"connexion_count\":1,\"avg_time\":26,\"avg_user_acces\":1.0,\"platform_ids\":1,\"archived_at\":null,\"most_visited_title\":\"Detailed informations\",\"most_visited_time\":46667,\"external_id\":null},\"token\":{\"id\":363509,\"name\":\"Name\",\"project_name\":\"Tilkee Test\",\"url\":\"https://presentation.tilkee.com/v/37503a0rfr\",\"won\":null,\"created_at\":\"2016-05-10T17:25:34.513+02:00\",\"archived_at\":null,\"signed\":false,\"downloaded\":false,\"connexion_count\":1,\"total_time\":53,\"percentage_read\":87,\"interest\":2.5,\"most_visited_title\":\"Detailed informations\",\"most_visited_time\":46667,\"external_id\":null},\"connexion\":{\"id\":185550,\"title\":\"Name\",\"access_date\":\"2016-05-10T17:25:39.419+02:00\",\"total_time\":53,\"percentage_read\":87,\"downloaded\":false,\"item_trackers\":[{\"id\":612658,\"title\":\"Detailed informations\",\"deleted_date\":null,\"total_time\":46667,\"\n downloaded\":null,\"pages\":[{\"id\":1105240,\"created_at\":\"2016-05-10T17:26:20.270+02:00\",\"updated_at\":\"2016-05-10T17:26:20.270+02:00\",\"item_tracker_id\":612658,\"page\":1,\"time\":37098},{\"id\":1105241,\"created_at\":\"2016-05-10T17:26:20.664+02:00\",\"updated_at\":\"2016-05-10T17:26:20.664+02:00\",\"item_tracker_id\":612658,\"page\":2,\"time\":400},{\"id\":1105242,\"created_at\":\"2016-05-10T17:26:22.502+02:00\",\"updated_at\":\"2016-05-10T17:26:22.502+02:00\",\"item_tracker_id\":612658,\"page\":3,\"time\":1813},{\"id\":1105244,\"created_at\":\"2016-05-10T17:26:25.398+02:00\",\"updated_at\":\"2016-05-10T17:26:25.398+02:00\",\"item_tracker_id\":612658,\"page\":4,\"time\":2914},{\"id\":1105248,\"created_at\":\"2016-05-10T17:26:27.751+02:00\",\"updated_at\":\"2016-05-10T17:26:27.751+02:00\",\"item_tracker_id\":612658,\"page\":5,\"time\":2347},{\"id\":1105249,\"created_at\":\"2016-05-10T17:26:29.857+02:00\",\"updated_at\":\"2016-05-10T17:26:29.857+02:00\",\"item_tracker_id\":612658,\"page\":6,\"time\":2095}]},{\"id\":612665,\"title\":\"Prices\",\"deleted_date\":null,\"tota\n l_time\":7275,\"downloaded\":null,\"pages\":[{\"id\":1105250,\"created_at\":\"2016-05-10T17:26:31.585+02:00\",\"updated_at\":\"2016-05-10T17:26:31.585+02:00\",\"item_tracker_id\":612665,\"page\":1,\"time\":1721},{\"id\":1105253,\"created_at\":\"2016-05-10T17:26:33.573+02:00\",\"updated_at\":\"2016-05-10T17:26:33.573+02:00\",\"item_tracker_id\":612665,\"page\":2,\"time\":2017},{\"id\":1105258,\"created_at\":\"2016-05-10T17:26:37.129+02:00\",\"updated_at\":\"2016-05-10T17:26:37.129+02:00\",\"item_tracker_id\":612665,\"page\":1,\"time\":3537}]}],\"most_visited_title\":\"Detailed informations\",\"most_visited_time\":46667}}", "language": "json" } ] } [/block] Exemple of Signature webhook: [block:code] { "codes": [ { "code": "{\"web_type\":\"Signature\",\"project\":{\"id\":4157,\"name\":\"Annonciade\",\"archived_at\":null},\"token\":{\"id\":139213,\"name\":\"Annonciade\",\"project_name\":\"Annonciade\",\"url\":\"https://presentation.tilkee.com/v/094fcb26ER\",\"won\":null,\"created_at\":\"2015-12-23T11:13:28.687+01:00\",\"archived_at\":null},\"ys_token\":{\"iddemande\":49596,\"ystoken\":\"fvj1aIr1gLSd1EZzULK4O6n8kjUX2tn4\",\"phone\":\"+3368400000\",\"status\":\"signed_complete\",\"connexion_success_id\":141793,\"signed_docs\":[{\"Reglement interieur-Mondocteur-signed.pdf\":\"https://datatlk.s3-eu-west-1.amazonaws.com/uploads/direct/d46730bf79275079/Mondoc.pdf\"},{\"CMD - MonDoc-signed.pdf\":\"https://datatlk.s3-eu-west-1.amazonaws.com/uploads/direct/5002760aa814712dsvv/CMD - MonDoc v2.pdf\"}]}}", "language": "json" } ] } [/block]
{"__v":0,"_id":"561789d5488a011700dd2d45","api":{"examples":{"codes":[{"language":"json","code":"{\n  \"url\": \"https://www.test.com/\",\n  \"notifed_by_start\": false,\n  \"web_type\": \"Signature\",\n  \"entity_id\": 4076,\n  \"entity_type\": \"User\"\n\n}","name":""}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 236,\n  \"entity_id\": 4076,\n  \"entity_type\": \"User\",\n  \"url\": \"https://www.test.com/\",\n  \"created_at\": \"2015-10-09T11:32:43.370+02:00\",\n  \"updated_at\": \"2015-10-09T11:32:43.370+02:00\",\n  \"deleted_at\": null,\n  \"web_type\": \"Signature\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","auth":"required","params":[{"_id":"561789d5488a011700dd2d4a","required":false,"desc":"","default":"","type":"string","name":"url","in":"body"},{"_id":"561789d5488a011700dd2d49","required":false,"desc":"","default":"","type":"boolean","name":"notifed_by_start","in":"body"},{"_id":"561789d5488a011700dd2d48","required":false,"desc":"","default":"","type":"string","name":"web_type","in":"body"},{"_id":"561789d5488a011700dd2d47","required":false,"desc":"","default":"","type":"int","name":"entity_id","in":"body"},{"_id":"561789d5488a011700dd2d46","required":false,"desc":"","default":"","type":"string","name":"entity_type","in":"body"}],"url":"/webhooks"},"body":"","category":"561787cf6d4d760d003e2e8d","createdAt":"2015-10-09T09:33:09.078Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"create-4","sync_unique":"","title":"Create","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postCreate


Body JSON

url:
string
notifed_by_start:
boolean
web_type:
string
entity_id:
integer
entity_type:
string

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":1,"_id":"561788319d753b0d00343d85","api":{"auth":"required","params":[{"_id":"561788319d753b0d00343d88","required":false,"desc":"","default":"","type":"int","name":"limit","in":"query"},{"_id":"561788319d753b0d00343d87","required":false,"desc":"","default":"","type":"int","name":"offset","in":"query"},{"_id":"561788319d753b0d00343d86","required":false,"desc":"","default":"","type":"string","name":"order","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"search\": null,\n  \"limit\": null,\n  \"offset\": null,\n  \"total\": null,\n  \"order\": null,\n  \"contents\": [\n    {\n      \"id\": 133,\n      \"entity_id\": 4076,\n      \"entity_type\": \"User\",\n      \"url\": \"https://zapier.com/hooks/catch/3u0lfs/\",\n      \"created_at\": \"2015-09-16T16:18:51.125+02:00\",\n      \"updated_at\": \"2015-09-16T16:18:51.125+02:00\",\n      \"deleted_at\": null,\n      \"web_type\": \"ConnexionStart\"\n    },\n    {\n      \"id\": 140,\n      \"entity_id\": 4076,\n      \"entity_type\": \"User\",\n      \"url\": \"https://zapier.com/hooks/catch/34v8cw/\",\n      \"created_at\": \"2015-09-21T10:30:52.993+02:00\",\n      \"updated_at\": \"2015-09-21T10:30:52.993+02:00\",\n      \"deleted_at\": null,\n      \"web_type\": \"Token\"\n    },\n    {\n      \"id\": 141,\n      \"entity_id\": 4076,\n      \"entity_type\": \"User\",\n      \"url\": \"https://zapier.com/hooks/catch/34v8cw/\",\n      \"created_at\": \"2015-09-21T10:31:03.807+02:00\",\n      \"updated_at\": \"2015-09-21T10:31:03.807+02:00\",\n      \"deleted_at\": null,\n      \"web_type\": \"Signature\"\n    },\n    {\n      \"id\": 142,\n      \"entity_id\": 4076,\n      \"entity_type\": \"User\",\n      \"url\": \"https://zapier.com/hooks/catch/34v8cw/\",\n      \"created_at\": \"2015-09-21T10:31:10.493+02:00\",\n      \"updated_at\": \"2015-09-21T10:31:10.493+02:00\",\n      \"deleted_at\": null,\n      \"web_type\": \"ArchiveProject\"\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/webhooks"},"body":"","category":"561787cf6d4d760d003e2e8d","createdAt":"2015-10-09T09:26:09.774Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"list-5","sync_unique":"","title":"List","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getList


Query Params

limit:
integer
offset:
integer
order:
string

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":2,"_id":"5617b488a410c90d00c6130b","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n  \"url\": \"https://www.testupdated.com/\",\n  \"notifed_by_start\": true,\n  \"entity_id\": 4076,\n  \"entity_type\": \"User\"\n\n}","name":""}]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 236,\n  \"entity_id\": 4076,\n  \"entity_type\": \"User\",\n  \"url\": \"https://www.testupdated.com/\",\n  \"created_at\": \"2015-10-09T11:32:43.370+02:00\",\n  \"updated_at\": \"2015-10-09T14:38:45.034+02:00\",\n  \"deleted_at\": null,\n  \"web_type\": \"Signature\"\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/webhooks/:webhook_id"},"body":"","category":"561787cf6d4d760d003e2e8d","createdAt":"2015-10-09T12:35:20.554Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"update-4","sync_unique":"","title":"Update","type":"put","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

putUpdate



User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":1,"_id":"5617b6477f74330d00dfd7e7","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"null","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/webhooks/:webhooks_id"},"body":"","category":"561787cf6d4d760d003e2e8d","createdAt":"2015-10-09T12:42:47.813Z","excerpt":"Permanently deletes a specific webhook","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"delete-6","sync_unique":"","title":"Delete","type":"delete","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

deleteDelete

Permanently deletes a specific webhook


User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"5639dc9cdaf1c00d00136ce3","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"A theme is made of a set of colors and a logo which define your project's appearance. Themes are fully customizable","category":"5616929acf2a1e0d00247909","createdAt":"2015-11-04T10:23:24.272Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":0,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"what-is-it-8","sync_unique":"","title":"What is it?","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

What is it?


A theme is made of a set of colors and a logo which define your project's appearance. Themes are fully customizable
A theme is made of a set of colors and a logo which define your project's appearance. Themes are fully customizable
{"__v":0,"_id":"56164069c8c5e70d00a8a11a","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n    \"name\": \"Theme 4\",\n    \"logo\": null,\n    \"main_color\": \"#FF0000\",\n    \"secondary_color\": \"#000000\",\n    \"text_color\": \"#777777\"\n}","name":""}]},"params":[{"_id":"56164069c8c5e70d00a8a11f","default":"","desc":"","in":"body","name":"name","ref":"","required":true,"type":"string"},{"_id":"56164069c8c5e70d00a8a11e","default":"","desc":"URL of the logo","in":"body","name":"logo","ref":"","required":false,"type":"string"},{"_id":"56164069c8c5e70d00a8a11d","default":"","desc":"","in":"body","name":"main_color","ref":"","required":true,"type":"string"},{"_id":"56164069c8c5e70d00a8a11c","default":"","desc":"","in":"body","name":"secondary_color","ref":"","required":true,"type":"string"},{"_id":"56164069c8c5e70d00a8a11b","default":"","desc":"","in":"body","name":"text_color","ref":"","required":true,"type":"string"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 4049,\n  \"name\": \"Theme 5\",\n  \"logo\": null,\n  \"main_color\": \"#FF0000\",\n  \"secondary_color\": \"#000000\",\n  \"text_color\": \"#777777\",\n  \"default\": false\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/themes"},"body":"","category":"5616929acf2a1e0d00247909","createdAt":"2015-10-08T10:07:37.758Z","editedParams":true,"editedParams2":true,"excerpt":"Use this command to create a new theme for your company","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":1,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"create-1","sync_unique":"","title":"Create","type":"post","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

postCreate

Use this command to create a new theme for your company

Body JSON

name:
required
string
logo:
string
URL of the logo
main_color:
required
string
secondary_color:
required
string
text_color:
required
string

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":0,"_id":"5616931de98f551700562791","api":{"auth":"required","params":[{"_id":"5616931de98f551700562795","default":"","desc":"Name","name":"search","required":false,"type":"string","in":"query"},{"_id":"5616931de98f551700562794","required":false,"desc":"","default":"","type":"int","name":"limit","in":"query"},{"_id":"5616931de98f551700562793","required":false,"desc":"","default":"","type":"int","name":"offset","in":"query"},{"_id":"5616931de98f551700562792","required":false,"desc":"","default":"","type":"string","name":"order","in":"query"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"search\": null,\n  \"limit\": 50,\n  \"offset\": 0,\n  \"order\": \"-themes.created_at\",\n  \"total\": 2,\n  \"contents\": [\n    {\n      \"id\": 3664,\n      \"name\": \"New theme\",\n      \"logo\": null,\n      \"main_color\": \"#4fada3\",\n      \"secondary_color\": \"#479c93\",\n      \"text_color\": \"#FFFFFF\",\n      \"default\": false\n    },\n    {\n      \"id\": 3663,\n      \"name\": \"Theme #1\",\n      \"logo\": null,\n      \"main_color\": \"#4fada3\",\n      \"secondary_color\": \"#479c93\",\n      \"text_color\": \"#FFFFFF\",\n      \"default\": true\n    }\n  ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/themes"},"body":"","category":"5616929acf2a1e0d00247909","createdAt":"2015-10-08T16:00:29.679Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":2,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"list-3","sync_unique":"","title":"List","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getList


Query Params

search:
string
Name
limit:
integer
offset:
integer
order:
string

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"5616413e21e9110d0078030c","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 4002,\n  \"name\": \"Theme 4\",\n  \"logo\": null,\n  \"main_color\": \"#FF0000\",\n  \"secondary_color\": \"#000000\",\n  \"text_color\": \"#777777\",\n  \"default\": false\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/themes/:theme_id"},"body":"","category":"5616929acf2a1e0d00247909","createdAt":"2015-10-08T10:11:10.223Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":3,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"check-theme-parameters","sync_unique":"","title":"Check theme settings","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getCheck theme settings



User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"56177f037f74330d00dfd7b2","api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n  \"#FFFFFF\",\n  \"#000000\",\n  \"#888888\"\n]","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","auth":"required","params":[],"url":"/themes/colors_detection"},"body":"","category":"5616929acf2a1e0d00247909","createdAt":"2015-10-09T08:46:59.863Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":4,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"color-detection","sync_unique":"","title":"Color detection","type":"get","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

getColor detection



User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":0,"_id":"5616426cbb557f0d00056f3d","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n    \"name\": \"Theme 5\",\n    \"logo\": null,\n    \"main_color\": \"#FF0000\",\n    \"secondary_color\": \"#000000\",\n    \"text_color\": \"#777777\"\n}","name":""}]},"params":[{"_id":"5616426cbb557f0d00056f42","required":true,"desc":"","default":"","type":"string","name":"name","in":"body"},{"_id":"5616426cbb557f0d00056f41","required":false,"desc":"URL of the logo","default":"","type":"string","name":"logo","in":"body"},{"_id":"5616426cbb557f0d00056f40","default":"","desc":"","name":"main_color","required":true,"type":"string","in":"body"},{"_id":"5616426cbb557f0d00056f3f","default":"","desc":"","name":"secondary_color","required":true,"type":"string","in":"body"},{"_id":"5616426cbb557f0d00056f3e","default":"","desc":"","name":"text_color","required":true,"type":"string","in":"body"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"id\": 4002,\n  \"name\": \"Theme 5\",\n  \"logo\": null,\n  \"main_color\": \"#FF0000\",\n  \"secondary_color\": \"#000000\",\n  \"text_color\": \"#777777\",\n  \"default\": false\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/themes/:theme_id"},"body":"","category":"5616929acf2a1e0d00247909","createdAt":"2015-10-08T10:16:12.038Z","editedParams":true,"editedParams2":true,"excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":5,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"update-theme","sync_unique":"","title":"Update","type":"put","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

putUpdate


Body JSON

name:
required
string
logo:
string
URL of the logo
main_color:
required
string
secondary_color:
required
string
text_color:
required
string

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format



{"__v":2,"_id":"56164360cf2a1e0d002478b7","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"null","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"560e512539fad419002ae15d","url":"/themes/:theme_id"},"body":"","category":"5616929acf2a1e0d00247909","createdAt":"2015-10-08T10:20:16.380Z","excerpt":"Permanently deletes a specific theme","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":6,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"delete","sync_unique":"","title":"Delete","type":"delete","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

deleteDelete

Permanently deletes a specific theme


User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}

Definition

{{ api_url }}{{ page_api_url }}

Result Format



{"__v":1,"_id":"5624ee7006e8040d005ed6ec","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"body":"To set a theme as default, you have to update your company theme. Find more info in the Company section","category":"5616929acf2a1e0d00247909","createdAt":"2015-10-19T13:21:52.620Z","excerpt":"","githubsync":"","hidden":false,"isReference":false,"link_external":false,"link_url":"","order":7,"parentDoc":null,"project":"560e389154af2b0d005bbec4","slug":"set-default-theme","sync_unique":"","title":"Set default theme","type":"basic","updates":[],"user":"560e3878c1873e17005a26c5","version":"560e389254af2b0d005bbec7","childrenPages":[]}

Set default theme


To set a theme as default, you have to update your company theme. Find more info in the Company section
To set a theme as default, you have to update your company theme. Find more info in the Company section