This API is for machine-to-machine integration (M2M).
\nTo start using the M2M API, you will need a company token. Please request yours by opening a support ticket via email at:suporte-plataforma@uoledtech.com
This endpoint allows you to list all teams in Skore.
\nName of the team to filter result
\n","type":"text/plain"},"key":"search","value":"Onboarding"},{"description":{"content":"Array of user ids to filter result
\n","type":"text/plain"},"key":"user_ids[]","value":":userId"},{"description":{"content":"Array of space ids to filter result
\n","type":"text/plain"},"key":"space_ids[]","value":":spaceId"},{"key":"skip","value":"0"},{"key":"take","value":"10"}],"variable":[]}},"response":[{"id":"db91c981-ad1e-4bef-80f1-cf525f9a4ce6","name":"Get All Teams - OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"url":{"raw":"https://user.skore.ai/v1/teams?search=Onboarding&user_ids[]=:userId&space_ids[]=:spaceId&skip=0&take=10","protocol":"https","host":["user","skore","ai"],"path":["v1","teams"],"query":[{"key":"search","value":"Onboarding","description":"Name of the team to filter result (optional)"},{"key":"user_ids[]","value":":userId","description":"Array of user ids to filter result (optional)"},{"key":"space_ids[]","value":":spaceId","description":"Array of space ids to filter result (optional)"},{"key":"skip","value":"0","description":"Number of register to be skiped, used for pagination"},{"key":"take","value":"10","description":"Number of register to bring, used for pagination"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"Onboarding\",\n \"default\": false,\n \"createdAt\": 1679493538313,\n \"updatedAt\": 1679493538313,\n \"usersCount\": 1,\n \"spacesCount\": 1,\n \"total\": 1,\n \"userIds\": [\n 332\n ],\n \"spaceIds\": [\n 469\n ],\n \"companyId\": 114\n }\n ],\n \"total\": 1\n}"},{"id":"730893cb-69c5-46d6-9f5c-d887bea3a97d","name":"Get All Teams - Internal Error","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"url":{"raw":"https://user.skore.ai/v1/teams?search=Onboarding&user_ids[]=:userId&space_ids[]=:spaceId&skip=0&take=10","protocol":"https","host":["user","skore","ai"],"path":["v1","teams"],"query":[{"key":"search","value":"Onboarding","description":"Name of the team to filter result (optional)"},{"key":"user_ids[]","value":":userId","description":"Array of user ids to filter result (optional)"},{"key":"space_ids[]","value":":spaceId","description":"Array of space ids to filter result (optional)"},{"key":"skip","value":"0","description":"Number of register to be skiped, used for pagination"},{"key":"take","value":"10","description":"Number of register to bring, used for pagination"}]}},"code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 500,\n \"message\": \"Internal server error\"\n}"}],"_postman_id":"b2602a42-c8ed-46df-ad37-a296f3fe1300"},{"name":"Get Team by ID","id":"06a4e899-a464-43e4-b085-323f3e8f98da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"url":"https://user.skore.ai/v1/teams/:id","description":"This endpoint allows you to list a specific teams in Learning.Rocks.
\n","urlObject":{"protocol":"https","path":["v1","teams",":id"],"host":["user","skore","ai"],"query":[],"variable":[{"description":{"content":"Id of the team
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"a7c35838-3e33-4693-b6d4-0ae12f6ab26f","name":"Get Team by ID - OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://user.skore.ai/v1/teams/:id","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id"],"variable":[{"key":"id","value":"1","description":"Id of the team"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"name\": \"Onboarding\",\n \"default\": false,\n \"createdAt\": 1679493538313,\n \"updatedAt\": 1679493538313,\n \"usersCount\": 1,\n \"spacesCount\": 1,\n \"userIds\": [\n 1\n ],\n \"spaceIds\": [\n 469\n ],\n \"companyId\": 114\n}"},{"id":"bcd2ebf9-3fea-46ca-8517-ab9c07651d89","name":"Get Team by ID - Not Found Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://user.skore.ai/v1/teams/:id","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id"],"variable":[{"key":"id","value":"1","description":"Id of the team"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"message\": \"TEAM_NOT_FOUND\",\n \"error\": \"Team not found on company\"\n}"},{"id":"4cc8a8dc-4788-4a40-b4fe-56126ee98ddf","name":"Get Team by ID - Internal Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://user.skore.ai/v1/teams/:id","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id"],"variable":[{"key":"id","value":"1","description":"Id of the team"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 500,\n \"message\": \"INTERNAL_ERROR\",\n \"error\": \"Internal Server Error\"\n}"}],"_postman_id":"06a4e899-a464-43e4-b085-323f3e8f98da"},{"name":"Create Team","id":"1a9ff79c-c60e-44a2-8b92-f0a9417e3ee6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Awesome Team\",\n \"user_ids\": [],\n \"space_ids\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://user.skore.ai/v1/teams","description":"This endpoint allows you to create new team in Learning.Rocks.
\nuser_ids: ID dos usuários que participam do time
\nspace_ids: ID dos espaços associados ao time
Os dois campos acima são opcionais e podem ser enviados vazio [] caso não utiliza
This endpoint allows you to delete a specific team in Learning.Rocks.
\n","urlObject":{"protocol":"https","path":["v1","teams",":id"],"host":["user","skore","ai"],"query":[],"variable":[{"description":{"content":"Id of the team to delete
\n","type":"text/plain"},"type":"any","value":"1","key":"id"}]}},"response":[{"id":"15910d48-27a9-403f-adea-828125eaca00","name":"Delete Team - OK","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"url":{"raw":"https://user.skore.ai/v1/teams/:id","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id"],"variable":[{"key":"id","value":"1","description":"Id of the team to delete"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"true"},{"id":"312ae251-074f-4f6d-ac54-6dbe6915c201","name":"Delete Team - Team not Found","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"url":{"raw":"https://user.skore.ai/v1/teams/:id","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id"],"variable":[{"key":"id","value":"1","description":"Id of the team to delete"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"message\": \"TEAM_NOT_FOUND\",\n \"error\": \"Not Found\"\n}"}],"_postman_id":"29065ee7-8ef2-4345-a887-961660bbc8ce"},{"name":"Update Team","id":"c5197af3-092e-4f6c-8bb1-4be05b67b5e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Super Team\",\n \"space_ids\": [\n 544\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://user.skore.ai/v1/teams/:id","description":"This endpoint allows you to update a specific team in Learning.Rocks.
\nname: Novo nome do time;
\nspace_ids: Categorias ao qual o time fará parte.
\nPara remover o time de um space basta não mandar o id desejado e para adicionar, basta mandar o id do qual ele ainda não faz parte.
\nOBS.: Em caso de não alteração dos spaces do time, deve ser informado todos os ids ao qual o time faz parte, para que não haja a remoção de spaces do mesmo.
\n","urlObject":{"protocol":"https","path":["v1","teams",":id"],"host":["user","skore","ai"],"query":[],"variable":[{"description":{"content":"Id of the team to update
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[{"id":"eaa4f1a9-bba8-4e84-b0d6-2aab217bc4e2","name":"Update Team - OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Super Team\",\n \"space_ids\": [\n 544\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://user.skore.ai/v1/teams/:id","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id"],"variable":[{"key":"id","value":"1","description":"Id of the team to update"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"true"},{"id":"964122e7-7cda-40c5-9719-524093bfc913","name":"Update Team - Team not Found","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Super Team\",\n \"space_ids\": [\n 544\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://user.skore.ai/v1/teams/:id","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id"],"variable":[{"key":"id","value":"48","description":"Id of the team to update"}]}},"code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"message\": \"TEAM_NOT_FOUND\",\n \"error\": \"Not Found\"\n}"},{"id":"ae6cb614-dcd0-4ed3-9701-c3a7398f90c8","name":"Update Team - Name already taken","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Super Team\",\n \"space_ids\": [\n 544\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://user.skore.ai/v1/teams/:id","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id"],"variable":[{"key":"id","value":"48","description":"Id of the team to update"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"message\": \"NAME_ALREADY_TAKEN\",\n \"error\": \"Bad Request\"\n}"},{"id":"6c29ea4e-8030-47b0-a430-2d75027efc13","name":"Update Team - Space not found","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Super Team\",\n \"space_ids\": [\n 544\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://user.skore.ai/v1/teams/:id","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id"],"variable":[{"key":"id","value":"48","description":"Id of the team to update"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"message\": \"SPACE_NOT_FOUND\",\n \"error\": \"Not Found\"\n}"},{"id":"d97e2181-cb99-47b3-ab1f-6bfc0b65e032","name":"Update Team - Max space_ids size reached","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Super Team\",\n \"space_ids\": [1, 2, 3, 4, ...5000]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://user.skore.ai/v1/teams/:id","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id"],"variable":[{"key":"id","value":"48","description":"Id of the team to update"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"message\": [\n \"spaceIds must contain not more than 5000 elements\"\n ],\n \"error\": \"Bad Request\"\n}"}],"_postman_id":"c5197af3-092e-4f6c-8bb1-4be05b67b5e2"},{"name":"Add Users to Team","id":"95cea646-685e-45b7-acdc-2e158eb9fa0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_ids\": []\n}","options":{"raw":{"language":"json"}}},"url":"https://user.skore.ai/v1/teams/:id/users","description":"This endpoint allows you to add users to specific team in Learning.Rocks.
\nname: Novo nome do time;
\nuser_ids: Ids dos usuários que serão adicionados no time.
\nId of the team to update
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[{"id":"3c11f98c-29aa-406b-9026-80e6f8f6f1e5","name":"Add User to Team - OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_ids\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://user.skore.ai/v1/teams/:id/users","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id","users"],"variable":[{"key":"id","value":null,"description":"Id of the team to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"true"},{"id":"8ac6b332-5df8-4c04-b5f9-d41998dafa02","name":"Add User to Team - User Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_ids\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://user.skore.ai/v1/teams/:id/users","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id","users"],"variable":[{"id":"c91f1a9d-1397-4f44-8587-1b9674d065c7","key":"id","value":null,"description":"Id of the team to update"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"message\": \"USER_NOT_FOUND\",\n \"error\": \"Not Found\"\n}"}],"_postman_id":"95cea646-685e-45b7-acdc-2e158eb9fa0b"},{"name":"Remove Users From Team","id":"b8f7b4a6-e69a-4c44-bcd2-a1cbf7d3d621","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"url":"https://user.skore.ai/v1/teams/:id/users?user_ids[]=:userId","description":"This endpoint allows you to remove one or more users from a specific team in Learning.Rocks.
\nTo remove a single user, use the following structure:user_ids=:userId
To remove multiple users at once, use the array with brackets in the URL:user_ids[]=:userId1&user_ids[]=:userId2&user_ids[]=:userId3
Regarding the user parameters, here are some details:
\nThe use of user_ids (without brackets) is only valid for a single user.
The use of user_ids[] (with brackets) allows you to remove one or more users in the same request.
Id of the team to update
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[{"id":"ccf3fbcc-bdd8-4e50-afcd-2d8f93754523","name":"Remove Users From Team - OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_ids\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://user.skore.ai/v1/teams/:id/users","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id","users"],"variable":[{"key":"id","value":null,"description":"Id of the team to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"true"},{"id":"c4633234-5ae5-4bd8-a47e-f0fe717202b8","name":"Remove Users From Team - User Not Found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user_ids\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://user.skore.ai/v1/teams/:id/users","protocol":"https","host":["user","skore","ai"],"path":["v1","teams",":id","users"],"variable":[{"id":"c91f1a9d-1397-4f44-8587-1b9674d065c7","key":"id","value":null,"description":"Id of the team to update"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"message\": \"USER_NOT_FOUND\",\n \"error\": \"Not Found\"\n}"}],"_postman_id":"b8f7b4a6-e69a-4c44-bcd2-a1cbf7d3d621"}],"id":"4b5ecf78-f47d-4993-9e64-b96a47452bd9","description":"At Learning.Rocks, a user can be on a Team. We control access permission to a space or mission by teams.
\n","_postman_id":"4b5ecf78-f47d-4993-9e64-b96a47452bd9"},{"name":"Users","item":[{"name":"Create user","event":[{"listen":"test","script":{"id":"69e1d98e-58ec-4b88-b23d-164789d71eff","exec":["var data = pm.response.json();","console.log('data:', data)","var schema = {"," type: \"object\","," required: ["," \"id\","," \"name\","," \"username\","," \"email\","," \"role\","," \"company_id\","," \"preferences\","," \"team_ids\","," \"teams\""," ],"," properties: {"," id: { type: \"integer\" },"," name: { type: \"string\" },"," username: { type: \"string\" },"," email: { type: \"string\" },"," role: { type: \"string\" },"," company_id: { type: \"integer\" },"," preferences: {"," type: \"object\","," required: ["," \"language\""," ],"," properties: {"," language: {"," type: \"string\""," }"," }"," },"," team_ids: { type: \"array\" },"," teams: { type: \"array\" }"," }","};","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Content-Type is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","pm.test(\"Valid schema\", function () {"," var result = tv4.validateMultiple(data, schema);"," if (!result.valid) console.error(result.errors.toString());"," pm.expect(result.valid).to.be.true;","});"],"type":"text/javascript","packages":{}}}],"id":"d57bb76a-1242-472f-9e00-18e25a1e396b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"user+1775378865@email.com\",\n \"name\": \"Name\",\n \"password\": \"your-password\",\n \"role\": \"student\",\n \"username\": \"\",\n \"leaders\": [40]\n}"},"url":"{{KNOWLEDGE_BASE_URL}}/workspace/v1/users","description":"This endpoint allows you to create new users in Learning.Rocks.
\nThe user will be able to log in using either their email or username.
\nRegarding the user parameters, here are some details:
\n\"\", \"@\", \"#\", or \"@#\" is sent in the request.\"\", \"@\", \"#\", or \"@#\" is sent in the request.student, expert, or admin.(OPTIONAL)
\nen-US, pt-BR, or es-ES.\"metadata\": {\"field1\": \"abc\", \"field2\": \"def\"}.\"metadata\": { \"cpf\": \"00000000000\", \"cargo\": \"analyst\", \"departamento\": \"product\", \"filial\": \"são paulo\", \"data_de_admissao\": \"01/01/2024\" }000.000.000-00 format.leaders: [12345, \"leader@email.com\", \"leader-username\"].This endpoint lists all users of a company. Filter options provided via URL params.
\nQuery Params:
\n- (Optional) username__eq (string): apply a filter to the results, matching the string provided with this param with the 'username' of the users in the results. If the 'find_exact_match' param is set to 'true', it will only return results that match exactly the username provided.
\n- (Optional) email__eq (string): apply a filter to the results, matching the string provided as the value of this param with the 'email' of the users in the results. If the 'find_exact_match' param is set to 'true', it will only return results that match exactly the email provided.
\n- (Optional) limit (number, default=10): limits the number of results in the response.
\n- (Optional) continuation (string): pagination hash for querying additional results.
\n- (Optional) find_exact_match (boolean, default=true): when set to 'true', the 'username__eq' and 'email_eq' filters, if present, will only return results that match exactly the strings provided. If set to 'false', the 'username_eq' and 'email__eq' filters, if present, will return results that are similar to the strings provided.
\n- (Optional) active (boolean): if no value is provided for this param (or if the param isn't present at all), the results will contain both active and inactive users. If set to 'true', only active users will be returned. If set to 'false', only inactive users will be returned in the results.
\n","urlObject":{"path":["workspace","v2","users"],"host":["{{KNOWLEDGE_BASE_URL}}"],"query":[{"disabled":true,"key":"username__eq","value":"roma"},{"disabled":true,"key":"email__eq","value":"roma@skore.io"},{"disabled":true,"key":"limit","value":"2"},{"disabled":true,"key":"continuation","value":"DnF1ZXJ5VGhlbkZldGNoBQAAAAAEuzRAFktfc1Bwb21JUjUyVGZveUZwSEg5b0EAAAAABUFncxZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZnAAAAAAVBZ3QWR0xxeGV0R1FUNXU0NmVsQW5KRlM2ZwAAAAAEuzRBFktfc1Bwb21JUjUyVGZveUZwSEg5b0EAAAAABUFndRZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZn"},{"disabled":true,"key":"active","value":"true"}],"variable":[]}},"response":[{"id":"926cd429-1357-446f-8048-c8b82598bb75","name":"Paginating","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{TOKEN}}","type":"text"}],"url":{"raw":"https://knowledge-staging.skore.io/workspace/v2/users?limit=2&continuation=DnF1ZXJ5VGhlbkZldGNoBQAAAAAFGj2xFkdMcXhldEdRVDV1NDZlbEFuSkZTNmcAAAAABRo9shZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZnAAAAAASUCs8WS19zUHBvbUlSNTJUZm95RnBISDlvQQAAAAAElArQFktfc1Bwb21JUjUyVGZveUZwSEg5b0EAAAAABRo9sxZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZn","protocol":"https","host":["knowledge-staging","skore","io"],"path":["workspace","v2","users"],"query":[{"key":"username__eq","value":"roma","disabled":true},{"key":"email__eq","value":"roma@email.com","disabled":true},{"key":"limit","value":"2"},{"key":"continuation","value":"DnF1ZXJ5VGhlbkZldGNoBQAAAAAFGj2xFkdMcXhldEdRVDV1NDZlbEFuSkZTNmcAAAAABRo9shZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZnAAAAAASUCs8WS19zUHBvbUlSNTJUZm95RnBISDlvQQAAAAAElArQFktfc1Bwb21JUjUyVGZveUZwSEg5b0EAAAAABRo9sxZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZn"},{"key":"active","value":"true","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1553"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 03 Dec 2018 20:49:50 GMT"},{"key":"x-amzn-RequestId","value":"fa74d845-f73c-11e8-99cf-493a9cd73b1f"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"RWSFSHfUIAMFcFA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5c0596ee-ae620331ecf58fb4aaeba096;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 bc52bb885ffa664ce4666f3bb0457488.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"Ct4crwBdJb-Mjid6KvL_HIyzyMI-VZmN69a0L8nZr7kgBvxStcu9Rg=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"preferences\": {\n \"language\": null\n },\n \"role\": \"student\",\n \"company_id\": 114,\n \"active\": true,\n \"teams\": [\n {\n \"default\": false,\n \"company_id\": 114,\n \"name\": \"Product\",\n \"created_at\": 1472837208393,\n \"id\": 3755\n },\n {\n \"default\": false,\n \"company_id\": 114,\n \"name\": \"All\",\n \"created_at\": 1473077835372,\n \"id\": 3765\n }\n ],\n \"name\": \"Thiago Mendes\",\n \"created_at\": \"2016-09-20T11:07:40.761-03:00\",\n \"avatar\": null,\n \"id\": 152649,\n \"is_leader\": false,\n \"email\": \"thiago@barninvest.com.br\",\n \"username\": null,\n \"link\": {\n \"login\": \"https://knowledge.skore.io/workspace/v1/proxy/114/login/iIqwrnPMjqh_Zq2T7Knccg\"\n }\n },\n {\n \"preferences\": {\n \"language\": \"pt-BR\"\n },\n \"role\": \"admin\",\n \"company_id\": 114,\n \"teams\": [\n {\n \"default\": false,\n \"company_id\": 114,\n \"name\": \"Development\",\n \"created_at\": 1472582178599,\n \"id\": 3715\n },\n {\n \"default\": false,\n \"company_id\": 114,\n \"name\": \"All\",\n \"created_at\": 1473077835372,\n \"id\": 3765\n },\n {\n \"default\": false,\n \"company_id\": 114,\n \"name\": \"Marketing\",\n \"created_at\": 1473077842267,\n \"id\": 3766\n },\n {\n \"default\": false,\n \"company_id\": 114,\n \"name\": \"Customer Success\",\n \"created_at\": 1473111036831,\n \"id\": 3775\n }\n ],\n \"name\": \"Pepe\",\n \"created_at\": \"2016-08-01T08:52:56.630-03:00\",\n \"avatar\": \"https://skore-production-res.cloudinary.com/image/upload/c_fill,h_250,w_250/hfmw5asjszivixttjrrz\",\n \"id\": 126340,\n \"is_leader\": false,\n \"email\": \"jose@skore.io\",\n \"username\": null,\n \"link\": {\n \"login\": \"https://knowledge.skore.io/workspace/v1/proxy/114/login/GWmWIoj1bONQJV1dr-1n9Q\"\n }\n }\n ],\n \"continuation\": \"DnF1ZXJ5VGhlbkZldGNoBQAAAAAFGj2xFkdMcXhldEdRVDV1NDZlbEFuSkZTNmcAAAAABRo9shZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZnAAAAAASUCs8WS19zUHBvbUlSNTJUZm95RnBISDlvQQAAAAAElArQFktfc1Bwb21JUjUyVGZveUZwSEg5b0EAAAAABRo9sxZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZn\"\n}"},{"id":"0ec6ffbe-0978-49cf-94fd-8a0792dd4d9a","name":"Filter by email","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{TOKEN}}"}],"url":{"raw":"{{KNOWLEDGE_BASE_URL}}/workspace/v2/users?email__eq=user+student@email.com","host":["{{KNOWLEDGE_BASE_URL}}"],"path":["workspace","v2","users"],"query":[{"key":"username__eq","value":"roma","disabled":true},{"key":"email__eq","value":"user+student@email.com"},{"key":"limit","value":"2","disabled":true},{"key":"continuation","value":"DnF1ZXJ5VGhlbkZldGNoBQAAAAAFGj2xFkdMcXhldEdRVDV1NDZlbEFuSkZTNmcAAAAABRo9shZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZnAAAAAASUCs8WS19zUHBvbUlSNTJUZm95RnBISDlvQQAAAAAElArQFktfc1Bwb21JUjUyVGZveUZwSEg5b0EAAAAABRo9sxZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZn","disabled":true},{"key":"active","value":"true","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"945"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 03 Dec 2018 20:51:38 GMT"},{"key":"x-amzn-RequestId","value":"3a14fdb5-f73d-11e8-8d68-d1506c88419e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"RWSV-FizoAMFQrw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5c059759-e7e8870033a41300aa5ced00;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 bc52bb885ffa664ce4666f3bb0457488.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"fjVasDzPZEaPdjpdDCant9IBv3LSDlIG76qJeCWcCoP-vEFk-RXQGw=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"preferences\": {\n \"language\": \"pt-BR\"\n },\n \"role\": \"student\",\n \"company_id\": 114,\n \"active\": true,\n \"teams\": [\n {\n \"default\": false,\n \"company_id\": 114,\n \"name\": \"Product\",\n \"created_at\": 1472837208393,\n \"id\": 3755\n },\n {\n \"default\": false,\n \"company_id\": 114,\n \"name\": \"All\",\n \"created_at\": 1473077835372,\n \"id\": 3765\n },\n {\n \"default\": false,\n \"company_id\": 114,\n \"name\": \"Customer Success\",\n \"created_at\": 1473111036831,\n \"id\": 3775\n }\n ],\n \"name\": \"Roma\",\n \"created_at\": \"2016-09-06T10:09:09.210-03:00\",\n \"avatar\": null,\n \"id\": 148360,\n \"is_leader\": false,\n \"email\": \"user+student@email.com\",\n \"username\": null,\n \"link\": {\n \"login\": \"https://knowledge.skore.io/workspace/v1/proxy/114/login/token\"\n }\n }\n ],\n \"continuation\": \"DnF1ZXJ5VGhlbkZldGNoBQAAAAAFGkOYFkdMcXhldEdRVDV1NDZlbEFuSkZTNmcAAAAABRpDmRZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZnAAAAAASUEMIWS19zUHBvbUlSNTJUZm95RnBISDlvQQAAAAAElBDAFktfc1Bwb21JUjUyVGZveUZwSEg5b0EAAAAABJQQwRZLX3NQcG9tSVI1MlRmb3lGcEhIOW9B\"\n}"},{"id":"fe53ff7f-6f75-4edb-8f55-856d34c07130","name":"Response 200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"{{TOKEN}}"}],"url":{"raw":"{{KNOWLEDGE_BASE_URL}}/workspace/v2/users","host":["{{KNOWLEDGE_BASE_URL}}"],"path":["workspace","v2","users"],"query":[{"key":"username__eq","value":"'roma'","disabled":true},{"key":"email__eq","value":"'roma%40email.com'","disabled":true},{"key":"limit","value":"2","disabled":true},{"key":"continuation","value":"DnF1ZXJ5VGhlb","disabled":true},{"key":"active","value":"true","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"6010"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 03 Dec 2018 20:47:52 GMT"},{"key":"x-amzn-RequestId","value":"b409ce77-f73c-11e8-8f5b-e7c7511ef66c"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"RWRy1FAHoAMFZxQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5c059678-eeae80c07aaf4be7da2624d0;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 bc52bb885ffa664ce4666f3bb0457488.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"CNXpXDfu8jDcwL-CVoT5omAWMC-_2I_Fr1TU_MCMsRjG1SSba0PoSw=="}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"preferences\": {\n \"language\": null\n },\n \"role\": \"student\",\n \"company_id\": 114,\n \"active\": true,\n \"teams\": [],\n \"name\": \"User Student\",\n \"created_at\": \"2017-11-30T11:07:34.780-02:00\",\n \"avatar\": null,\n \"id\": 281295,\n \"is_leader\": false,\n \"email\": \"user+student@email.com\",\n \"username\": null,\n \"link\": {\n \"login\": \"https://knowledge.skore.io/workspace/v1/proxy/114/login/XYZ-123\"\n }\n }\n ],\n \"continuation\": \"DnF1ZXJ5VGhlbkZldGNoBQAAAAAFGjdAFkdMcXhldEdRVDV1NDZlbEFuSkZTNmcAAAAABRo3PhZHTHF4ZXRHUVQ1dTQ2ZWxBbkpGUzZnAAAAAASUBF0WS19zUHBvbUlSNTJUZm95RnBISDlvQQAAAAAFGjc_FkdMcXhldEdRVDV1NDZlbEFuSkZTNmcAAAAABJQEXhZLX3NQcG9tSVI1MlRmb3lGcEhIOW9B\"\n}"}],"_postman_id":"70f235c8-1181-4b8d-b503-5f8399b52f5f"},{"name":"User details","event":[{"listen":"test","script":{"id":"78ab315b-5700-41de-b5e2-52aa6cad6fb1","exec":["var data = pm.response.json();","var schema = {"," type: \"object\","," required: ["," \"preferences\","," \"role\","," \"company_id\","," \"teams\","," \"name\","," \"created_at\","," \"id\","," \"avatar\","," \"email\","," \"is_leader\","," \"username\","," \"link\""," ],"," properties: {"," preferences: {"," type: \"object\","," required: ["," \"language\""," ],"," properties: {"," language: {"," type: [\"null\",\"string\"]"," }"," }"," },"," role: { type: \"string\" },"," company_id: { type: \"integer\" },"," teams: {"," type: \"array\","," items: {"," type: \"object\","," required: ["," \"id\","," \"company_id\","," \"default\","," \"name\","," \"created_at\""," ],"," properties: {"," id: { type: \"integer\" },"," company_id: { type: \"integer\" },"," default: { type: \"boolean\" },"," name: { type: \"string\" },"," created_at: { type: \"integer\" }"," }"," }"," },"," name: { type: \"string\" },"," created_at: { type: \"string\" },"," id: { type: \"integer\" },"," avatar: { type: [\"null\",\"string\"] },"," email: { type: \"string\" },"," is_leader: { type: \"boolean\" },"," username: { type: \"string\" },"," link: {"," type: \"object\","," required: ["," \"login\""," ],"," properties: {"," login: {"," type: \"string\""," }"," }"," }"," }","};","","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Content-Type is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","","pm.test(\"Valid schema\", function () {"," var result = tv4.validateMultiple(data, schema);"," if (!result.valid) console.error(result.errors.toString());"," pm.expect(result.valid).to.be.true;","});"],"type":"text/javascript"}}],"id":"d4caca5a-6fa8-4f5c-a7ac-bc13067a36d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{TOKEN}}","type":"text"}],"url":"{{KNOWLEDGE_BASE_URL}}/workspace/v1/users/{{USER_ID}}","description":".
\n","urlObject":{"path":["workspace","v1","users","{{USER_ID}}"],"host":["{{KNOWLEDGE_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a0effecd-869f-4d79-bfa0-4a4034f0442c","name":"Response 404","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{TOKEN}}","type":"text"}],"url":"{{KNOWLEDGE_BASE_URL}}/workspace/v1/users/3038680"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"37"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 03 Dec 2018 20:59:50 GMT"},{"key":"x-amzn-RequestId","value":"5f822def-f73e-11e8-b2c7-596ea8490701"},{"key":"x-amz-apigw-id","value":"RWTi5EYKoAMFQ5A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5c059945-1f637e2a3f81f89a8a3b7438;Sampled=0"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 947c54b45c3c8c597031c85dd8160216.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"7BnqfEk0Mud4e7zx3E8cr2zD95GadMaU2aObCDHDcfxrC6IIaUMqiQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 404,\n \"message\": \"Not Found\"\n}"},{"id":"ad0e5ca4-73ad-43d3-b96e-24187521e887","name":"Response 200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{TOKEN}}","type":"text"}],"url":"{{KNOWLEDGE_BASE_URL}}/workspace/v1/users/303868"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"601"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Mon, 03 Dec 2018 20:58:44 GMT"},{"key":"x-amzn-RequestId","value":"375ec267-f73e-11e8-b750-83c302355dca"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"RWTYXEozIAMFehg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5c059902-6047c8ea7d7713d634658e58;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 947c54b45c3c8c597031c85dd8160216.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"944YE2Osv28VmY5FqQvKZG4X9QKraj3I2dZ_v__6fpyGcuqlleOdiQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"preferences\": {\n \"language\": \"pt-BR\"\n },\n \"role\": \"admin\",\n \"company_id\": 114,\n \"teams\": [\n {\n \"id\": 3715,\n \"company_id\": 114,\n \"default\": false,\n \"name\": \"Development\",\n \"created_at\": 1472582178599\n },\n {\n \"id\": 3765,\n \"company_id\": 114,\n \"default\": false,\n \"name\": \"All\",\n \"created_at\": 1473077835372\n }\n ],\n \"name\": \"User API\",\n \"created_at\": \"2018-02-26T12:40:34.793-03:00\",\n \"id\": 303868,\n \"avatar\": null,\n \"email\": \"user+api@email.com\",\n \"is_leader\": false,\n \"username\": \"\",\n \"link\": {\n \"login\": \"https://knowledge.skore.io/workspace/v1/proxy/114/login/XYZ-1234\"\n }\n}"}],"_postman_id":"d4caca5a-6fa8-4f5c-a7ac-bc13067a36d4"},{"name":"Update user","event":[{"listen":"test","script":{"id":"78ab315b-5700-41de-b5e2-52aa6cad6fb1","exec":["var data = pm.response.json();","","pm.test(\"Status code is 404, cause the api-key always send a user_id=0\", function () {"," pm.response.to.have.status(404);","});","","pm.test(\"Content-Type is present\", function () {"," pm.response.to.have.header(\"Content-Type\");","});","",""],"type":"text/javascript","packages":{}}}],"id":"10ff19f0-9925-4824-b883-cf9269c49551","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"username\": \"user+160640773\",\n \"leaders\": [40]\n}\n"},"url":"{{KNOWLEDGE_BASE_URL}}/workspace/v1/users/{{USER_ID}}","description":"This endpoint allows you to update user attributes in Learning.Rocks.
It is also used to enable or disable a user's access through the active flag.
Regarding the user parameter, here are some details:
undefined\", \"null\", \"\", \"@\", \"#\", or \"@#\", is sent in the request.undefined\", \"null\", \"\", \"@\", \"#\", or \"@#\", is sent in the request.false, the user will not be able to log into the platform.(Optional)
\nlanguage: Should be the ISO language code, like en-US, pt-BR, or es-ES.
team_ids: This API will replace the current teams of the user. If team_ids is included in the request, the user will be removed from all current teams and added to the new ones.
IMPORTANT: If this parameter is not present, the user's teams will remain unchanged.
If you send team_ids: [], the user will be removed from all current teams and will not be part of any team.
metadata: This API replaces the current metadata. If metadata is included in the request, the current metadata will be removed, and the new metadata will be added.
You can pass the metadata as a JSON object or a string.
IMPORTANT: If the metadata parameter is not included, the existing metadata will not be deleted.
To merge the new metadata with the existing metadata, include the merge_metadata: true parameter.
It is recommended to create and maintain all metadata in lowercase, without accents or special characters.
All metadata created via the API are, by default, automatically created in the TEXT format.
If it is necessary to create metadata in formats other than TEXT (for example, LIST, NUMBER, or DATE), the metadata must first be created in the Data Manager and only then managed via the API.
The format of metadata cannot be changed after creation. If it is created incorrectly via the API (e.g., as TEXT instead of LIST, NUMBER or DATE), it will be necessary to open a support ticket for the manual deletion of the metadata.
Example: \"metadata\": {\"field1\": \"abc\", \"field2\": \"def\"}
Mask validation for TEXT-type metadata ensures that submitted values follow the pattern configured in the platform. If the provided value is not in the correct format, the API will return a validation error. e.g., cpf masks should have 000.000.000-00 format.
leaders: This API replaces the current leaders if provided. The leaders field supports ID, email, or username, and it is possible to send all three types in the same request.**
IMPORTANT: If you sendleaders: [], the current leaders will be removed, and the user will no longer have a leader.
Example: \"leaders:[010101,111111,111011]
Send the user an email with a link to create account in company
\nThe headers Authorization and Referer in the method at least one must be informed, depending on the origin of the call, if the method is called from the WEB by default the browser will inform the Referer or if the method is called from an M2M integration the method has to inform the company token in Authorization
\n","urlObject":{"path":["v1","invites"],"host":["{{WORKSPACE_BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"f04e8557-83a8-4021-a477-be1cdd9004e8","name":"M2M Invite user","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"credential\": \"user+invite@email.com\",\n \"company_id\": 114\n}","options":{"raw":{"language":"json"}}},"url":"{{KNOWLEDGE_BASE_URL}}/workspace/v1/invites"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 02 Sep 2020 19:57:41 GMT"},{"key":"x-amzn-RequestId","value":"021ef51e-b1f8-46f8-bbfb-e6aee327e91b"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"SQPgNHiyoAMF6PQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f4ff934-246364b2726bb1d6e3c26de8;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 1ddeacce24f5e91d497c9d8a72218fd2.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"oK5CR3Pv-YRwlhGqGBwxAMZe468Iu5LnA1CMvBSSbB8kpWjLzKWxxw=="}],"cookie":[],"responseTime":null,"body":"\"Ok\""}],"_postman_id":"a562bc70-49a1-4c65-913a-e8549530c341"}],"id":"baa56cb4-c9bc-4d94-9528-d7119d5d4590","description":".
\n","_postman_id":"baa56cb4-c9bc-4d94-9528-d7119d5d4590"},{"name":"Companies","item":[{"name":"Company settings","id":"3930e30d-0658-456b-bfcc-0f20fc03c761","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{TOKEN}}","type":"text"}],"url":"{{KNOWLEDGE_BASE_URL}}/identity/invitations?email=renato@skore.io","description":"Find a company by domain ou some another scope, like: app_id
\n","urlObject":{"path":["identity","invitations"],"host":["{{KNOWLEDGE_BASE_URL}}"],"query":[{"key":"email","value":"renato@skore.io"}],"variable":[]}},"response":[{"id":"290b6e73-b321-4315-8b3a-abe2172c9b5e","name":"Response 200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{TOKEN}}","type":"text"}],"url":"{{KNOWLEDGE_BASE_URL}}/workspace/v1/companies/114/settings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"159"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Tue, 04 Dec 2018 13:31:43 GMT"},{"key":"x-amzn-RequestId","value":"f0423299-f7c8-11e8-9b76-b1ecdd7081d4"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"RYk13GxIoAMFuGQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5c0681bf-9d4c806a7bf5623c00ce9f74;Sampled=0"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 439257b5e6d98715175dd92e647f0e94.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Id","value":"kTifulqp0R7XnftPn1csa-c90b2TS29VMK4gUdbfm0ZIboMu7nimKQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Skore\",\n \"plugins\": {\n \"snippet\": \"\"\n },\n \"branding\": {\n \"brand_image\": {\n \"small\": null,\n \"medium\": null,\n \"original\": null\n },\n \"primary_color\": \"#00CEB2\"\n },\n \"access_rules\": null\n}"}],"_postman_id":"3930e30d-0658-456b-bfcc-0f20fc03c761"}],"id":"fa340374-7817-48d7-b769-339b9c9d561b","_postman_id":"fa340374-7817-48d7-b769-339b9c9d561b","description":""},{"name":"Content","item":[{"name":"Content by ID","id":"9fd7ec08-0ce0-4e2f-8d8a-7dcef5a4cdf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","description":"Company authentication token
\n","type":"text"}],"url":"https://content.skore.ai/api/v1/contents/:id","description":"This endpoint allows you to retrieve data from a specific content on Learning.Rocks
\nSupported Query Parameters:
\nid: ID or external ID of the content in the client application for which the data will be retrieved on Learning.Rocks.
\nThe above field is mandatory and cannot be submitted empty.
\nRule:
\nDeleted content will not be returned.
\n","urlObject":{"protocol":"https","path":["api","v1","contents",":id"],"host":["content","skore","ai"],"query":[],"variable":[{"id":"ba8776ae-5631-4387-86ec-1effe7b5a984","description":{"content":"Content ID (numeric) or external ID (string).
\n","type":"text/plain"},"type":"any","value":"123","key":"id"}]}},"response":[{"id":"f90679ef-1d03-4d9b-8215-97c2e72b3cc7","name":"Success Response - Numeric ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer •••••••","type":"text"}],"url":"https://content.skore.ai/api/v1/contents/123"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"123\",\n \"external_id\": \"EXT_001\",\n \"title\": \"Introduction to JavaScript\",\n \"description\": \"Learn the basics of JavaScript programming\",\n \"content_syllabus\": \"1. Variables and Data Types\\n2. Functions\\n3. Control Structures\",\n \"type\": \"video\",\n \"format\": \"mp4\",\n \"workload\": 120,\n \"space\": {\n \"id\": \"456\",\n \"name\": \"Programming\"\n },\n \"section\": {\n \"id\": \"789\",\n \"name\": \"Web Development\"\n },\n \"creator_id\": \"101\",\n \"has_certificate\": true,\n \"has_questions\": false,\n \"has_feedback\": true,\n \"created_at\": 1700000000000,\n \"updated_at\": 1700000000000\n}"},{"id":"df4749be-76e9-41f6-b0d9-d4a2fd805e85","name":"Success Response - External ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer •••••••","type":"text"}],"url":"https://content.skore.ai/api/v1/contents/EXT_001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"123\",\n \"external_id\": \"EXT_001\",\n \"title\": \"Introduction to JavaScript\",\n \"description\": \"Learn the basics of JavaScript programming\",\n \"content_syllabus\": \"1. Variables and Data Types\\n2. Functions\\n3. Control Structures\",\n \"type\": \"video\",\n \"format\": \"mp4\",\n \"workload\": 120,\n \"space\": {\n \"id\": \"456\",\n \"name\": \"Programming\"\n },\n \"section\": {\n \"id\": \"789\",\n \"name\": \"Web Development\"\n },\n \"creator_id\": \"101\",\n \"has_certificate\": true,\n \"has_questions\": false,\n \"has_feedback\": true,\n \"created_at\": 1700000000000,\n \"updated_at\": 1700000000000\n}"},{"id":"c5677020-483e-45a5-bda1-d3c193272546","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer •••••••","type":"text"}],"url":"https://content.skore.ai/api/v1/contents/999999"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 404,\n \"message\": \"Content not found\",\n \"error\": \"Not Found\"\n}"},{"id":"8462507f-ef5d-4fce-b841-56dfef98ceb0","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://content.skore.ai/api/v1/contents/123"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\",\n \"error\": \"Unauthorized\"\n}"}],"_postman_id":"9fd7ec08-0ce0-4e2f-8d8a-7dcef5a4cdf1"},{"name":"Contents","id":"bca6a1cb-bd4b-44d3-a027-5a3876dde52d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","description":"Company authentication token
\n","type":"text"}],"url":"https://content.skore.ai/api/v1/contents?date_type=CREATED_AT&date_min=1700000000000&date_max=1700040000000&sort_by=CREATED_AT&sort_order=DESC&skip=0&take=10","description":"This endpoint allows you to retrieve a paginated list of contents with optional filtering and sorting capabilities on Learning.Rocks.
\nSupported Query Parameters:
\ndate_type (string, required if min or max is provided): Type of date field to filter by. Accepts CREATED_AT to filter by creation date or UPDATED_AT to filter by last update date.
\ndate_min (number, optional) and date_max (number, optional): Date range filter using Unix timestamps in milliseconds. These parameters define the minimum and maximum dates for filtering contents within the specified period.
\nskip (number, optional) and take (number, optional): Pagination parameters to control the number of records returned. skip defines the number of records to skip (offset), and take defines the maximum number of records to return (limit).
\nsort_by (string, optional): Field to sort the results by. Accepts CREATED_AT to sort by creation date or UPDATED_AT to sort by last update date.
\nsort_order (string, optional): Order direction for sorting. Accepts ASC for ascending order or DESC for descending order.
\nImportant:
\nTo handle a large number of simultaneous requests, ensuring that performance is not compromised, the service response will be paginated. Use the skip and take parameters to navigate through the results. The total field in the response indicates the total number of contents matching the filters before pagination.
\nRules:
\nWhen specifying the date_min and date_max parameters for filtering by date range, it will also be mandatory to specify the date_type parameter (CREATED_AT or UPDATED_AT). At least one of date_min or date_max must be provided when date_type is specified.
\nThe date_min cannot be greater than or equal to the date_max of the period. The date_max must be strictly greater than date_min when both are provided.
\nWhen sort_by and sort_order are not specified, the default sorting will be by CREATED_AT DESC (from newest to oldest).
\nThe skip and take parameters must be non-negative numbers. Default values are skip = 0 and take = 10 if not specified.
\nThe maximum number of records (limit) by request is 100.
\nDeleted content will not be returned.
\nType of date to filter by. Required if date_min or date_max is provided. Values: CREATED_AT, UPDATED_AT
\n","type":"text/plain"},"key":"date_type","value":"CREATED_AT"},{"description":{"content":"Minimum date filter (Unix timestamp in milliseconds). Requires date_type to be set. Must be less than date_max if both are provided.
\n","type":"text/plain"},"key":"date_min","value":"1700000000000"},{"description":{"content":"Maximum date filter (Unix timestamp in milliseconds). Requires date_type to be set. Must be greater than date_min if both are provided.
\n","type":"text/plain"},"key":"date_max","value":"1700040000000"},{"description":{"content":"Field to sort by. Values: CREATED_AT, UPDATED_AT
\n","type":"text/plain"},"key":"sort_by","value":"CREATED_AT"},{"description":{"content":"Sort order. Values: ASC, DESC
\n","type":"text/plain"},"key":"sort_order","value":"DESC"},{"description":{"content":"Number of records to skip (for pagination)
\n","type":"text/plain"},"key":"skip","value":"0"},{"description":{"content":"Number of records to return (for pagination)
\n","type":"text/plain"},"key":"take","value":"10"}],"variable":[]}},"response":[{"id":"4a70ed50-70af-42e0-9829-5e9306f524b3","name":"Success Response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer •••••••","type":"text"}],"url":{"raw":"https://content.skore.ai/api/v1/contents?skip=0&take=10","protocol":"https","host":["content","skore","ai"],"path":["api","v1","contents"],"query":[{"key":"skip","value":"0"},{"key":"take","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"123\",\n \"external_id\": \"EXT_001\",\n \"title\": \"Introduction to JavaScript\",\n \"description\": \"Learn the basics of JavaScript programming\",\n \"type\": \"video\",\n \"format\": \"mp4\",\n \"workload\": 120,\n \"space\": {\n \"id\": \"456\",\n \"name\": \"Programming\"\n },\n \"section\": {\n \"id\": \"789\",\n \"name\": \"Web Development\"\n },\n \"creator_id\": \"101\",\n \"has_certificate\": true,\n \"has_questions\": false,\n \"has_feedback\": true,\n \"created_at\": 1700000000000,\n \"updated_at\": 1700000000000\n }\n ],\n \"total\": 1\n}"},{"id":"bdcc2648-7202-4a19-863b-ac108864d1a9","name":"Bad Request - Invalid Date Range","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{bearer_token}}","type":"text"}],"url":{"raw":"https://content.skore.ai/api/v1/contents?date_type=CREATED_AT&date_min=1700040000000&date_max=1700000000000","protocol":"https","host":["content","skore","ai"],"path":["api","v1","contents"],"query":[{"key":"date_type","value":"CREATED_AT"},{"key":"date_min","value":"1700040000000"},{"key":"date_max","value":"1700000000000"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"message\": \"date_max must be greater than date_min\",\n \"error\": \"Bad Request\"\n}"},{"id":"3cb6f9df-c51a-46f2-a1ee-cb1151d7c3c1","name":"Unauthorized","originalRequest":{"method":"GET","header":[],"url":"https://content.skore.ai/api/v1/contents"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\",\n \"error\": \"Unauthorized\"\n}"}],"_postman_id":"bca6a1cb-bd4b-44d3-a027-5a3876dde52d"},{"name":"Content Consumption","id":"ada1f608-29b5-41c0-a521-99bb7f888774","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{bearer_token}}","description":"Company authentication token
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skip\": 0,\n \"take\": 10,\n \"users\": [\"user@example.com\", 123],\n \"content_ids\": [1, 2, 3],\n \"sort_by\": \"CREATED_AT\",\n \"sort_order\": \"DESC\",\n \"date\": {\n \"type\": \"CREATED_AT\",\n \"min\": 542948400000,\n \"max\": 3698708400000\n },\n \"grade\": {\n \"min\": 0,\n \"max\": 100\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://consume.learningrocks.io/api/v1/content_consumption/list","description":"This endpoint allows retrieving a paginated list of user content consumption data, filtered by users, content, dates, and grades in Learning.Rocks.
\nSupported query parameters:
\nusers (array, optional): Array of user IDs, emails, or usernames. Maximum: 100 items. The API will search for users that match any of the provided identifiers within the company.
\ncontent_ids (array, optional): Array of content IDs to filter by. Maximum: 100 items.
\ndate.type (string, required if min or max is provided): Type of date field to filter by. Possible values: CREATED_AT, UPDATED_AT, COMPLETED_AT, FIRST_ACCESSED_AT, LAST_ACCESSED_AT, CONSUMED_AT, ATTENDED_AT, RECYCLED_AT.
\ndate.min (number, optional) and date.max (number, optional): Date range filter using Unix timestamps in milliseconds. These parameters define the minimum and maximum dates to filter content consumption within a specific time range based on different date types.
\ngrade.min (number, optional) and grade.max (number, optional): Minimum and maximum value filter to filter content consumption based on the grade range achieved by users.
\nskip (number, optional) and take (number, optional): Pagination parameters to control the number of records returned. skip defines the number of records to be skipped (offset) and take defines the maximum number of records to be returned (limit).
\nsort_by (string, optional): Field used to sort the results. Possible values: CREATED_AT, UPDATED_AT, COMPLETED_AT, FIRST_ACCESSED_AT, LAST_ACCESSED_AT, CONSUMED_AT, ATTENDED_AT, RECYCLED_AT.
\nsort_order (string, optional): Sort direction. Accepts ASC for ascending order or DESC for descending order.
\nImportant:
\nTo handle a large number of simultaneous requests while ensuring performance is not compromised, we recommend that requests are always made using pagination. Use the skip and take parameters to implement pagination and avoid loading excessive amounts of data in a single request.
\nRules:
\nThe filter parameters listed above are optional and can be combined to create complex queries.
\nThe usersand content_ids arrays have a maximum size of 100 items each. Requests that exceed this limit will result in a validation error.
If the usersparameter is provided and no matching user is found within the company, the API will return an empty list (items: [], total: 0) instead of an error. This allows proper handling of invalid user identifiers.
When specifying the date_min and date_max parameters to filter by a date range, the date_type parameter will also be required. At least one of the date_min or date_max parameters must be provided when date_type is specified.
The date_min value cannot be greater than or equal to the date_max value. The date_max value must be strictly greater than date_min when both are provided.
The date filter supports different date types that correspond to various events in the content consumption lifecycle:
\nCREATED_AT: Filters by when the user’s journey with the content was created.
\nUPDATED_AT: Filters by when the user’s journey was last updated (for when the user makes new attempts on exam-type contents or contents with activities (associated questions) until reaching the minimum score or exhausting the available attempts)
\nCOMPLETED_AT: Filters by when the content was completed by the user.
\nFIRST_ACCESSED_AT: Filters by when the content was accessed for the first time.
\nLAST_ACCESSED_AT: Filters by when the content was accessed for the last time.
\nCONSUMED_AT: Filters by when the content was consumed by the user.
\nATTENDED_AT: Filters by when the user attended the content (for in-person or live classes).
\nRECYCLED_AT: Filters by when the content was recycled by the user.
\nWhen sort_by and sort_order are not provided, the default sorting will be by CREATED_AT DESC (from most recent to oldest).
\nThe skip and take parameters must be non-negative numbers. Default values are skip = 0 and take = null (no limit) if not specified.
\nJourneys related to deleted content will not be returned.
\nJourneys of inactive users will not be returned.
\n","urlObject":{"protocol":"https","path":["api","v1","content_consumption","list"],"host":["consume","learningrocks","io"],"query":[],"variable":[]}},"response":[{"id":"efc3dbaf-6309-45da-acc3-ed98071458ce","name":"Success Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{company_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skip\": 0,\n \"take\": 10,\n \"sort_by\": \"CREATED_AT\",\n \"sort_order\": \"DESC\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:3000/api/v1/content_consumption/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"journey_id\": \"44913872-bcf2-4655-a0f4-f63c8435a973\",\n \"user\": {\n \"id\": 123,\n \"name\": \"John Doe\",\n \"username\": \"john.doe\",\n \"email\": \"john@example.com\"\n },\n \"content\": {\n \"id\": 1,\n \"external_id\": \"ext-123\",\n \"title\": \"Introduction to JavaScript\"\n },\n \"created_at\": 542948400000,\n \"completed_at\": 543000000000,\n \"first_accessed_at\": 542950000000,\n \"last_accessed_at\": 543000000000,\n \"access_count\": 5,\n \"consumed_at\": 543000000000,\n \"attended_at\": null,\n \"grade\": 85,\n \"recycled_at\": null,\n \"updated_at\": 543000000000\n }\n ],\n \"total\": 1\n}"},{"id":"0bed1bfa-d521-4f38-854e-88735b7e5f53","name":"Bad Request - Invalid Parameters","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{company_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"date\": {\n \"type\": \"CREATED_AT\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/content_consumption/list"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"message\": \"Validation failed\",\n \"error\": \"Bad Request\"\n}"},{"id":"c6f00837-b949-481e-add0-477859cf3486","name":"Unauthorized - Missing Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"skip\": 0,\n \"take\": 10\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/content_consumption/list"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 401,\n \"message\": \"Unauthorized\",\n \"error\": \"Unauthorized\"\n}"}],"_postman_id":"ada1f608-29b5-41c0-a521-99bb7f888774"}],"id":"468407fc-ab77-47c0-8e0f-9a4ccc08d559","_postman_id":"468407fc-ab77-47c0-8e0f-9a4ccc08d559","description":""},{"name":"Sessions","item":[{"name":"Create a user session","id":"680ca8d9-af3a-4df6-afa9-a2179d33d36f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{TOKEN}}","description":"Company Token
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"client_type\": \"android\",\n \"credential\": \"your-email / your-username\"\n}"},"url":"{{KNOWLEDGE_BASE_URL}}/workspace/v1/users/274116/sessions","description":"You can use this endpoint to create a new session for a specific user.
\nParams
\ncontent_type: web, meya, android or ioscredential: email or usernamePS: In case you want to provide a session for a user you don't know the exact ID, you can pass a 0 as the ID on the URL, and the credential will be the one used to find the user in the company users list.
This endpoint allows for bulk enrollment of the entire audience that belongs to the Mission in Learning.Rocks.
\nSupported parameters:
\nMission_id: ID of the mission that will receive the bulk enrollment of the entire audience.
\nThe above field is mandatory and cannot be sent empty.
\nImportant:
\nTo handle a large number of simultaneous requests, ensuring that performance is not compromised, we recommend that requests always be made in a paginated manner.
\nRules:
\nEnrollment is only allowed if the mission has a 'Published' status. Therefore, the service should not allow enrollments in missions that are not published or are archived.
\nEnrollment is only allowed for users and teams that belong to the mission's audience. If the mission is public, the API allows enrollment for all users of the company.
\nEnrollment is only allowed if the user does not already have an enrollment in the mission.
\nIf the mission has prerequisites configured, the API only allows enrollments if the user has previously completed all the prerequisites of the respective mission.
\nWhen enrolling a user in the mission, the API records the enrollment access period based on the configured period in the respective Mission:
\nWhen set to 'No expiration date,' the enrollment period will be null. When set to 'Specific date and time,' the enrollment period will be according to the specific date and time configured in the mission. When set to 'Days from the mission enrollment,' the enrollment period will be the number of days configured in the mission after the user's enrollment date.
\nNote: Currently, the definition of the access period serves only as a visual alert to users and not as a block to mission access. In other words, if the access period expires, the mission remains available to the user.
\n","urlObject":{"path":["bulk_enrollment_requests"],"host":["{{MISSION_BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a20a17cf-f289-4583-8946-d463d2bb0a99"},{"name":"Enrollments - by user","id":"50f459a0-cc36-45ec-b7fb-bf50e8e26f86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"url":"{{MISSION_BASE_URL}}/enrollments/by_user/:user_id?limit=10&offset=114_1wgyflf7n3qjsBNzmSTT_570031&enrollment_status=COMPLETED","description":"This endpoint allows you to retrieve the Enrollment History of Users in Missions by User IDs on Learning.Rocks.
\nSupported Parameters:
\nuser_id: User ID for which the history in missions on Learning.Rocks will be retrieved.
\nThe above field is mandatory and cannot be sent empty.
\nImportant:
\nTo handle a large number of simultaneous requests, ensuring that performance is not compromised, the service response will be paginated.
\n","urlObject":{"path":["enrollments","by_user",":user_id"],"host":["{{MISSION_BASE_URL}}"],"query":[{"description":{"content":"Maximum number of results to receive. Maximum is 100.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Last enrollment received.
\n","type":"text/plain"},"key":"offset","value":"114_1wgyflf7n3qjsBNzmSTT_570031"},{"description":{"content":"Enrollments status (IN_PROGRESS|COMPLETED|CANCELLED).
\n","type":"text/plain"},"key":"enrollment_status","value":"COMPLETED"}],"variable":[{"description":{"content":"User ID for which the history in missions on Learning.Rocks will be retrieved.
\n","type":"text/plain"},"type":"any","value":"439391","key":"user_id"}]}},"response":[],"_postman_id":"50f459a0-cc36-45ec-b7fb-bf50e8e26f86"},{"name":"Enrollments - by mission","id":"ef4e9c35-0677-4148-8f53-9f230f34baf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"url":"{{MISSION_BASE_URL}}/enrollments/by_mission/:mission_id?limit=10&offset=114_1wgyflf7n3qjsBNzmSTT_570031&enrollment_status=COMPLETED","description":"This endpoint allows you to retrieve the Enrollment History of Users in Missions by Mission IDs on Learning.Rocks.
\nSupported Parameters:
\nmission_id: ID of the mission or External ID of the mission in the client application for which the enrollment history of users will be retrieved on Learning.Rocks.
\nThe above field is mandatory and cannot be sent empty.
\nImportant:
\nTo handle a large number of simultaneous requests, ensuring that performance is not compromised, the service response will be paginated.
\n","urlObject":{"path":["enrollments","by_mission",":mission_id"],"host":["{{MISSION_BASE_URL}}"],"query":[{"description":{"content":"Maximum number of results to receive. Maximum is 100.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Last enrollment received.
\n","type":"text/plain"},"key":"offset","value":"114_1wgyflf7n3qjsBNzmSTT_570031"},{"description":{"content":"Enrollments status (IN_PROGRESS|COMPLETED|CANCELLED).
\n","type":"text/plain"},"key":"enrollment_status","value":"COMPLETED"}],"variable":[{"description":{"content":"ID of the mission or External ID of the mission in the client application for which the enrollment history of users will be retrieved on Learning.Rocks.
\n","type":"text/plain"},"type":"any","value":"N7p9XSM3szygxcrwAL9s","key":"mission_id"}]}},"response":[],"_postman_id":"ef4e9c35-0677-4148-8f53-9f230f34baf1"},{"name":"Enrollments - by period","id":"44913872-bcf2-4655-a0f4-f63c8435a973","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"url":"{{MISSION_BASE_URL}}/enrollments/by_period?start_date=542948400000&end_date=3698708400000&type=CREATED_AT&limit=10&offset=114_1wgyflf7n3qjsBNzmSTT_570031&enrollment_status=COMPLETED","description":"This endpoint allows you to retrieve the Enrollment History of Users in Missions by period and search type on Learning.Rocks.
\nSupported Query Parameters:
\nstart_date and end_date: Interval to retrieve the history of users in missions on Learning.Rocks.
\ntype: Type of search to retrieve the history of users in missions within the specified period.
\nThe above fields are mandatory and cannot be sent empty.
\nImportant:
\nTo handle a large number of simultaneous requests, ensuring that performance is not compromised, the service response will be paginated.
\nRules:
\nWhen specifying the start_date and end_date of the search period, it will also be mandatory to specify the type (Enrolled in the Period - CREATED_AT, Completed in the Period - COMPLETED_AT, Specific Mission Expiry Date in the Period - MISSION_DUE_DATE).
\nThe start_date cannot be greater than or equal to the end_date of the period.
\n","urlObject":{"path":["enrollments","by_period"],"host":["{{MISSION_BASE_URL}}"],"query":[{"description":{"content":"Start of period as epoch in milliseconds
\n","type":"text/plain"},"key":"start_date","value":"542948400000"},{"description":{"content":"End of period as epoch in milliseconds
\n","type":"text/plain"},"key":"end_date","value":"3698708400000"},{"description":{"content":"Type of date to search: completed_at, created_at, mission.due_date (CREATED_AT|COMPLETED_AT|MISSION_DUE_DATE)
\n","type":"text/plain"},"key":"type","value":"CREATED_AT"},{"description":{"content":"Maximum number of results to receive. Maximum is 100.
\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"Last enrollment received.
\n","type":"text/plain"},"key":"offset","value":"114_1wgyflf7n3qjsBNzmSTT_570031"},{"description":{"content":"Enrollments status (IN_PROGRESS|COMPLETED|CANCELLED).
\n","type":"text/plain"},"key":"enrollment_status","value":"COMPLETED"}],"variable":[]}},"response":[],"_postman_id":"44913872-bcf2-4655-a0f4-f63c8435a973"},{"name":"Associate mission audience","id":"ceaa5f30-17b3-473c-83d8-aa917cc9f78b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mission_id\": \"mission_id\",\n \"user_ids\": [\"user_id\", \"user_id\"],\n \"team_ids\": [\"team_id\", \"team_id\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{MISSION_BASE_URL}}/missions/add_audience","description":"This endpoint allows associating users and teams as the audience for a Mission on Learning.Rocks.
\nSupported Parameters:
\nmission_id: ID of the mission or External ID of the mission in the client application to which the audience will be associated on Learning.Rocks.
user_ids: IDs of the users who will be associated with the audience of the mission on Learning.Rocks.
team_ids: IDs of the teams that will be associated with the audience of the mission on Learning.Rocks.
The mission_id field is mandatory and cannot be sent empty.
\nImportant:
\nTo handle a large number of simultaneous requests, ensuring that performance is not compromised, we recommend that requests be made in a paginated manner.
\n","urlObject":{"path":["missions","add_audience"],"host":["{{MISSION_BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ceaa5f30-17b3-473c-83d8-aa917cc9f78b"},{"name":"Dissociate mission audience","id":"87526615-2100-4020-85b0-0404b20d0930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mission_id\": \"mission_id\",\n \"user_ids\": [\"user_id\", \"user_id\"],\n \"team_ids\": [\"team_id\", \"team_id\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{MISSION_BASE_URL}}/missions/remove_audience","description":"This endpoint allows disassociating users and teams from the audience of a Mission on Learning.Rocks.
\nSupported Parameters:
\nmission_id: ID of the mission or External ID of the mission in the client application for which the audience will be disassociated on Learning.Rocks. user_ids: IDs of the users who will be disassociated from the audience of the mission on Learning.Rocks. team_ids: IDs of the teams that will be disassociated from the audience of the mission on Learning.Rocks.
\nThe mission_id field is mandatory and cannot be sent empty.
\nImportant:
\nTo handle a large number of simultaneous requests, ensuring that performance is not compromised, we recommend that requests be made in a paginated manner.
\n","urlObject":{"path":["missions","remove_audience"],"host":["{{MISSION_BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"87526615-2100-4020-85b0-0404b20d0930"}],"id":"bad94b0e-7b16-4b9a-82b5-9b25c10e231f","_postman_id":"bad94b0e-7b16-4b9a-82b5-9b25c10e231f","description":""}],"event":[{"listen":"prerequest","script":{"id":"fd42d9fc-fb8e-4b24-9f6c-b72a5a27bdeb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4a02a57f-974d-40f8-b963-c2778a91cb24","type":"text/javascript","exec":[""]}}]}