For API key and value please refer to SOPlanning option page, in \"API access\" menu.\nPut those key and value as a header of your API call.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"13456412","collectionId":"0c414616-0f7c-409a-afd8-df760fd3fbd2","publishedId":"Tz5s4wwD","public":true,"customColor":{"top-bar":"9FCC3A","right-sidebar":"C0C0C0","highlight":"EF5B25"},"publishDate":"2021-03-16T10:34:48.000Z"},"item":[{"name":"Users methods","item":[{"name":"users","id":"6f192e1c-4ea8-456e-8bda-99abc59ef283","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR-SOPLANNING-URL/users","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"\"userID\" contained in url is the unique user identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"Create/update a user.
\"userID\" contained in url is the unique user identifier : letters and digits ONLY. Maxlength : 20. Required
User name. Can combine first and last name. Maxlength : 50. Required
\n","type":"text/plain"},"key":"name","value":"Test name"},{"description":{"content":"Used in order to log in SOPlanning, can be the same as user ID. Maxlength : 100. Optional. Default : empty
\n","type":"text/plain"},"key":"login","value":"testlogin"},{"description":{"content":"Email address. Maxlength : 255. Optional.
\n","type":"text/plain"},"key":"email","value":"test@test.com"},{"description":{"content":"Password must be sent in clear, hashed on API side. Maxlength : 50. Optional. Will be overwritten only if not empty
\n","type":"text/plain"},"key":"password","value":"test"},{"description":{"content":"User is visible or not in the planning. Vaue : 1 or 0
\n","type":"text/plain"},"key":"visible","value":"1"},{"description":{"content":"User can log in if login and password are set. Vaue : 1 or 0
\n","type":"text/plain"},"key":"active","value":"1"},{"description":{"content":"User receives or not email notifications. Vaue : 1 or 0
\n","type":"text/plain"},"key":"notification","value":"1"},{"description":{"content":"Contact information. Maxlength : 255. Optional.
\n","type":"text/plain"},"key":"address","value":""},{"description":{"content":"Contact information. Maxlength : 20. Optional.
\n","type":"text/plain"},"key":"phone","value":""},{"description":{"content":"Contact information. Maxlength : 20. Optional.
\n","type":"text/plain"},"key":"mobile","value":""},{"description":{"content":"Format : HTML color, Hex code. Length : 6. Optional. Default : FFFFFF
\n","type":"text/plain"},"key":"color","value":null},{"description":{"content":"User job, 50 chars max. Optional
\n","type":"text/plain"},"key":"job","value":null},{"description":{"content":"Free comment, 255 chars, optional
\n","type":"text/plain"},"key":"comment","value":null},{"description":{"content":"Not yet implemented
\n","type":"text/plain"},"key":"rights","value":null},{"description":{"content":"Team ID to attach the user to. See Team item. Optional.
\n","type":"text/plain"},"key":"team_id","value":""},{"description":{"content":"Numeric value. Optional
\n","type":"text/plain"},"key":"default_hourly_rate","value":null}],"variable":[]}},"response":[],"_postman_id":"3708edaa-b4ee-4c99-8779-12b73e59fad6"},{"name":"users/userID","id":"8c28566c-4128-4e55-b429-106d55e558d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://YOUR-SOPLANNING-URL/users/userID","description":"\"userID\" contained in url is the unique user identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"Optional, for search
\n","type":"text/plain"},"key":"id","value":null},{"description":{"content":"Optional, for search
\n","type":"text/plain"},"key":"name","value":""}],"variable":[]}},"response":[],"_postman_id":"c9c84b76-d497-453d-a1ba-5547a33a449d"},{"name":"projects/projectID","id":"cc2ef3b9-4956-4640-96df-fdbc060de06f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR-SOPLANNING-URL/projects/projectID","description":"\"projectID\" contained in url is the unique project identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"Create/update a project.\n\"projectID\" contained in url is the unique project identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"Project name. Maxlength : 50. Required
\n","type":"text/plain"},"key":"name","value":"Test project 1"},{"description":{"content":"user ID owner of the project (used for rights). Required
\n","type":"text/plain"},"key":"owner_id","value":"user1"},{"description":{"content":"Status used for filters, must match with SOPlanning statutes. Required
\n","type":"text/plain"},"key":"status_id","value":"todo"},{"description":{"content":"Delivery date (yyyy-mm-dd). Optional
\n","type":"text/plain"},"key":"delivery","value":""},{"description":{"content":"Format : HTML color, Hex code. Length : 6. Optional. Default : FFFFFF
\n","type":"text/plain"},"key":"color","value":null},{"description":{"content":"Link address. Maxlength : 500. Optional
\n","type":"text/plain"},"key":"link","value":null},{"description":{"content":"Comment. Maxlength : 255. Optional
\n","type":"text/plain"},"key":"comment","value":null},{"description":{"content":"Group of project, must match with SOPlanning groups
\n","type":"text/plain"},"key":"group_id","value":null},{"description":{"content":"Float, budget of the project (money). Optional
\n","type":"text/plain"},"key":"budget_amount","value":null},{"description":{"content":"Float, time budget for the project (number of hours). Optional
\n","type":"text/plain"},"key":"budget_time","value":null}],"variable":[]}},"response":[],"_postman_id":"d62ac5a8-8ab9-4472-ac53-a29e1e6418b1"},{"name":"projects/projectID","id":"a4f6e83e-51af-4d47-b740-325027c576f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://YOUR-SOPLANNING-URL/projects/projectID","description":"\"projectID\" contained in url is the unique project identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"Get SOPlanning tasks
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"User ID for filtering. Must exists in SOPlanning DB or will throw an error - OPTIONAL
\n","type":"text/plain"},"key":"user_id","value":"user1"},{"disabled":true,"description":{"content":"Project ID for filtering. Must exists in SOPlanning DB or will throw an error - OPTIONAL
\n","type":"text/plain"},"key":"project_id","value":"project1"},{"disabled":true,"description":{"content":"Date to start from (included). Will filter on start date of the tasks. Format : YYYY-MM-DD - OPTIONAL
\n","type":"text/plain"},"key":"start_date","value":"2021-06-17"},{"disabled":true,"description":{"content":"End date for filtering (included). Will filter on start date of the tasks combined with previous field for a date range. Format : YYYY-MM-DD - OPTIONAL
\n","type":"text/plain"},"key":"end_date","value":"2021-06-17"},{"disabled":true,"description":{"content":"Possible values : task_id, user_id, project_id, start_date. Default : task_id
\n","type":"text/plain"},"key":"sort_by","value":"user_id"},{"disabled":true,"description":{"content":"Possible values : asc, desc. Default : asc
\n","type":"text/plain"},"key":"sort_order","value":"desc"}],"variable":[]}},"response":[],"_postman_id":"588dda8c-618d-4c10-8f5f-29520f5588c0"},{"name":"tasks/taskID","id":"b719971e-06e0-4d4e-962a-94972d0e4595","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://YOUR-SOPLANNING-URL/api/endpoint/tasks/taskID","description":"\"taskID\" contained in url is the unique task identifier coming from soplanning : digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"If empty, will create a new task. If provided, will update the relevant task
\n","type":"text/plain"},"key":"task_id","value":""},{"description":{"content":"User unique identifier. Mandatory
\n","type":"text/plain"},"key":"user_id","value":"user1"},{"description":{"content":"Project unique identifier. Mandatory
\n","type":"text/plain"},"key":"project_id","value":"test1"},{"description":{"content":"Link between tasks. If not empty, and same link_id for several tasks, they will be linked
\n","type":"text/plain"},"key":"link_id","value":null},{"description":{"content":"Start date of the task (yyyy-mm-dd). Mandatory
\n","type":"text/plain"},"key":"start_date","value":"2021-08-01"},{"description":{"content":"End date of the task (yyyy-mm-dd). Optional, Fill this date or start and end time, or duration
\n","type":"text/plain"},"key":"end_date","value":""},{"description":{"content":"Start time (hh:mm). Optional, please fill also end time in this case
\n","type":"text/plain"},"key":"start_time","value":""},{"description":{"content":"End time (hh:mm). Optional, please fill also start time in this case
\n","type":"text/plain"},"key":"end_time","value":""},{"description":{"content":"Duration of the task. Possible values : \"AM\", \"PM\" or duration (hh:mm). Optional, will be used no end date defined, or start and end time
\n","type":"text/plain"},"key":"duration","value":"08:00"},{"description":{"content":"Status unique identifier. Mandatory
\n","type":"text/plain"},"key":"status_id","value":"todo"},{"description":{"content":"Title of the task, 255 chars max, optional
\n","type":"text/plain"},"key":"title","value":"test création"},{"description":{"content":"Free comment, 65000 chars max, optional
\n","type":"text/plain"},"key":"comment","value":null},{"description":{"content":"Web link, 65000 chars max, optional
\n","type":"text/plain"},"key":"link","value":null},{"description":{"content":"Resource unique identifer, optional
\n","type":"text/plain"},"key":"resource_id","value":""},{"description":{"content":"Place unique identifer, optional
\n","type":"text/plain"},"key":"place_id","value":null},{"description":{"content":"Define if this task is a milestone. \"yes\" or \"no\" (\"no\" if empty)
\n","type":"text/plain"},"key":"milestone","value":""},{"description":{"content":"Free field used to store any custom data. Optional
\n","type":"text/plain"},"key":"custom_field","value":""},{"description":{"content":"Will define the task creator, by providing a user_id. If not provided, the creator will be the first user found with all rights (considered as an administrator).
\n","type":"text/plain"},"key":"creator_id","value":null},{"description":{"content":"Pause duration (hh:mm), optional
\n","type":"text/plain"},"key":"pause","value":null},{"description":{"content":"Real duration of the task for comparison. Float. Optional
\n","type":"text/plain"},"key":"real_duration","value":null}],"variable":[]}},"response":[],"_postman_id":"8fda7139-e568-4ee1-89e6-71d1b76918aa"},{"name":"tasks/taskID","id":"6da254fe-4136-4bb1-a703-190369fd2d84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://YOUR-SOPLANNING-URL/tasks/taskID","description":"\"taskID\" contained in url is the unique task identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"\"resourceID\" contained in url is the unique resource identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"\"resourceID\" contained in url is the unique place identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"Resource name, 50 chars max, required
\n","type":"text/plain"},"key":"name","value":null},{"description":{"content":"Free comment, 255 chars max, optional
\n","type":"text/plain"},"key":"comment","value":null},{"description":{"content":"If \"yes\", the resource cant be assigned twice at the same time. Optional
\n","type":"text/plain"},"key":"exclusive","value":null},{"description":{"content":"hexa color (6 chars)
\n","type":"text/plain"},"key":"color","value":null}],"variable":[]}},"response":[],"_postman_id":"e4c84a7a-6466-4034-9905-77c996e888d0"},{"name":"resources/resourceID","id":"00156d09-8f39-4f4c-bd87-992499e8d34d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://YOUR-SOPLANNING-URL/resources/resourceID","description":"\"resourceID\" contained in url is the unique resource identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"\"placeID\" contained in url is the unique place identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"\"placeID\" contained in url is the unique place identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"Place name, 50 chars max, required
\n","type":"text/plain"},"key":"name","value":""},{"description":{"content":"Free comment, 255 chars max, optional
\n","type":"text/plain"},"key":"comment","value":null},{"description":{"content":"If \"yes\", the resource cant be assigned twice at the same time. Optional
\n","type":"text/plain"},"key":"exclusive","value":null},{"description":{"content":"hexa color (6 chars)
\n","type":"text/plain"},"key":"color","value":null}],"variable":[]}},"response":[],"_postman_id":"704630c2-f714-4df3-afa0-e46b0a47b78d"},{"name":"places/placeID","id":"6622af24-9207-4bb5-bba2-75f0136bc237","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://YOUR-SOPLANNING-URL/places/placeID","description":"\"placeID\" contained in url is the unique place identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"\"teamID\" contained in url is the unique user team identifier : digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"Unique team ID. If not provided, new team will be created
\n","type":"text/plain"},"key":"team_id","value":""},{"description":{"content":"Team name, 30 chars max, required
\n","type":"text/plain"},"key":"name","value":""}],"variable":[]}},"response":[],"_postman_id":"092761b9-0266-415a-9389-a8c025f517b7"},{"name":"teams/teamID","id":"e1e6fce1-a38d-4749-82ea-cacac4764c6b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://YOUR-SOPLANNING-URL/teams/teamID","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"Unique group ID. If not provided, new team will be created
\n","type":"text/plain"},"key":"group_id","value":""},{"description":{"content":"Group name, 30 chars max, required
\n","type":"text/plain"},"key":"name","value":""}],"variable":[]}},"response":[],"_postman_id":"779edda6-a23f-4635-bcf6-805e0c70f687"},{"name":"groups/groupID","id":"4e107985-4a84-46bf-8786-38f7b7e32afb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://YOUR-SOPLANNING-URL/groups/groupID","description":"\"groupID\" contained in url is the unique group identifier : letters and digits ONLY. Maxlength : 20. Required
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"Groups of projects help to group projects in planning display and manage rights.\n\"groupID\" contained in url is the unique project group identifier : digits ONLY. Maxlength : 20. Required
\n","event":[{"listen":"prerequest","script":{"id":"f0e34c5e-22b1-4207-9279-737e4633e548","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e1ab172b-6bf6-4bd5-83dc-22d27de67835","type":"text/javascript","exec":[""]}}],"_postman_id":"06322840-7303-4340-8a1d-ba4eb77e4aec","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"SOPLANNING-API"},{"key":"value","value":"