{"info":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","description":"

The Aquarium API is used by Aquarium clients to interact with the server.

Overview

\n
Don't forget to update Postman collection variable with your data.
\n

An account on Aquarium is required to signin and get a token for authenticated routes.
The response of every request is sent as JSON format.
The request method (verb) determines the nature of the action you intend to perform. A request made using the GET method implies that you want to fetch something from Aquarium, and POST implies that you want to save something new to Aquarium.
The API will respond with an appropriate HTTP status code and an error message in format of a JSON object.
The API version number must be specified in the url. your-aquarium.com/v1/...
The body of a request can be send as urlencoded or JSON data, but the Content-Type header must match the format of the data.

Authentication

Use the route signin to get a token or generate a personal access token.
Requests on routes that required authentication must contain a Authorization header containing the token.

If a token is missing, malformed, or invalid, you will receive a 401 Unauthorised response code

Support

Please send an email to support@fatfi.sh if you have any questions.

General conditions

You can read our legal documents here.

More documentation ?

Please visit our documentation website to find more information

Have fun !

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Support","slug":"support"},{"content":"General conditions","slug":"general-conditions"},{"content":"More documentation ?","slug":"more-documentation"}],"owner":"24180587","collectionId":"76f77557-073d-4c32-9bae-909557adc20c","publishedId":"2s93Xzw28w","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"F4AF1C"},"publishDate":"2023-04-17T16:12:40.000Z"},"item":[{"name":"Domain","item":[{"name":"Console","id":"bb4fa907-ca25-40b5-b719-267675f1e85d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"value\": \"help\"\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/console","description":"

Send a command to the domain console.

\n
Permissions: w on the domain usergroup.
\n

Get a list of the licenses uploaded. This includes expired licenses.

\n
Permissions: r on the domain usergroup.
\n

Upload a new license file (.lic).

\n
Permissions: none
\n

\n","urlObject":{"path":["{{version}}","licenses"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[{"id":"362f1683-da98-47b7-9cdf-6b5e4aec2f01","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"A valid license file (.lic)","type":"file","src":"/E:/Aquarium/License.lic"}]},"url":"{{protocole}}{{url}}/{{version}}/licenses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"ef-/GcU4nvfx3WCfm294tiNPjthr3g\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"96ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"214"},{"key":"date","value":"Fri, 03 Feb 2023 12:16:59 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"filename\": \"license.lic\",\n \"software\": \"undefined\",\n \"subscription\": \"mySubscription\",\n \"domain\": \"aquarium\",\n \"users\": 10,\n \"storage\": 1500000000,\n \"expiration\": \"2050-01-21T14:33:09.661+01:00\",\n \"hash\": \"2WbsWXTqbe....\"\n}"}],"_postman_id":"cdf8d2fa-ae27-4ebe-932d-055133bc204b"},{"name":"Remove license","id":"4feb5dd1-ee98-4526-9f63-73d2a7601357","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{protocole}}{{url}}/{{version}}/licenses/:filename","description":"

Remove a license by its filename.

\n
Permissions: d on the domain usergroup.
\n

The name of the license file to remove.

\n","type":"text/plain"},"type":"any","value":"license.lic","key":"filename"}]}},"response":[{"id":"2cc4a389-710b-45ac-8fe1-40e5beb20701","name":"200 OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/licenses/:filename","host":["{{protocole}}{{url}}"],"path":["{{version}}","licenses",":filename"],"variable":[{"key":"filename","value":"license.lic","description":"The license file name to remove."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"8ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-length","value":"2"},{"key":"date","value":"Fri, 03 Feb 2023 12:06:54 GMT"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"a319fb90-b53d-4058-90c0-fe8054db024c","name":"404 License file not found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/licenses/:filename","host":["{{protocole}}{{url}}"],"path":["{{version}}","licenses",":filename"],"variable":[{"key":"filename","value":"license.lic","description":"The name of the license file to remove."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"26-c3OxWage125uWsBJE7ZNbiCtsV8\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"61"},{"key":"date","value":"Fri, 03 Feb 2023 12:14:04 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"license.lic was not found.\"\n}"}],"_postman_id":"4feb5dd1-ee98-4526-9f63-73d2a7601357"},{"name":"Get users","id":"2e8701b7-756c-4eb6-96b3-057ec53813ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/users","description":"

Get a list of the users (active or inactive) existing in the domain.

\n
Permissions: r on the domain usergroup.
\n

Get a list of the uploaded files on this domain.

\n
Permissions: r on the domain usergroup.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","files"],"host":["{{protocole}}{{url}}"],"query":[{"key":"offset","value":"0"},{"key":"limit","value":"100"},{"key":"mimetypes","value":"[\"video/mp4\",\"image/jpeg\"]"},{"key":"filenames","value":"[\"file-1234.mp4\"]"},{"key":"itemKeys","value":"[\"12345\"]"},{"key":"search","value":"\"keyword\""},{"key":"after","value":"\"2024-05-01T08:24:27.164Z\""},{"key":"before","value":"\"2024-05-05T08:24:27.164Z\""}],"variable":[]}},"response":[{"id":"03a4b39a-e161-4ecb-920e-57a42b0542ba","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"7f9-uShU7oo2cC0l1Imhc//R8TqCScY\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"6ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"581"},{"key":"date","value":"Fri, 03 Feb 2023 12:27:16 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_key\": \"38570\",\n \"_id\": \"uploads/38570\",\n \"_rev\": \"_fezOnjy---\",\n \"name\": \"image\",\n \"extension\": \".jpg\",\n \"originalname\": \"image.jpg\",\n \"filename\": \"file-1675260634052-105716b9-f9e3-4849-bdff-21827be92e6c.jpg\",\n \"size\": 1207207,\n \"mimetype\": \"image/jpeg\",\n \"path\": \"\\\\file-1675260634052-105716b9-f9e3-4849-bdff-21827be92e6c.jpg\",\n \"url\": \"/files/file-1675260634052-105716b9-f9e3-4849-bdff-21827be92e6c.web.jpg\",\n \"thumbnail\": \"/files/file-1675260634052-105716b9-f9e3-4849-bdff-21827be92e6c.tmb.jpg\",\n \"height\": 1080,\n \"width\": 1920,\n \"originalHeight\": 4500,\n \"originalWidth\": 8000\n }\n]"}],"_postman_id":"94c064f7-2115-4586-bb7f-d29661a358c3"},{"name":"Upload file","id":"78437aa1-dfe5-4652-8d68-34407cca1081","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","description":"

A file to upload.

\n","type":"file","src":"/E:/Aquarium/video_small.mp4"}]},"url":"{{protocole}}{{url}}/{{version}}/files","description":"

Upload a file and return its meta data. The meta data can also contain a jobKey property. This allows to track the progress of the processing being done on the file (video conversion, audio spectrogram vizualisation,...)

\n
Permissions: none.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","files"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[{"id":"bb7a537b-503f-4b3d-b49d-d390f74e95ba","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"A file to upload.","type":"file","src":"/E:/Aquarium/video_small.mp4"}]},"url":"{{protocole}}{{url}}/{{version}}/files"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"2df-VGAvavF+G5mDvbUVihIS8yhDFwU\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"740ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"360"},{"key":"date","value":"Fri, 03 Feb 2023 12:30:20 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"video_small\",\n \"extension\": \".mp4\",\n \"originalname\": \"video_small.mp4\",\n \"filename\": \"file-1675427420634-0b381f36-b6c4-4a33-b7fd-06f2b008eeb7.mp4\",\n \"size\": 5139255,\n \"mimetype\": \"video/mp4\",\n \"path\": \"\\\\file-1675427420634-0b381f36-b6c4-4a33-b7fd-06f2b008eeb7.mp4\",\n \"url\": \"/files/file-1675427420634-0b381f36-b6c4-4a33-b7fd-06f2b008eeb7.repack.mp4\",\n \"screenshot\": \"/files/file-1675427420634-0b381f36-b6c4-4a33-b7fd-06f2b008eeb7.scr.jpg\",\n \"thumbnail\": \"/files/file-1675427420634-0b381f36-b6c4-4a33-b7fd-06f2b008eeb7.tmb.jpg\",\n \"framerate\": \"60/1\",\n \"height\": 1080,\n \"width\": 1920,\n \"duration\": 12.016992,\n \"nbframes\": 721,\n \"encodingStatus\": \"encoding\",\n \"jobKey\": \"20735591-ab64-412c-a3f5-a11ee28a1cea\"\n}"}],"_postman_id":"78437aa1-dfe5-4652-8d68-34407cca1081"},{"name":"Get file","id":"a758f3fb-a94f-442d-885b-570e34aebdd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/files/:_key","description":"

Get the metadata of a file by its key.

\n
Permissions: r on the domain usergroup.
\n

The key of the file to download.

\n","type":"text/plain"},"type":"any","value":"249588","key":"_key"}]}},"response":[{"id":"372abc05-c2cd-4a9d-86d9-5b9bac300a31","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/files/:_key","host":["{{protocole}}{{url}}"],"path":["{{version}}","files",":_key"],"variable":[{"key":"_key","value":"38766","description":"The key of the file to download."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"263-76cVOBT3OCegth7C7kvZEJvnahw\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"8ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"307"},{"key":"date","value":"Fri, 03 Feb 2023 12:47:23 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"38766\",\n \"_id\": \"uploads/38766\",\n \"_rev\": \"_fezPNqC---\",\n \"name\": \"2023_light\",\n \"extension\": \".jpg\",\n \"originalname\": \"2023_light.jpg\",\n \"filename\": \"file-1675260673490-61654b1f-0f9e-4a68-8646-113f09227856.jpg\",\n \"size\": 102783,\n \"mimetype\": \"image/jpeg\",\n \"path\": \"\\\\file-1675260673490-61654b1f-0f9e-4a68-8646-113f09227856.jpg\",\n \"url\": \"/files/file-1675260673490-61654b1f-0f9e-4a68-8646-113f09227856.web.jpg\",\n \"thumbnail\": \"/files/file-1675260673490-61654b1f-0f9e-4a68-8646-113f09227856.tmb.jpg\",\n \"height\": 960,\n \"width\": 1920,\n \"originalHeight\": 300,\n \"originalWidth\": 600\n}"},{"id":"91510ee6-ce02-4bec-a64d-64a5e6153ff6","name":"404 File not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/files/:_key/download","host":["{{protocole}}{{url}}"],"path":["{{version}}","files",":_key","download"],"variable":[{"key":"_key","value":"1234","description":"The key of the file to download."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"21-QQ9gfFENQkyHio+lDpBGTeQV0Ic\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"56"},{"key":"date","value":"Fri, 03 Feb 2023 12:35:53 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"File #1234 not found.\"\n}"}],"_postman_id":"a758f3fb-a94f-442d-885b-570e34aebdd8"},{"name":"Delete file","id":"40e3112a-2205-4d7f-ba6a-7344b5d0c837","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{protocole}}{{url}}/{{version}}/files/:_key","description":"

Delete a file.

\n
Permissions: d on the domain usergroup.
\n

The key of the file to delete.

\n","type":"text/plain"},"type":"any","value":"249588","key":"_key"}]}},"response":[{"id":"8a7efdff-463e-49e5-8a15-95aeeb0cb200","name":"404 File not found","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":{"raw":"{{protocole}}{{url}}/{{version}}/files/:_key","host":["{{protocole}}{{url}}"],"path":["{{version}}","files",":_key"],"variable":[{"key":"_key","value":"16063","description":"The key of the file to delete."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"22-ld6YDE9iCxTdrJCxXwNko1Vwo3Q\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"57"},{"key":"date","value":"Fri, 03 Feb 2023 12:44:31 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"File #16063 not found.\"\n}"},{"id":"62a94f9f-456a-47e8-bfa5-1a2e1036dc50","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":{"raw":"{{protocole}}{{url}}/{{version}}/files/:_key","host":["{{protocole}}{{url}}"],"path":["{{version}}","files",":_key"],"variable":[{"key":"_key","value":"249588","description":"The key of the file to delete."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"31b-EyoakIFfEoocRpjxe09OyQYEb24\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"7ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"393"},{"key":"date","value":"Fri, 03 Feb 2023 12:44:50 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"249588\",\n \"_id\": \"uploads/249588\",\n \"_rev\": \"_ffb_lEq---\",\n \"name\": \"video_small\",\n \"extension\": \".mp4\",\n \"originalname\": \"video_small.mp4\",\n \"filename\": \"file-1675427420634-0b381f36-b6c4-4a33-b7fd-06f2b008eeb7.mp4\",\n \"size\": 5139255,\n \"mimetype\": \"video/mp4\",\n \"path\": \"\\\\file-1675427420634-0b381f36-b6c4-4a33-b7fd-06f2b008eeb7.mp4\",\n \"url\": \"/files/file-1675427420634-0b381f36-b6c4-4a33-b7fd-06f2b008eeb7.repack.mp4\",\n \"screenshot\": \"/files/file-1675427420634-0b381f36-b6c4-4a33-b7fd-06f2b008eeb7.scr.jpg\",\n \"thumbnail\": \"/files/file-1675427420634-0b381f36-b6c4-4a33-b7fd-06f2b008eeb7.tmb.jpg\",\n \"framerate\": \"60/1\",\n \"height\": 1080,\n \"width\": 1920,\n \"duration\": 12.016992,\n \"nbframes\": 721,\n \"encodingStatus\": \"encoding\",\n \"jobKey\": \"20735591-ab64-412c-a3f5-a11ee28a1cea\"\n}"}],"_postman_id":"40e3112a-2205-4d7f-ba6a-7344b5d0c837"},{"name":"Query","id":"bec84ed0-9338-42c3-805a-07fe8c210bac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"query\": \"# 0,3 item.type == 'Task' VIEW $view\",\n\t\"aliases\": {\n\t\t\"view\": \"item.data.name\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/query","description":"

Execute a domain-wide meshQL query.

\n
Permissions: none.
\n

Execute a domain-wide meshQL query.

\n
Permissions: none.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","query","events"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f481ab05-097e-4a20-b995-eb36f8bc8c2f","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"query\": \"# 0,3 item.type == 'Task' VIEW $view\",\n\t\"aliases\": {\n\t\t\"view\": {\n \"taskName\": \"item.data.name\",\n \"Assignees\": \"# -($Assigned)> * VIEW item.data.name\"\n }\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/query"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"af-eDkgfFmZiubUb9QYKwLND65ivec\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"34ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"81"},{"key":"date","value":"Fri, 03 Feb 2023 12:51:43 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"taskName\": \"Fix pipeline issues\",\n \"Assignees\": [\"John\"]\n },\n {\n \"taskName\": \"Hire junior dev\",\n \"Assignees\": [\"Pauline\"]\n },\n {\n \"taskName\": \"Renew Aquarium licenses\",\n \"Assignees\": [\"Alice\", \"Bob\"]\n }\n]"}],"_postman_id":"06940a76-2672-4fcd-9bf4-96b97a3ccde6"},{"name":"[Not ready for production] Batch","id":"90874028-bae3-4718-bc3f-62c70927ab02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"payload\": [\r\n {\r\n \"method\": \"GET\",\r\n \"route\": \"items\",\r\n \"data\": {\r\n \"_key\": \"{{meKey}}\"\r\n }\r\n },\r\n {\r\n \"method\": \"GET\",\r\n \"route\": \"items\",\r\n \"data\": {\r\n \"_key\": \"{{meKey}}\"\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/batch","description":"

Execute multiple API queries at once.

\n
Permissions: none.
\n

Get the server status.

\n
Permissions: none.
\n

Get the server status as a continuous stream of data (for dashboard apps for example).

\n
Permissions: none.
\n

The endpoint to get an uploaded file.

Get the status of the domain.

\n
Permissions: none.
\n

This section contains all the routes related to the current aquarium domain.

Permissions on usergroup \"domain\" are required to access most of these routes.

\n","event":[{"listen":"prerequest","script":{"id":"6aadd7a6-4465-44a6-8ef5-d781089d4d7a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8b33f5fd-081c-4992-9a30-9d0e37e45e0b","type":"text/javascript","exec":[""]}}],"_postman_id":"c97364ca-7861-4744-b47d-3720db61cdcb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Users","item":[{"name":"Signin","event":[{"listen":"test","script":{"id":"0d43b5f1-ab3b-44c7-a422-b4253664733f","exec":["var jsonData = JSON.parse(responseBody);","postman.setEnvironmentVariable(\"token\", jsonData.token);","pm.environment.set(\"meKey\", jsonData.user._key);"],"type":"text/javascript"}}],"id":"bf1367e6-2c7c-42aa-9e31-2d0893ab6c94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"{{email}}\",\r\n \"password\": \"{{password}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/signin","description":"

\n
Permissions: none
\n

\n","urlObject":{"path":["{{version}}","signin"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[{"id":"961ea90d-8d2e-4d8c-9afb-3e5f9de118ed","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"{{email}}\",\r\n \"password\": \"{{password}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/signin"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"23f-zJnHErYUfO4XUIf5eX5UJwBFWBo\""},{"key":"set-cookie","value":"token=eyJhbGciOiJIUzUxMi....; path=/; expires=...; httponly"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"75ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"423"},{"key":"date","value":"Thu, 02 Feb 2023 13:39:04 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"eyJhbGciOiJIUzUxMi....\",\n \"user\": {\n \"_key\": \"313\",\n \"_id\": \"items/313\",\n \"_rev\": \"_fdOztvK---\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"{{name}}\",\n \"email\": \"{{email}}\"\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.377Z\",\n \"updatedBy\": \"0\",\n \"updatedAt\": \"2026-05-03T20:40:48.377Z\"\n }\n}"},{"id":"369c79d7-aad7-45f6-bbec-57a61cd10da3","name":"403 Invalid credentials","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"{{email}}\",\r\n \"password\": \"wrong password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/signin"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"20-467J/F6acdRKEDWMuJM8AWW0irY\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"52"},{"key":"date","value":"Thu, 02 Feb 2023 15:46:42 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid credentials.\"\n}"}],"_postman_id":"bf1367e6-2c7c-42aa-9e31-2d0893ab6c94"},{"name":"Signout me","event":[{"listen":"test","script":{"id":"0d43b5f1-ab3b-44c7-a422-b4253664733f","exec":[""],"type":"text/javascript"}}],"id":"b4ef4156-0bf8-4294-a34d-b8bd2ef108de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{protocole}}{{url}}/{{version}}/signout","description":"

Sign out the authenticated user.

\n
Permissions: none.
\n

The email address of the user.

\n"}]},"url":"{{protocole}}{{url}}/{{version}}/forgot","description":"

Ask for a new password and receive an email.

\n
Permissions: none.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","forgot"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[{"id":"00791307-f6ee-4a54-82cb-807998e0db40","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"alice@fatfi.sh","type":"text","description":"The email address of the user."}]},"url":"{{protocole}}{{url}}/{{version}}/forgot"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"16-AcjRdTjiiH789r9P9PpHc8woL/g\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"431ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"38"},{"key":"date","value":"Fri, 03 Feb 2023 13:18:23 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"mailer\": \"mail sent\"\n}"},{"id":"d7c61f17-47be-4b2d-9b04-bfa7fd1d5944","name":"404 User not found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"bob@company.com","type":"text","description":"email of the user"}]},"url":"{{protocole}}{{url}}/{{version}}/forgot"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"35-q7HW52IHOGn5MJRveMFz4dHugFs\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"76"},{"key":"date","value":"Fri, 03 Feb 2023 13:09:00 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"No user with email bob@company.com found.\"\n}"}],"_postman_id":"db83ffa6-6403-41d9-aca5-15c00cc96ae2"},{"name":"Reset password","id":"1c1e7d27-9be5-4701-b159-c6c97cf6ef7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"resetPasswordToken\": \"Reset password token sent by email\",\r\n \"resetTokenId\": \"Reset token id\",\r\n \"password\": \"New password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/resetPassword","description":"

Update a user password using reset tokens. Use the /forgot route to get reset tokens.

\n
Permissions: none.
\n

Get the authenticated user profile and its usergroups and organisations.

\n
Permissions: none.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","users","me"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b44c8de2-110f-4270-a960-c9709ee217c0","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/users/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"220-jRziEFFxZ4jb74Wp6FANNw2CJLI\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"86ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"272"},{"key":"date","value":"Fri, 03 Feb 2023 13:24:58 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"_key\": \"{{meKey}}\",\n \"_id\": \"items/{{meKey}}\",\n \"_rev\": \"_fdOztvK---\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"{{name}}\",\n \"email\": \"{{email}}\"\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.378Z\",\n \"updatedBy\": \"0\",\n \"updatedAt\": \"2026-05-03T20:40:48.378Z\"\n },\n \"usergroups\": [\n {\n \"_key\": \"domain\",\n \"_id\": \"items/domain\",\n \"_rev\": \"_fdOzt0W---\",\n \"type\": \"Usergroup\",\n \"data\": {\n \"name\": \"Domain admins\"\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.378Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.378Z\",\n \"createdFrom\": \"domain\"\n }\n ],\n \"organisations\": [\n {\n \"_key\": \"341\",\n \"_id\": \"items/341\",\n \"_rev\": \"_fdOzt06---\",\n \"type\": \"Organisation\",\n \"data\": {\n \"name\": \"Default Organisation\"\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.378Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.378Z\",\n \"createdFrom\": \"341\"\n }\n ]\n}"}],"_postman_id":"936385f0-c451-4aed-92e1-c7bcd8284b32"},{"name":"Get my authenticator devices","id":"df1c0637-17c3-41cb-9dd4-cafc7c2dd14d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/users/me/authenticator","description":"

Get the list of the authentication devices of the connected user.

\n
Permissions: none.
\n

Rename an authenticator device.

\n
Permissions: w on the authenticated user.
\n

The id of the authenticator to rename.

\n","type":"text/plain"},"type":"any","value":"123","key":"id"}]}},"response":[{"id":"66a045a4-7abd-4e70-9e42-8e23724c595f","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"New authenticator name\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/users/me/authenticator/:id","host":["{{protocole}}{{url}}"],"path":["{{version}}","users","me","authenticator",":id"],"variable":[{"key":"id","value":"abc123","description":"The id of the authenticator to rename."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"1a5-/4T/IlZhnvT6cBULnxOWvVd4Ds4\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"7ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"338"},{"key":"date","value":"Fri, 03 Feb 2023 13:41:42 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"New authenticator name\",\n \"id\": \"abc123\",\n \"publicKey\": \"-----BEGIN PUBLIC KEY-----\\nMFk...DMw==\\n-----END PUBLIC KEY-----\\n\",\n \"type\": \"public-key\",\n \"transports\": [\n \"usb\"\n ],\n \"counter\": 1,\n \"createdAt\": \"2026-05-03T20:40:48.381Z\",\n \"lastUsed\": \"2026-05-03T20:40:48.381Z\"\"\n}"},{"id":"b7bc0405-f5aa-447c-825b-0373c9a8bb02","name":"404 Authenticator not found","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"New authenticator name\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/users/me/authenticator/:id","host":["{{protocole}}{{url}}"],"path":["{{version}}","users","me","authenticator",":id"],"variable":[{"key":"id","value":"123","description":"The id of the authenticator to rename."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"29-v2T9Y4whyrrJP0iMW4A8WC3Mubg\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"64"},{"key":"date","value":"Fri, 03 Feb 2023 13:41:24 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Can't find authenticator #123\"\n}"}],"_postman_id":"17083031-2b26-4be5-8c59-7ba1ecb88d64"},{"name":"Remove authenticator","id":"33161536-a9ee-446c-baf6-041df635ca2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":"{{protocole}}{{url}}/{{version}}/users/me/authenticator/:id","description":"

Remove an authenticator device.

\n
Permissions: w on the authenticated user.
\n

The id of the authenticator to remove.

\n","type":"text/plain"},"type":"any","value":"abc123","key":"id"}]}},"response":[{"id":"77652022-12cd-495e-be7b-59bed1c9357b","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"{{token}}"}],"url":{"raw":"{{protocole}}{{url}}/{{version}}/users/me/authenticator/:id","host":["{{protocole}}{{url}}"],"path":["{{version}}","users","me","authenticator",":id"],"variable":[{"key":"id","value":"abc123","description":"The id of the authenticator to remove."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"1a7-IFq+BOykxiB98zcb7tFo8VFsdxk\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"5ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"340"},{"key":"date","value":"Fri, 03 Feb 2023 13:43:33 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"New authenticator name\",\n \"id\": \"abc123\",\n \"publicKey\": \"-----BEGIN PUBLIC KEY-----\\nMF...DMw==\\n-----END PUBLIC KEY-----\\n\",\n \"type\": \"public-key\",\n \"transports\": [\n \"usb\"\n ],\n \"counter\": 1,\n \"createdAt\": \"2026-05-03T20:40:48.381Z\",\n \"lastUsed\": \"2026-05-03T20:40:48.381Z\"\n }\n]"}],"_postman_id":"33161536-a9ee-446c-baf6-041df635ca2c"},{"name":"Get user profile","id":"d930fc4b-b33d-45cb-a13a-4d982bccc0fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/users/:_key","description":"

Get the profile informations of a user.

\n
Permissions: r on the user.
\n

The key of the user to get.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"783b0b02-20e4-4607-8a29-bb2997edcaa2","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":{"raw":"{{protocole}}{{url}}/{{version}}/users/:_key","host":["{{protocole}}{{url}}"],"path":["{{version}}","users",":_key"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the user to get."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"322-O3aFpraeb3nHv1F3IL6YoWnPcns\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"85ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"316"},{"key":"date","value":"Fri, 03 Feb 2023 13:47:24 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"_key\": \"{{meKey}}\",\n \"_id\": \"items/{{meKey}}\",\n \"_rev\": \"_fdOztvK---\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"{{name}}\",\n \"email\": \"{{email}}\"\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.381Z\",\n \"updatedBy\": \"0\",\n \"updatedAt\": \"2026-05-03T20:40:48.381Z\"\n },\n \"usergroups\": [\n {\n \"_key\": \"domain\",\n \"_id\": \"items/domain\",\n \"_rev\": \"_fdOzt0W---\",\n \"type\": \"Usergroup\",\n \"data\": {\n \"name\": \"Domain admins\"\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.381Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.381Z\",\n \"createdFrom\": \"domain\"\n }\n ],\n \"organisations\": [\n {\n \"_key\": \"341\",\n \"_id\": \"items/341\",\n \"_rev\": \"_fdOzt06---\",\n \"type\": \"Organisation\",\n \"data\": {\n \"name\": \"Default Organisation\"\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.381Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.381Z\",\n \"createdFrom\": \"341\"\n }\n ]\n}"},{"id":"217800b7-0dd8-4b44-8f0a-b7e6e2bc5643","name":"403 Not allowed","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":{"raw":"{{protocole}}{{url}}/{{version}}/users/:_key","host":["{{protocole}}{{url}}"],"path":["{{version}}","users",":_key"],"variable":[{"key":"_key","value":"123","description":"The key of the user to get."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"2d-/X+J1aWeGqijPeILrF5aeBpp52Y\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"68"},{"key":"date","value":"Fri, 03 Feb 2023 13:48:30 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Read is not allowed on item #123.\"\n}"}],"_postman_id":"d930fc4b-b33d-45cb-a13a-4d982bccc0fa"},{"name":"Create a user","event":[{"listen":"test","script":{"id":"0d43b5f1-ab3b-44c7-a422-b4253664733f","exec":[""],"type":"text/javascript"}}],"id":"de54ddf2-93b2-4874-b281-f6c6229b0eb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Alice\",\r\n \"email\": \"alice@fatfi.sh\",\r\n \"password\": \"password\",\r\n \"inviteExpiration\": 60\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/users","description":"

Create a user on the domain. If the number of active user exceeds the maximum of users allowed by all the valid licenses combined, then an inactive user will be created.

You can use the property inviteExpiration to choose how many seconds the invitation is valid. This property is ignored if a password is provided.

\n
Permissions: w on the domain usergroup.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","users"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[{"id":"cbb440d4-6fe1-4045-a444-3e22d79aaff2","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Alice\",\r\n \"email\": \"alice@fatfi.sh\",\r\n \"password\": \"password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"ef-iOGtJlwFz4jR8JETKnpT5TWqBMM\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"146ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"168"},{"key":"date","value":"Fri, 03 Feb 2023 13:14:23 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"User\",\n \"data\": {\n \"name\": \"Alice\",\n \"email\": \"alice@fatfi.sh\"\n },\n \"active\": true,\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.382Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.382Z\",\n \"_id\": \"items/251592\",\n \"_key\": \"251592\"\n}"},{"id":"365d79e0-7099-4cba-a167-f1c4ab79cf18","name":"409 User already exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Alice\",\r\n \"email\": \"alice@fatfi.sh\",\r\n \"password\": \"password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/users"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"3a-Ty6+7xojBN2JjUyL/gMMm7rTUEY\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"74"},{"key":"date","value":"Fri, 03 Feb 2023 13:15:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"A user with this email address already exists.\"\n}"}],"_postman_id":"de54ddf2-93b2-4874-b281-f6c6229b0eb1"},{"name":"Set user active/inactive","id":"ed5c1be6-7d21-4e87-9c85-04906fafed25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"activate\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/users/:_key/active","description":"

Change the state of a user (active/inactive).

\n
Permissions: w on the user.
\n

The key of the user to set active.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"43e3d804-0d8a-48d9-9d9a-cd6e6f7e3ebd","name":"200 OK","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"activate\": true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/users/:_key/active","host":["{{protocole}}{{url}}"],"path":["{{version}}","users",":_key","active"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the user to set active."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"f3-osJZvHGPganFZnsSd2AIba8Rbvg\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"6ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"169"},{"key":"date","value":"Fri, 03 Feb 2023 13:49:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"313\",\n \"_id\": \"items/313\",\n \"_rev\": \"_fdOztvK---\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"System\",\n \"email\": \"System\"\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2023-01-27T18:10:41.170+01:00\",\n \"updatedBy\": \"0\",\n \"updatedAt\": \"2023-01-27T18:10:41.170+01:00\"\n}"}],"_postman_id":"ed5c1be6-7d21-4e87-9c85-04906fafed25"},{"name":"UpdatePassword","id":"7e738ed8-892f-4996-aa3b-760f82cadf6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"password","value":"{{password}}","type":"text","description":"

The new password.

\n"}]},"url":"{{protocole}}{{url}}/{{version}}/users/:_key/password","description":"

Update the password of a user.

\n
Permissions: w on the user.
\n

The key of the user to update

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"27ca552a-d6f1-4dc0-b160-35eefec9707e","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"{{token}}"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"password","value":"{{password}}","type":"text","description":"new password"}]},"url":{"raw":"{{protocole}}{{url}}/{{version}}/users/:_key/password","host":["{{protocole}}{{url}}"],"path":["{{version}}","users",":_key","password"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the user to update"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"f3-osJZvHGPganFZnsSd2AIba8Rbvg\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"85ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"169"},{"key":"date","value":"Fri, 03 Feb 2023 13:52:15 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"{{meKey}}\",\n \"_id\": \"items/{{meKey}}\",\n \"_rev\": \"_fdOztvK---\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"{{name}}\",\n \"email\": \"{{email}}\"\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.382Z\",\n \"updatedBy\": \"0\",\n \"updatedAt\": \"2026-05-03T20:40:48.382Z\"\n}"}],"_postman_id":"7e738ed8-892f-4996-aa3b-760f82cadf6c"},{"name":"Get MFA status","id":"b72b9e76-7f23-4f49-a11c-c80a54d304b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":"{{protocole}}{{url}}/{{version}}/users/:_key/mfa/status","description":"

Get the status of the Multiple Authentication Factor system for this user.

\n
Permissions: r on the user.
\n

The key of the user to get multifactor authentication status from.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"64710ee2-c090-4d63-b9b9-c106d10eff99","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"url":{"raw":"{{protocole}}{{url}}/{{version}}/users/:_key/mfaStatus","host":["{{protocole}}{{url}}"],"path":["{{version}}","users",":_key","mfaStatus"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the user to get multifactor auth status from."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"15-2D5NhcgYSRZ/GzlwuMVW+K8/xsI\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"5ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"41"},{"key":"date","value":"Fri, 03 Feb 2023 13:56:13 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"inactive\"\n}"}],"_postman_id":"b72b9e76-7f23-4f49-a11c-c80a54d304b1"},{"name":"Signout user","event":[{"listen":"test","script":{"id":"0d43b5f1-ab3b-44c7-a422-b4253664733f","exec":[""],"type":"text/javascript"}}],"id":"58bf6387-1911-49a6-a7fd-8567b9b6d713","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{protocole}}{{url}}/{{version}}/users/:_key/signout","description":"

Sign out a user.

\n
Permissions: w on the user.
\n

The key of the user to sign out.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"6a541937-5996-4a31-9280-db51e263c694","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/users/:_key/signout","host":["{{protocole}}{{url}}"],"path":["{{version}}","users",":_key","signout"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the user to sign out."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"17-hUrORnaav54A93bpptmW8r/p4oI\""},{"key":"set-cookie","value":"token=; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT; httponly"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"10ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"43"},{"key":"date","value":"Fri, 03 Feb 2023 13:58:02 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"signed_out\"\n}"}],"_postman_id":"58bf6387-1911-49a6-a7fd-8567b9b6d713"},{"name":"Seek","id":"a0602160-a524-415e-9008-0961d0973c84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/users/seek/:name","description":"

Search for a user or usergroup whose name starts with the provided string.

\n
Permissions: none.
\n

A string to be searched for within users names

\n","type":"text/plain"},"type":"any","value":"Sys","key":"name"}]}},"response":[{"id":"61b066e0-3d4d-4af6-83cf-f0ba94f09a32","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/users/seek/:name","host":["{{protocole}}{{url}}"],"path":["{{version}}","users","seek",":name"],"variable":[{"key":"name","value":"Sys","description":"A string to be searched for within users names."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"f5-RJNPxPEifUBisfLVgmRc/MHBh0Q\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"13ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"172"},{"key":"date","value":"Fri, 03 Feb 2023 14:00:02 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_key\": \"{{meKey}}\",\n \"_id\": \"items/{{meKey}}\",\n \"_rev\": \"_fdOztvK---\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"{{name}}\",\n \"email\": \"{{email}}\"\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.384Z\",\n \"updatedBy\": \"0\",\n \"updatedAt\": \"2026-05-03T20:40:48.384Z\"\n }\n]"}],"_postman_id":"a0602160-a524-415e-9008-0961d0973c84"},{"name":"Get my personal access tokens","id":"788c5095-e529-47a0-98cb-8e804928c70a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/users/me/tokens","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","users","me","tokens"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"788c5095-e529-47a0-98cb-8e804928c70a"},{"name":"Create a personal access token","id":"3f1cc285-d958-44bc-82ef-57da066052e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"My personal token\",\n \"expireAt\": \"2023-04-14T15:17:00.860+02:00\"\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/users/me/tokens","description":"

This endpoint allows the user to generate tokens for the current user. The HTTP POST request should be made to /users/me/tokens.

Request

The request should include a JSON payload in the raw request body type with the following parameters:

name (string, required): The name of the token.
expireAt (string, required): The expiration date and time of the token.

Response

The response will be in JSON format and will follow the JSON schema. The schema will include the structure and data types of the response body, providing a clear understanding of the expected response format.

The id of the token to rename

\n","type":"text/plain"},"type":"any","value":"{{tokenId}}","key":"id"}]}},"response":[],"_postman_id":"00a83344-0a00-469b-8a2e-d38e32f45471"},{"name":"Re-generate a personal access token","id":"24480ae0-c1c8-4356-8a2a-1ef08a807ad7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"expireAt\": \"2023-12-31\"\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/users/me/tokens/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","users","me","tokens",":id"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[{"id":"47ed282b-e64f-4488-8485-d485933c1a2f","description":{"content":"

The id of the token to rename

\n","type":"text/plain"},"type":"any","value":"{{tokenId}}","key":"id"}]}},"response":[],"_postman_id":"24480ae0-c1c8-4356-8a2a-1ef08a807ad7"},{"name":"Delete a personal access token","id":"de0aa5f9-b2f3-4fd9-b868-67e04bd38c06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{protocole}}{{url}}/{{version}}/users/me/tokens/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","users","me","tokens",":id"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[{"id":"47ed282b-e64f-4488-8485-d485933c1a2f","description":{"content":"

The id of the token to rename

\n","type":"text/plain"},"type":"any","value":"{{tokenId}}","key":"id"}]}},"response":[],"_postman_id":"de0aa5f9-b2f3-4fd9-b868-67e04bd38c06"},{"name":"Delete all personal access tokens","id":"d0065345-455d-42c4-8b59-3064c933bb55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{protocole}}{{url}}/{{version}}/users/me/tokens","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","users","me","tokens"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0065345-455d-42c4-8b59-3064c933bb55"}],"id":"66376d25-7bcf-4d86-b778-ad9b9179ec86","description":"

User-related operations, such as login, password update, getting profiles...

\n","_postman_id":"66376d25-7bcf-4d86-b778-ad9b9179ec86","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Items","item":[{"name":"Get an item","id":"f1d16224-fe92-4be2-a77a-d8debfc28202","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/items/:_key?populate=true","description":"

Get an item by its _key property.

\n
Permissions: r
\n

Include item history.

\n","type":"text/plain"},"key":"history","value":"true"},{"description":{"content":"

Replace the strings \"createdBy\" and \"updatedBy\" by an object representing a user.

\n","type":"text/plain"},"key":"populate","value":"true"}],"variable":[{"description":{"content":"

The key of the item to get.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"16f97e0a-b54b-45be-b18a-cb027729e046","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key"],"query":[{"key":"history","value":"true","description":"[Boolean] include item history","disabled":true},{"key":"populate","value":"true","description":"[Boolean] replace the strings \"createdBy\" and \"updatedBy\" by an object representing a user","disabled":true}],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item to get."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"f3-osJZvHGPganFZnsSd2AIba8Rbvg\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"7ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"169"},{"key":"date","value":"Fri, 03 Feb 2023 14:10:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"{{meKey}}\",\n \"_id\": \"items/{{meKey}}\",\n \"_rev\": \"_fdOztvK---\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"{{name}}\",\n \"email\": \"{{email}}\"\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.385Z\",\n \"updatedBy\": \"0\",\n \"updatedAt\": \"2026-05-03T20:40:48.385Z\"\n}"},{"id":"0725a349-cb2a-4530-b333-ec9d35a86c08","name":"200 With history","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key?history=true","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key"],"query":[{"key":"history","value":"true","description":"[Boolean] include item history"},{"key":"populate","value":"true","description":"[Boolean] replace the strings \"createdBy\" and \"updatedBy\" by an object representing a user","disabled":true}],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item to get."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"358-LjUV+oYNpBWiKA/e4/Db6rPazuE\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"5ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"332"},{"key":"date","value":"Fri, 03 Feb 2023 14:13:43 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"{{meKey}}\",\n \"_id\": \"items/{{meKey}}\",\n \"_rev\": \"_ffce-DC---\",\n \"type\": \"User\",\n \"data\": {\n \"email\": \"System\",\n \"name\": \"System\",\n \"thumbnail\": null\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2023-01-27T18:10:41.170+01:00\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2023-02-03T15:13:27.248+01:00\",\n \"history\": [\n {\n \"_key\": \"254873\",\n \"_id\": \"items_history/254873\",\n \"_rev\": \"_ffce-D----\",\n \"originalKey\": \"313\",\n \"message\": \"\",\n \"type\": \"User\",\n \"data\": {\n \"email\": \"system@fatfi.sh\",\n \"name\": \"System\",\n \"thumbnail\": null\n },\n \"createdBy\": \"0\",\n \"createdAt\": \"2023-02-03T15:13:01.436+01:00\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2023-02-03T15:13:01.436+01:00\"\n },\n {\n \"_key\": \"254676\",\n \"_id\": \"items_history/254676\",\n \"_rev\": \"_ffcdk16---\",\n \"originalKey\": \"313\",\n \"message\": \"\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"System\",\n \"email\": \"System\"\n },\n \"createdBy\": \"0\",\n \"createdAt\": \"2023-01-27T18:10:41.170+01:00\",\n \"updatedBy\": \"0\",\n \"updatedAt\": \"2023-01-27T18:10:41.170+01:00\"\n }\n ]\n}"},{"id":"b3ca761a-bbfe-400d-9a26-38ac1650cf47","name":"200 Populated","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key?populate=true","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key"],"query":[{"key":"history","value":"true","description":"Include item history.","disabled":true},{"key":"populate","value":"true","description":"Replace the strings \"createdBy\" and \"updatedBy\" by an object representing a user."}],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item to get."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"208-IflIpuxbWcXuVXECF/gwamWtl/Y\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"5ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"239"},{"key":"date","value":"Fri, 03 Feb 2023 14:14:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"items/{{meKey}}\",\n \"_key\": \"{{meKey}}\",\n \"_rev\": \"_ffce-DC---\",\n \"active\": true,\n \"createdAt\": \"2023-01-27T18:10:41.170+01:00\",\n \"createdBy\": null,\n \"data\": {\n \"email\": \"{{email}}\",\n \"name\": \"{{name}}\",\n \"thumbnail\": null\n },\n \"type\": \"User\",\n \"updatedAt\": \"2026-05-03T20:40:48.386Z\",\n \"updatedBy\": {\n \"_key\": \"{{meKey}}\",\n \"_id\": \"items/{{meKey}}\",\n \"_rev\": \"_ffce-DC---\",\n \"type\": \"User\",\n \"data\": {\n \"email\": \"{{email}}\",\n \"name\": \"{{name}}\",\n \"thumbnail\": null\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.386Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.386Z\"\n }\n}"},{"id":"dab8e667-4f3f-4a4d-a832-7fd6402e8d32","name":"403 Not allowed","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key"],"query":[{"key":"history","value":"true","description":"Include item history.","disabled":true},{"key":"populate","value":"true","description":"Replace the strings \"createdBy\" and \"updatedBy\" by an object representing a user.","disabled":true}],"variable":[{"key":"_key","value":"123","description":"The key of the item to get."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"2d-/X+J1aWeGqijPeILrF5aeBpp52Y\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"68"},{"key":"date","value":"Fri, 03 Feb 2023 14:18:56 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Read is not allowed on item #123.\"\n}"}],"_postman_id":"f1d16224-fe92-4be2-a77a-d8debfc28202"},{"name":"Create an item","id":"3e7a1a6a-1040-44f7-857d-fa3452c317bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"type\": \"Task\",\r\n \"data\": {\r\n \"name\": \"My new task\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items","description":"

Create an item. This item won't be attached to any other item, therefore unreachable using a traversal. Use its _key or _id to retrieve it with the routes GET /items/:_key or POST /query. To create an item attached to an existing one, use the route POST /items/existingItemKey/append.

\n
Permissions: w
\n

Update an item. This will completely replace the existing data by the provided data.

\n
Permissions: w on the item to update.
\n

The key of the item to modify.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"cb08765e-b0a6-48a9-9a45-3c447390b33f","name":"200 OK","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {\r\n \"completion\": 0.75\r\n },\r\n \"history\": true,\r\n \"message\": \"Completion updated !\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key"],"variable":[{"key":"_key","value":"280305","description":"The key of the item to modify."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"f7-8sL2o+1qyDoH45wzM7lKq5NvULc\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"6ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"178"},{"key":"date","value":"Fri, 03 Feb 2023 16:35:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"280305\",\n \"_id\": \"items/280305\",\n \"_rev\": \"_ffefL7K---\",\n \"type\": \"Task\",\n \"data\": {\n \"completion\": 0.75\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2023-02-03T17:32:22.032+01:00\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2023-02-03T17:35:32.697+01:00\",\n \"createdFrom\": \"280305\"\n}"}],"_postman_id":"796f51a5-724e-4e94-a70d-91a0dc5917db"},{"name":"Patch an item","id":"45ac0486-1abd-4d3f-8e20-470ebf8fc025","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"name\": \"System\"\n },\n \"deepMerge\": true,\n \"history\": true,\n \"message\": \"Patched !\"\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key","description":"

Patch an item. This will merge the provided data with the existing.

\n
Permissions: w on the item to patch.
\n

The key of the item to patch.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"537f468f-dada-4e39-8ca3-70901f659acf","name":"200 OK","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"name\": \"Task to update\",\n \"status\": \"RTK\",\n \"completion\": 0.5,\n \"checklist\": [],\n \"color\": \"#f35415\",\n \"valid\": false\n },\n \"history\": true,\n \"message\": \"Patched !\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key"],"variable":[{"key":"_key","value":"280305","description":"The key of the item to patch."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"14c-VD7j0WMKbfs4jPOv2nVy4PLhdFQ\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"6ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"237"},{"key":"date","value":"Fri, 03 Feb 2023 16:36:52 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"280305\",\n \"_id\": \"items/280305\",\n \"_rev\": \"_ffegDrm--_\",\n \"type\": \"Task\",\n \"data\": {\n \"completion\": 0.5,\n \"name\": \"Task to update\",\n \"status\": \"RTK\",\n \"checklist\": [],\n \"color\": \"#f35415\",\n \"valid\": false\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2023-02-03T17:32:22.032+01:00\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2023-02-03T17:36:53.637+01:00\",\n \"createdFrom\": \"280305\"\n}"}],"_postman_id":"45ac0486-1abd-4d3f-8e20-470ebf8fc025"},{"name":"Remove an item","id":"4e0ab4a1-345f-4e19-a7da-569da53b8b5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{protocole}}{{url}}/{{version}}/items/:_key","description":"

completely delete an item.\nTo simply trash an item, please see the \"trash\" section.

\n
Authenticated.\nPermissions: d on the item to delete.
\n

The key of the item to remove.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"ae3dbfae-2152-4579-b48e-1c466629f34a","name":"200 OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key"],"variable":[{"key":"_key","value":"279994","description":"The key of the item to remove."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"ff-ogncYH5haFPralNVA+WcH/XIXI0\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"7ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"180"},{"key":"date","value":"Fri, 03 Feb 2023 16:31:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"279994\",\n \"_id\": \"items/279994\",\n \"_rev\": \"_ffecSDS---\",\n \"type\": \"Group\",\n \"data\": {\n \"name\": \"Group to remove\"\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.387Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.387Z\",\n \"createdFrom\": \"279994\"\n}"}],"_postman_id":"4e0ab4a1-345f-4e19-a7da-569da53b8b5e"},{"name":"Get an item history","id":"14c1894d-90d1-43ce-8bab-94602c2f5e3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/items/:_key/history","description":"

Get all the versions of a specific item.

\n
Authenticated.\nPermissions: r on the item retrieved.
\n

Replace \"createdBy\" and \"updatedBy\" keys with user data.

\n","type":"text/plain"},"key":"populate","value":"true"}],"variable":[{"description":{"content":"

The key of the item from which to get the versions.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"fd91274a-668f-45bc-82f3-90e4de57c303","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/history","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","history"],"query":[{"key":"populate","value":"true","description":"Replace \"createdBy\" and \"updatedBy\" keys with user data.","disabled":true}],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item from which to get the versions."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"247-bMg83n3SA2bM9XgLVB7tfnrRpAk\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"5ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"270"},{"key":"date","value":"Fri, 03 Feb 2023 16:13:30 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_key\": \"254873\",\n \"_id\": \"items_history/254873\",\n \"_rev\": \"_ffce-D----\",\n \"originalKey\": \"313\",\n \"message\": \"\",\n \"type\": \"User\",\n \"data\": {\n \"email\": \"system@fatfi.sh\",\n \"name\": \"System\",\n \"thumbnail\": null\n },\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.387Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.387Z\"\n },\n {\n \"_key\": \"254676\",\n \"_id\": \"items_history/254676\",\n \"_rev\": \"_ffcdk16---\",\n \"originalKey\": \"313\",\n \"message\": \"\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"System\",\n \"email\": \"System\"\n },\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.387Z\",\n \"updatedBy\": \"0\",\n \"updatedAt\": \"2026-05-03T20:40:48.387Z\"\n }\n]"}],"_postman_id":"14c1894d-90d1-43ce-8bab-94602c2f5e3d"},{"name":"Traverse","id":"0e8e55b5-418f-45dc-b715-f7108d3b02c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"query\": \"# -()> 0, 3 * VIEW $output\",\r\n \"aliases\": {\r\n \"output\": {\r\n \"name\": \"item.data.name\",\r\n \"createdBy\": \"GETITEM(item.createdBy).data.name\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/traverse","description":"

Query the items connected to a specific item.

\n
Authenticated.\nPermissions: r on each item being traversed.
\n

The key of the item from which to start the traversal (startpoint).

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"9228a67f-0e76-4097-89ec-60a30252f9db","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"query\": \"# -()> 0, 3 * VIEW $output\",\r\n \"aliases\": {\r\n \"output\": {\r\n \"name\": \"item.data.name\",\r\n \"createdBy\": \"GETITEM(item.createdBy).data.name\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/traverse","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","traverse"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item from which to start the traversal (startpoint)."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"86-BGenVQCUj9mNJoDvIFruo0fxVDM\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"6ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"92"},{"key":"date","value":"Fri, 03 Feb 2023 16:16:28 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"asdf, asdf.\",\n \"createdBy\": \"System\"\n },\n {\n \"name\": \"Card\",\n \"createdBy\": \"System\"\n },\n {\n \"name\": \"Copy of asdf, asdf.\",\n \"createdBy\": \"System\"\n }\n]"},{"id":"6bb0d473-ffff-408d-9d0d-ac6249c98f35","name":"400 Runtime exceeded","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"query\": \"# -(99)> 0, 100 * VIEW $output\",\r\n \"aliases\": {\r\n \"output\": {\r\n \"name\": \"item.data.name\",\r\n \"createdBy\": \"GETITEM(item.createdBy).data.name\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/traverse","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","traverse"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item from which to start the traversal (startpoint)."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"3d-PVvoNDGMKzPuGyPJFCeasPBhZTA\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"84"},{"key":"date","value":"Fri, 03 Feb 2023 16:15:21 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"The query exceeded the maximum time allowed (5s).\"\n}"}],"_postman_id":"0e8e55b5-418f-45dc-b715-f7108d3b02c5"},{"name":"Append","id":"b234cd3d-c5f2-4fc9-be61-431cd03df793","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"item\": {\n\t\t\"type\": \"Group\",\n \"data\": {\n \"name\": \"my new group\"\n }\n\t},\n\t\"edge\": {\n\t\t\"type\": \"Child\"\n\t},\n\t\"applyTemplate\": false,\n\t\"templateKey\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/append","description":"

Attach a new item to an existing item with an edge of type \"Child\"

\n
Authenticated.\nPermissions: a on the item on which the new item will be attached.
\n

The key of the item on which to append a new item.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"052543f7-b878-41c8-b404-ffea7211256d","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"item\": {\n\t\t\"type\": \"Group\",\n \"data\": {\n \"name\": \"my new group\"\n }\n\t},\n\t\"edge\": {\n\t\t\"type\": \"Child\"\n\t},\n\t\"applyTemplate\": false,\n\t\"templateKey\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/append","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","append"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item on which to append a new item."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"232-AcbiOKA0GeV56RBChgtadgoU7nI\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"7ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"270"},{"key":"date","value":"Fri, 03 Feb 2023 16:40:07 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"item\": {\n \"_key\": \"281354\",\n \"type\": \"Group\",\n \"data\": {\n \"name\": \"my new group\"\n },\n \"createdFrom\": \"281354\",\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.388Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.388Z\",\n \"_id\": \"items/281354\",\n \"_rev\": \"_ffekQnK---\"\n },\n \"edge\": {\n \"_key\": \"281357\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 421836\n },\n \"_from\": \"items/313\",\n \"_to\": \"items/281354\",\n \"createdFrom\": \"281357\",\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.388Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.388Z\",\n \"_id\": \"connections/281357\",\n \"_rev\": \"_ffekQnO--_\"\n }\n}"}],"_postman_id":"b234cd3d-c5f2-4fc9-be61-431cd03df793"},{"name":"Upload","id":"2fe3be09-ba4b-49c9-946d-ab027e70dcf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/E:/Aquarium/image.jpg"}]},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/upload","description":"

Attach a new file to an existing item.

\n
Authenticated.\nPermissions: w on the item on which the new file will be attached.
\n

The key of the item on which to upload the file. This will patch the item with the metadata of the file.

\n","type":"text/plain"},"type":"any","value":"281578","key":"_key"}]}},"response":[{"id":"02caf599-14a2-404d-a945-1e4e25503830","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/E:/Aquarium/image.jpg"}]},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/upload","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","upload"],"variable":[{"key":"_key","value":"281578","description":"The key of the item on which to upload the file. This will patch the item with the metadata of the file."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"308-VLfFgru1reGP2rv28yRr1W4AvcM\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"468ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"392"},{"key":"date","value":"Fri, 03 Feb 2023 16:43:33 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"281578\",\n \"_id\": \"items/281578\",\n \"_rev\": \"_ffenDGq--_\",\n \"type\": \"Media\",\n \"data\": {\n \"name\": \"image\",\n \"height\": 1080,\n \"extension\": \".jpg\",\n \"filename\": \"file-1675442614050-4db3c7ea-c63c-46ea-991d-96a5740cfd49.jpg\",\n \"mimetype\": \"image/jpeg\",\n \"originalWidth\": 8000,\n \"originalname\": \"image.jpg\",\n \"originalHeight\": 4500,\n \"path\": \"\\\\file-1675442614050-4db3c7ea-c63c-46ea-991d-96a5740cfd49.jpg\",\n \"size\": 1207207,\n \"thumbnail\": \"/files/file-1675442614050-4db3c7ea-c63c-46ea-991d-96a5740cfd49.tmb.jpg\",\n \"url\": \"/files/file-1675442614050-4db3c7ea-c63c-46ea-991d-96a5740cfd49.web.jpg\",\n \"width\": 1920\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.388Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.388Z\",\n \"createdFrom\": \"281578\"\n}"}],"_postman_id":"2fe3be09-ba4b-49c9-946d-ab027e70dcf9"},{"name":"Download item file","id":"272ac9d3-7b3b-494c-aa2c-8c17679e7615","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/items/:_key/download?versionKey","description":"

Download the file attached to an item if existing.

\n
Authenticated.\nPermissions: r on the item.
\n

The key of the version of the item to which the file to download is attached.

\n","type":"text/plain"},"key":"versionKey","value":null}],"variable":[{"description":{"content":"

The key of the item to which the file to download is attached.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[],"_postman_id":"272ac9d3-7b3b-494c-aa2c-8c17679e7615"},{"name":"Move an item","id":"e53b982e-8ac7-428c-bf1c-593cb715b4f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"description":"

The key of the original parent item.

\n","key":"oldParentKey","type":"text","value":"{{oldParentKey}}"},{"description":"

The key of the new parent item.

\n","key":"newParentKey","type":"text","value":"{{newParentKey}}"}]},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/move","description":"

Move an item to change its parent. Affects inbount edge of type \"Child\"

\n
Authenticated.\nPermissions: w on the item being moved, a on the target item newParentKey.
\n

The key of the item to move.

\n","type":"text/plain"},"type":"any","value":"1234","key":"_key"}]}},"response":[],"_postman_id":"e53b982e-8ac7-428c-bf1c-593cb715b4f0"},{"name":"Copy an item","id":"31918e04-2f76-45ce-a957-4b9857504fec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"targetKey\": \"3865804\",\r\n \"prefixed\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/copy","description":"

Copy an item to duplicate it.

\n
Authenticated.\nPermissions: r on the item to copy, a on the target item defined by the parameter parentKey.
\n

The key of the item and its content to copy.

\n","type":"text/plain"},"type":"any","value":"1234","key":"_key"}]}},"response":[],"_postman_id":"31918e04-2f76-45ce-a957-4b9857504fec"},{"name":"Import","id":"7e07da03-24d2-4a11-bb0d-d680be8af3f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"items\": [{\n \"type\": \"Task\",\n \"data\": {\n \"name\": \"Imported task\"\n }\n }],\n\t\"edges\": []\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/import/:format","description":"

Query the items connected to a specific item.

\n
Authenticated.\nPermissions: r on each item being traversed.
\n

The key of the item to import.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"},{"description":{"content":"

The format of the data imported.

\n","type":"text/plain"},"type":"any","value":"json","key":"format"}]}},"response":[{"id":"8a4609b6-0439-45fb-b456-d1beab98b53e","name":"Import","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"items\": [{\n \"type\": \"Task\",\n \"data\": {\n \"name\": \"Imported task\"\n }\n }],\n\t\"edges\": []\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/import/:format","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","import",":format"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item to import."},{"key":"format","value":"json","description":"The format of the data imported."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"238-dfiHmehUu3Z87dm3chKdcoKEGP4\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"14ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"272"},{"key":"date","value":"Fri, 03 Feb 2023 16:47:03 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"_key\": \"281965\",\n \"type\": \"Task\",\n \"data\": {\n \"name\": \"Imported task\"\n },\n \"createdFrom\": \"281965\",\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.389Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.389Z\",\n \"_id\": \"items/281965\",\n \"_rev\": \"_ffeqmr----\"\n }\n ],\n \"edges\": [\n {\n \"_key\": \"281975\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 972591\n },\n \"_from\": \"items/313\",\n \"_to\": \"items/281965\",\n \"createdFrom\": \"281975\",\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.389Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.389Z\",\n \"_id\": \"connections/281975\",\n \"_rev\": \"_ffeqmrW---\"\n }\n ]\n}"}],"_postman_id":"7e07da03-24d2-4a11-bb0d-d680be8af3f6"},{"name":"Export","id":"cef126f6-2a3f-4bbf-8dfb-6b0946a5d05a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/items/:_key/export/:format","description":"

Query the items connected to a specific item.

\n
Authenticated.\nPermissions: r on each item being traversed.
\n

The key of the item to export.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"},{"description":{"content":"

The format of the exported data.

\n","type":"text/plain"},"type":"any","value":"json","key":"format"}]}},"response":[{"id":"d7a31394-0be4-4eda-9714-2126cc0da49b","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/export/:format","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","export",":format"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item to export."},{"key":"format","value":"json","description":"The format of the exported data."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"160c-srjdCBbyEMmWLuoZkA5gC591Sek\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"84ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"1877"},{"key":"date","value":"Fri, 03 Feb 2023 16:52:25 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"type\": \"User\",\n \"data\": {\n \"email\": \"System\",\n \"name\": \"System\",\n \"thumbnail\": null\n }\n },\n {\n \"type\": \"Usergroup\",\n \"data\": {\n \"name\": \"Domain admins\"\n },\n \"createdFrom\": \"domain\"\n },\n {\n \"type\": \"Organisation\",\n \"data\": {\n \"name\": \"Default Organisation\"\n },\n \"createdFrom\": \"341\"\n },\n {\n \"type\": \"Workspace\",\n \"data\": {\n \"name\": \"Card\",\n \"appName\": \"Home\",\n \"displayMode\": \"card\"\n },\n \"createdFrom\": \"38265\"\n },\n {\n \"type\": \"Action\",\n \"data\": {\n \"active\": true,\n \"eventName\": \"updatedItem\",\n \"inputs\": [],\n \"inputsPosX\": -1025,\n \"inputsPosY\": -59,\n \"name\": \"sadasf\",\n \"outputs\": [],\n \"outputsPosX\": 600,\n \"outputsPosY\": 0,\n \"subType\": \"CustomAction\"\n },\n \"createdFrom\": \"51993\"\n },\n {\n \"type\": \"Template\",\n \"data\": {\n \"name\": \"Shot template\",\n \"templateData\": {\n \"type\": \"Shot\"\n }\n },\n \"createdFrom\": \"277056\"\n },\n {\n \"type\": \"Shot\",\n \"data\": {\n \"name\": \"SC01\"\n },\n \"createdFrom\": \"278053\"\n },\n {\n \"type\": \"Task\",\n \"data\": {\n \"completion\": 0.5,\n \"status\": \"RTK\",\n \"checklist\": [],\n \"color\": \"#f35415\",\n \"name\": \"Task to update\",\n \"valid\": false\n },\n \"createdFrom\": \"280305\"\n },\n {\n \"type\": \"Group\",\n \"data\": {\n \"name\": \"my new group\"\n },\n \"createdFrom\": \"281323\"\n },\n {\n \"type\": \"Group\",\n \"data\": {\n \"name\": \"my new group\"\n },\n \"createdFrom\": \"281354\"\n },\n {\n \"type\": \"Media\",\n \"data\": {\n \"extension\": \".jpg\",\n \"filename\": \"file-1675442614050-4db3c7ea-c63c-46ea-991d-96a5740cfd49.jpg\",\n \"height\": 1080,\n \"mimetype\": \"image/jpeg\",\n \"name\": \"image\",\n \"originalHeight\": 4500,\n \"originalWidth\": 8000,\n \"originalname\": \"image.jpg\",\n \"path\": \"\\\\file-1675442614050-4db3c7ea-c63c-46ea-991d-96a5740cfd49.jpg\",\n \"size\": 1207207,\n \"thumbnail\": \"/files/file-1675442614050-4db3c7ea-c63c-46ea-991d-96a5740cfd49.tmb.jpg\",\n \"url\": \"/files/file-1675442614050-4db3c7ea-c63c-46ea-991d-96a5740cfd49.web.jpg\",\n \"width\": 1920\n },\n \"createdFrom\": \"281578\"\n },\n {\n \"type\": \"Task\",\n \"data\": {\n \"name\": \"Imported task\"\n },\n \"createdFrom\": \"281965\"\n },\n {\n \"type\": \"Template\",\n \"data\": {\n \"templateData\": {\n \"name\": \"Default template for Users\",\n \"type\": \"User\"\n },\n \"name\": \"Default template for Users\"\n },\n \"createdFrom\": \"350\"\n },\n {\n \"type\": \"Properties\",\n \"data\": {\n \"name\": \"Organisation properties\",\n \"tasks_status\": [\n {\n \"status\": \"TO DO\",\n \"color\": \"#FACA12\",\n \"valid\": false,\n \"completion\": 0\n },\n {\n \"status\": \"WIP\",\n \"color\": \"#F3A215\",\n \"valid\": false,\n \"completion\": 0.3\n },\n {\n \"status\": \"WFA\",\n \"color\": \"#0087cc\",\n \"valid\": false,\n \"completion\": 0.8\n },\n {\n \"status\": \"APPROVED\",\n \"color\": \"#9cde4d\",\n \"valid\": true,\n \"completion\": 1\n },\n {\n \"status\": \"RTK\",\n \"color\": \"#F54E6F\",\n \"valid\": false,\n \"completion\": 0.5\n }\n ]\n },\n \"createdFrom\": \"368\"\n },\n {\n \"type\": \"Operation\",\n \"data\": {\n \"active\": true,\n \"arrayValue\": [],\n \"booleanValue\": false,\n \"itemValue\": [\n \"281578\"\n ],\n \"name\": \"View data\",\n \"objectValue\": {},\n \"stringValue\": \"\",\n \"subType\": \"Viewer\",\n \"updateCounter\": 16\n },\n \"createdFrom\": \"52104\"\n },\n {\n \"type\": \"Task\",\n \"data\": {\n \"name\": \"Anim\"\n },\n \"createdFrom\": \"277133\"\n },\n {\n \"type\": \"Task\",\n \"data\": {\n \"name\": \"Render\"\n },\n \"createdFrom\": \"277160\"\n },\n {\n \"type\": \"Task\",\n \"data\": {\n \"name\": \"Render\"\n },\n \"createdFrom\": \"277160\"\n },\n {\n \"type\": \"Task\",\n \"data\": {\n \"name\": \"Anim\"\n },\n \"createdFrom\": \"277133\"\n },\n {\n \"type\": \"Group\",\n \"data\": {\n \"name\": \"Quickstart\",\n \"workspace\": \"120704600\"\n },\n \"createdFrom\": \"377\"\n },\n {\n \"type\": \"Url\",\n \"data\": {\n \"description\": \"Aquarium's documentation\",\n \"link\": \"https://docs.fatfish.app\",\n \"name\": \"Documentation\"\n },\n \"createdFrom\": \"359\"\n },\n {\n \"type\": \"Text\",\n \"data\": {\n \"content\": \"

Hello !

Welcome on Aquarium.

Feel free to read our documentation or directly our Quickstart to know quickly how to create Projects.

If you have any questions, you can contact us at support@fatfi.sh or by joining our community server.

Have fun !

\",\n \"labelColor\": \"#fd7b1f\",\n \"name\": \"Readme\"\n },\n \"createdFrom\": \"384\"\n }\n ],\n \"edges\": [\n {\n \"_from\": \"0\",\n \"_to\": \"1\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 368856\n }\n },\n {\n \"_from\": \"0\",\n \"_to\": \"2\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 2011\n }\n },\n {\n \"_from\": \"2\",\n \"_to\": \"0\",\n \"type\": \"Member\",\n \"data\": {}\n },\n {\n \"_from\": \"0\",\n \"_to\": \"3\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 100000\n }\n },\n {\n \"_from\": \"0\",\n \"_to\": \"4\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 732827\n }\n },\n {\n \"_from\": \"4\",\n \"_to\": \"14\",\n \"type\": \"Propagate\",\n \"data\": {\n \"_fromSlot\": \"item\",\n \"_toSlot\": \"itemValue\"\n }\n },\n {\n \"_from\": \"5\",\n \"_to\": \"6\",\n \"type\": \"Template\",\n \"data\": {}\n },\n {\n \"_from\": \"5\",\n \"_to\": \"6\",\n \"type\": \"Template\",\n \"data\": {}\n },\n {\n \"_from\": \"0\",\n \"_to\": \"5\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 400606\n }\n },\n {\n \"_from\": \"0\",\n \"_to\": \"6\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 978958\n }\n },\n {\n \"_from\": \"0\",\n \"_to\": \"7\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 619990\n }\n },\n {\n \"_from\": \"0\",\n \"_to\": \"8\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 349489\n }\n },\n {\n \"_from\": \"0\",\n \"_to\": \"9\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 421836\n }\n },\n {\n \"_from\": \"0\",\n \"_to\": \"10\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 884373\n }\n },\n {\n \"_from\": \"0\",\n \"_to\": \"11\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 972591\n }\n },\n {\n \"_from\": \"2\",\n \"_to\": \"12\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 134686\n }\n },\n {\n \"_from\": \"2\",\n \"_to\": \"13\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 522926\n }\n },\n {\n \"_from\": \"4\",\n \"_to\": \"14\",\n \"type\": \"Child\",\n \"data\": {\n \"posX\": -399.5625,\n \"posY\": -128.5,\n \"weight\": 33041\n }\n },\n {\n \"_from\": \"5\",\n \"_to\": \"15\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 453280\n }\n },\n {\n \"_from\": \"5\",\n \"_to\": \"16\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 463280\n }\n },\n {\n \"_from\": \"6\",\n \"_to\": \"17\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 463280\n }\n },\n {\n \"_from\": \"6\",\n \"_to\": \"18\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 453280\n }\n },\n {\n \"_from\": \"12\",\n \"_to\": \"19\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 414690\n }\n },\n {\n \"_from\": \"12\",\n \"_to\": \"19\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 414690\n }\n },\n {\n \"_from\": \"19\",\n \"_to\": \"20\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 930804\n }\n },\n {\n \"_from\": \"19\",\n \"_to\": \"20\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 930804\n }\n },\n {\n \"_from\": \"19\",\n \"_to\": \"21\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 275405\n }\n },\n {\n \"_from\": \"19\",\n \"_to\": \"21\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 275405\n }\n }\n ]\n}"},{"id":"9387466a-3d7e-49c3-b187-84fc4b02b8ca","name":"400 Unsupported format","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/export/:format","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","export",":format"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item to export."},{"key":"format","value":"csv","description":"The format of the exported data."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"28-YE3CexaJ375Yabyp7oEAi3PPHnE\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"63"},{"key":"date","value":"Fri, 03 Feb 2023 16:53:18 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Export format not supported.\"\n}"}],"_postman_id":"cef126f6-2a3f-4bbf-8dfb-6b0946a5d05a"},{"name":"Shortest path","id":"1206afc5-cb93-45ff-8424-446059736165","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/items/:startKey/path/:targetKey?enforceEndpoints=true","description":"

Get the shortest path between two items.

\n
Authenticated.
Permissions: r on the starting item, r on the destination item.
\n

Enforce path endpoints (head and tail) to be present in the response. If two items are not connected to each other, without this param, the array will be empty (optional, default true)

\n","type":"text/plain"},"key":"enforceEndpoints","value":"true"}],"variable":[{"description":{"content":"

The key of the item from which to start looking for the shortest path.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"startKey"},{"description":{"content":"

The key of the item to target to find the shortest path.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"targetKey"}]}},"response":[{"id":"7eb62a94-6ef0-4fa8-be42-b905a03be4b5","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:startKey/path/:targetKey","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":startKey","path",":targetKey"],"variable":[{"key":"startKey","value":"{{meKey}}","description":"The key of the item from which to start looking for the shortest path."},{"key":"targetKey","value":"541330","description":"The key of the item to target to find the shortest path."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"3f6-r4I3RAbc7Z74m4rUPAIY2ia5u9Q\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"7ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"387"},{"key":"date","value":"Fri, 03 Feb 2023 16:55:02 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_key\": \"313\",\n \"_id\": \"items/313\",\n \"_rev\": \"_ffce-DC---\",\n \"type\": \"User\",\n \"data\": {\n \"email\": \"System\",\n \"name\": \"System\",\n \"thumbnail\": null\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.389Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.389Z\",\n },\n {\n \"_key\": \"281354\",\n \"_id\": \"items/281354\",\n \"_rev\": \"_ffekQnO---\",\n \"type\": \"Group\",\n \"data\": {\n \"name\": \"my new group\"\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.389Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.389Z\",\n \"createdFrom\": \"281354\"\n },\n {\n \"_key\": \"541179\",\n \"_id\": \"items/541179\",\n \"_rev\": \"_ffexlvG--_\",\n \"type\": \"Group\",\n \"data\": {\n \"name\": \"sub group\"\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.389Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.389Z\",\n \"createdFrom\": \"541179\"\n },\n {\n \"_key\": \"541330\",\n \"_id\": \"items/541330\",\n \"_rev\": \"_ffexuEG---\",\n \"type\": \"Task\",\n \"data\": {\n \"name\": \"My task\"\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.389Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.389Z\",\n \"createdFrom\": \"541330\"\n }\n]"}],"_postman_id":"1206afc5-cb93-45ff-8424-446059736165"},{"name":"Convert to template","id":"cbed21a2-fe1c-4ab2-b0f7-9a90c23c5dfd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{protocole}}{{url}}/{{version}}/items/:_key/convertToTemplate","description":"

Apply a template to an item.

\n
Authenticated.\nPermissions: a on the item on which the template is applied.
\n

The key of the item to convert into a template.

\n","type":"text/plain"},"type":"any","value":"1234","key":"_key"}]}},"response":[{"id":"c402ab28-8870-42aa-be1b-503e3e972db4","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/convertToTemplate","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","convertToTemplate"],"variable":[{"key":"_key","value":"277056","description":"The key of the item to convert into a template."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"11f-HjJcOJUI2sCsnKP3bRHTnYoIXOA\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"5ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"187"},{"key":"date","value":"Fri, 03 Feb 2023 15:46:53 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"277056\",\n \"_id\": \"items/277056\",\n \"_rev\": \"_ffdyvYa--_\",\n \"type\": \"Template\",\n \"data\": {\n \"name\": \"Shot template\",\n \"templateData\": {\n \"type\": \"Shot\"\n }\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.389Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.389Z\",\n \"createdFrom\": \"277056\"\n}"}],"_postman_id":"cbed21a2-fe1c-4ab2-b0f7-9a90c23c5dfd"},{"name":"Get templates","id":"f4a1382c-fe6b-428a-aa98-d454eda0c7ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"templateType\": \"Shot\",\r\n \"limit\": 5,\r\n \"view\": \"item.data.name\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/templates","description":"

Apply a template to an item.

\n
Authenticated.\nPermissions: a on the item on which the template is applied.
\n

The key of the item to find the adequate template for.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"f71a3b0e-e53e-49ab-865e-ac4c2b0556de","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"templateType\": \"Shot\",\r\n \"limit\": 5,\r\n \"view\": \"item.data.name\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/templates","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","templates"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item to find the adequate template for."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"\"11-Ashk1cjxhOD1hTD6cS6zOkj7nKM\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"10ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-length","value":"17"},{"key":"date","value":"Fri, 03 Feb 2023 16:56:56 GMT"}],"cookie":[],"responseTime":null,"body":"[\n \"Shot template\"\n]"}],"_postman_id":"f4a1382c-fe6b-428a-aa98-d454eda0c7ff"},{"name":"Trash item","id":"c2f3e0f4-bf91-4f37-a3b7-857a0bfcc107","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"propagate","value":"true","description":"

Propagate trash on item's content too (optional). Default: true

\n","type":"text"}]},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/trash","description":"

Trash an item.

The optional propagate body parameter define if you want to propagate the trash action on the item's content. By default propagate is true.

\n
Authenticated.
Permissions: t on the item.
\n

The key of the item to trash.

\n","type":"text/plain"},"type":"any","value":"72015","key":"_key"}]}},"response":[{"id":"325d351a-0947-46a2-939c-1d5713d5616d","name":"200 OK","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/trash","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","trash"],"variable":[{"key":"_key","value":"280305","description":"The key of the item to trash."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"155-R2zmUYM61rrz0EWOkpo+FLZr/zA\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"20ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"242"},{"key":"date","value":"Fri, 03 Feb 2023 16:56:08 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"item\": {\n \"_key\": \"280305\",\n \"_id\": \"items/280305\",\n \"_rev\": \"_ffehSuW--_\",\n \"type\": \"Task\",\n \"data\": {\n \"completion\": 0.5,\n \"status\": \"RTK\",\n \"checklist\": [],\n \"color\": \"#f35415\",\n \"name\": \"Task to update\",\n \"valid\": false\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.390Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.390Z\",\n \"createdFrom\": \"280305\"\n }\n}"}],"_postman_id":"c2f3e0f4-bf91-4f37-a3b7-857a0bfcc107"}],"id":"1d0ebcaf-7693-45b4-ae9f-ec54774c3e25","description":"

All the operations related to the items.

\n","event":[{"listen":"prerequest","script":{"id":"6f3abcf6-decc-425f-9b54-db64a2e06b64","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"392984d8-90fb-4446-9cda-85d994ce5853","type":"text/javascript","exec":[""]}}],"_postman_id":"1d0ebcaf-7693-45b4-ae9f-ec54774c3e25","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Permissions","item":[{"name":"Get permissions","id":"f9c49414-ba14-4b55-a038-4ddd5a2b5b6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/permissions","description":"

Get the list of users and their access to an item.

\n
Permissions: r on the item.
\n

Replace the createdBy and updatedBy properties by an item object.

\n","type":"text/plain"},"key":"populate","value":"true"},{"disabled":true,"key":"offset","value":"0"},{"disabled":true,"description":{"content":"

The maximum amount of elements to return.

\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"

Sort MeshQL expression.

\n","type":"text/plain"},"key":"sort","value":"item._key ASC"},{"disabled":true,"key":"depth","value":"10"},{"disabled":true,"key":"includeMembers","value":"true"}],"variable":[{"description":{"content":"

The key of the item to get the permissions of.

\n","type":"text/plain"},"type":"any","value":"domain","key":"_key"}]}},"response":[{"id":"ab26434e-0193-4988-9a2b-ae1f70cb6f02","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/permissions","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","permissions"],"query":[{"key":"populate","value":"true","disabled":true},{"key":"offset","value":"0","disabled":true},{"key":"sort","value":"item._key ASC","disabled":true},{"key":"limit","value":"10","disabled":true},{"key":"depth","value":"10","disabled":true},{"key":"includeMembers","value":"true","disabled":true}],"variable":[{"key":"_key","value":"domain","description":"The key of the item to get the permissions of."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"22d-cUmWKUn8lBfDEkafSexOcNe2u+k\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"13ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"305"},{"key":"date","value":"Fri, 03 Feb 2023 14:58:07 GMT"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"user\": {\n \"_key\": \"{{meKey}}\",\n \"_id\": \"items/{{meKey}}\",\n \"_rev\": \"_ffce-DC---\",\n \"type\": \"User\",\n \"data\": {\n \"email\": \"{{email}}\",\n \"name\": \"{{name}}\",\n \"thumbnail\": null\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.390Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.390Z\"\n },\n \"edge\": {\n \"_key\": \"335\",\n \"_id\": \"accesses/335\",\n \"_from\": \"items/313\",\n \"_to\": \"items/domain\",\n \"_rev\": \"_fdOzt0m---\",\n \"type\": \"Permission\",\n \"data\": {\n \"permissions\": \"rwsadtlug\"\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.390Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.390Z\"\n }\n }\n]"}],"_postman_id":"f9c49414-ba14-4b55-a038-4ddd5a2b5b6a"},{"name":"Get flat permissions","id":"b3781b6d-3e81-40da-a8be-a6b150533fdc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/permissions/flat?accountKey=","description":"

Get the list of users and their access to an item.

\n
Permissions: r on the item.
\n

The _key of the account to flat its permissions (optional). If no accountKey provided, current user is used.

\n","type":"text/plain"},"key":"accountKey","value":""}],"variable":[{"description":{"content":"

The key of the item to get the permissions of.

\n","type":"text/plain"},"type":"any","value":"{{itemKey}}","key":"_key"}]}},"response":[{"id":"eefcf0b1-c436-43e5-b54a-1934b4162a4b","name":"Get flat permissions","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/permissions/flat","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","permissions","flat"],"query":[{"key":"accountKey","value":"","description":"The _key of the account to flat its permissions (optional). If no accountKey provided, current user is used.","disabled":true}],"variable":[{"key":"_key","value":"{{itemKey}}","description":"The key of the item to get the permissions of."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"content-type,accept-ranges,content-range,server-timing"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"274-3j978YrRx1STtgLTLODhJooEw2o\""},{"key":"server-timing","value":"aquarium, query;dur=13.120457999408245ms"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-request-id","value":"4a79ff86-15aa-4008-bd2a-dc100ae0f66a"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"257"},{"key":"date","value":"Wed, 20 Mar 2024 06:44:47 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"permissions\": \"rwsadtlug\",\n \"direct\": [\n {\n \"_key\": \"589765522\",\n \"_id\": \"accesses/589765522\",\n \"_from\": \"items/10171\",\n \"_to\": \"items/589765513\",\n \"_rev\": \"_hfVSkgq---\",\n \"createdBy\": \"10171\",\n \"createdAt\": \"2024-03-06T22:13:58.450Z\",\n \"updatedBy\": \"10171\",\n \"updatedAt\": \"2024-03-06T22:13:58.450Z\",\n \"type\": \"Permission\",\n \"data\": {\n \"permissions\": \"rwsadtlug\"\n }\n }\n ],\n \"indirect\": [\n {\n \"_key\": \"589765523\",\n \"_id\": \"accesses/589765523\",\n \"_from\": \"items/domain\",\n \"_to\": \"items/589765513\",\n \"_rev\": \"_hfVSkgq--_\",\n \"createdBy\": \"10171\",\n \"createdAt\": \"2024-03-06T22:13:58.450Z\",\n \"updatedBy\": \"10171\",\n \"updatedAt\": \"2024-03-06T22:13:58.450Z\",\n \"type\": \"Permission\",\n \"data\": {\n \"permissions\": \"rwsadtlug\"\n }\n }\n ]\n}"}],"_postman_id":"b3781b6d-3e81-40da-a8be-a6b150533fdc"},{"name":"Get flat permissions","id":"a8e09219-411f-4001-9da5-ccfc63d0d11b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/items/:_key/permissions/flat?accountKey={{meKey}}","description":"

Get the list of users and their access to an item.

\n
Permissions: r on the item.
\n

The _key of the account to flat its permissions (optional). If no accountKey provided, current user is used.

\n","type":"text/plain"},"key":"accountKey","value":"{{meKey}}"}],"variable":[{"id":"44ede9f4-3546-46e7-ae41-fb2556e59834","description":{"content":"

The key of the item to get the permissions of.

\n","type":"text/plain"},"type":"any","value":"domain","key":"_key"}]}},"response":[],"_postman_id":"a8e09219-411f-4001-9da5-ccfc63d0d11b"},{"name":"Create a permission","id":"0dfae3ad-98b8-48ae-bd53-b2091962e86d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKey\": \"\",\r\n \"data\": {\r\n \"permissions\": \"rwatlugs\"\r\n },\r\n \"propagate\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/permissions","description":"

Create a permission on an item (and its content if propagate is true) to make it accessible to userKey.

The response contains a jobKey property. This allows to get the progression of the propagation of the permissions.

\n
Permissions: s on the item to share.
\n

The key of the item on which to create a new permission.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[{"id":"6416bb21-aeda-49e1-976f-64787c2d790b","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKey\": \"251592\",\r\n \"data\": {\r\n \"permissions\": \"rwatlugs\"\r\n },\r\n \"propagate\": true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/permissions","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","permissions"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item on which to create a new permission."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"25e-QHkUJn0m2F0EMy97rqGFf6f2i4w\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"10ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"317"},{"key":"date","value":"Fri, 03 Feb 2023 15:10:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"user\": {\n \"_key\": \"251592\",\n \"_id\": \"items/251592\",\n \"_rev\": \"_ffbn54----\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"Alice\",\n \"email\": \"alice@fatfi.sh\"\n },\n \"active\": true,\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.391Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.391Z\"\n },\n \"edge\": {\n \"_key\": \"257225\",\n \"type\": \"Permission\",\n \"data\": {\n \"permissions\": \"rwatlugs\"\n },\n \"_from\": \"items/251592\",\n \"_to\": \"items/313\",\n \"createdBy\": \"313\",\n \"createdAt\": \"2026-05-03T20:40:48.391Z\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2026-05-03T20:40:48.391Z\",\n \"_id\": \"accesses/257225\",\n \"_rev\": \"_ffdSAmy---\"\n },\n \"jobKey\": \"ba6eb278-5faa-4383-bf99-6fa65560497a\"\n}"},{"id":"6577a2f2-21f7-4374-9b5e-80d27507ebd0","name":"409 Permission already exists","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKey\": \"251592\",\r\n \"data\": {\r\n \"permissions\": \"rwatlugs\"\r\n },\r\n \"propagate\": true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/items/:_key/permissions","host":["{{protocole}}{{url}}"],"path":["{{version}}","items",":_key","permissions"],"variable":[{"key":"_key","value":"{{meKey}}","description":"The key of the item on which to create a new permission."}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"4c-jaXqB8qJZy3GbY0xLg8xHHa+CuI\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"91"},{"key":"date","value":"Fri, 03 Feb 2023 15:13:24 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"The access edge from #items/251592 to #items/{{meKey}} already exists.\"\n}"}],"_postman_id":"0dfae3ad-98b8-48ae-bd53-b2091962e86d"},{"name":"Patch permissions","id":"5e9b9071-a936-4884-86d8-1cc6cda1b54e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKey\": \"3865814\",\r\n \"data\": {\r\n \"permissions\": \"rawsg\"\r\n },\r\n \"propagate\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/permissions","description":"

Patch an item permissions with data.

\n
Permissions: g on the item.
\n

The key of the item on which to edit a permssion.

\n","type":"text/plain"},"type":"any","value":"{{patch}}","key":"_key"}]}},"response":[],"_postman_id":"5e9b9071-a936-4884-86d8-1cc6cda1b54e"},{"name":"Copy permissions","id":"4ffdf839-c2a0-4dec-9f37-def069ac9e9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"targetKey\": \"{{targetCopyPermissionsKey}}\",\r\n \"propagate\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/permissions/copy","description":"

Copy the permissions of item _key onto item targetKey.\npropagate option allow to propagate the permission copy to the hierarchy.

\n
The endpoint only create and update existing permissions. It do not delete any existing participant.
\n

\n
Permissions: r on the source item, s on the target item.
\n

The key of the item from which to copy the permissions.

\n","type":"text/plain"},"type":"any","value":"{{targetCopyPermissionsKey}}","key":"_key"}]}},"response":[],"_postman_id":"4ffdf839-c2a0-4dec-9f37-def069ac9e9a"},{"name":"Remove permissions","id":"ee1264b1-bf87-4dfd-9a88-969a513a8e04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKey\": \"266\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/items/:_key/permissions","description":"

Remove an item permissions. This will revoke the access of an item for a specified user or usergroup.

\n
Permissions: g on the item.
\n

The key of the item from which to remove a permission.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[],"_postman_id":"ee1264b1-bf87-4dfd-9a88-969a513a8e04"}],"id":"bb8b9ea6-51cb-4fee-ae2a-462134c9519a","description":"

All the operations related to the permissions of the items.
The permissions are codified as follow:

r: allows to read
w: allows to write
s: allows to share
a: allows to add children
l: allows to link
u: allows to unlink
d: allows to delete
t: allows to trash
g: allows to change the permissions
*: prevents the propagation of the permissions

These codes are cumulable: rwd to give a user the rights to read, write, delete on an item.

\n","_postman_id":"bb8b9ea6-51cb-4fee-ae2a-462134c9519a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Templates","item":[{"name":"Apply","id":"ebcffade-e72a-4e72-aa28-e9d714fb02c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{protocole}}{{url}}/{{version}}/templates/:templateKey/apply/:itemKey","description":"

Apply a template to an item.

\n
Permissions: a on the item on which the template is applied.
\n

The key of the template to apply.

\n","type":"text/plain"},"type":"any","value":"1234","key":"templateKey"},{"description":{"content":"

The key of the item on which to apply the template.

\n","type":"text/plain"},"type":"any","value":"2345","key":"itemKey"}]}},"response":[{"id":"66e15cfe-fd8c-4d40-be19-aa6656b227e8","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{protocole}}{{url}}/{{version}}/templates/:templateKey/apply/:itemKey","host":["{{protocole}}{{url}}"],"path":["{{version}}","templates",":templateKey","apply",":itemKey"],"variable":[{"key":"templateKey","value":"277056","description":"The key of the template to apply."},{"key":"itemKey","value":"278053","description":"The key of the item on which to apply the template."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"11f-xDfDCxYflA/k1pUwJD9roQbm1sQ\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"155ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"194"},{"key":"date","value":"Fri, 03 Feb 2023 16:03:31 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"277056\",\n \"_id\": \"items/277056\",\n \"_rev\": \"_ffeBhAK---\",\n \"type\": \"Template\",\n \"data\": {\n \"name\": \"Shot template\",\n \"templateData\": {\n \"type\": \"Shot\"\n }\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2023-02-03T16:46:02.791+01:00\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2023-02-03T17:02:11.106+01:00\",\n \"createdFrom\": \"277056\"\n}"}],"_postman_id":"ebcffade-e72a-4e72-aa28-e9d714fb02c6"},{"name":"Compare","id":"6db43c86-2437-423d-83c2-e9b92dd4630d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"properties\": [\"data.name\", \"data.status\"],\r\n \"types\": [\"Comment\"],\r\n \"exclude\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/templates/:templateKey/compare/:itemKey","description":"

Apply a template to an item.

\n
Permissions: a on the item on which the template is applied.
\n

By default, all item's type in the types parameter will be included. To exclude elements, you can use the exclude boolean parameter.

Examples :

To only include Task when comparing a template :

{\n    \"types\": [\"Task\"],\n    \"exclude\": false\n}\n\n

To include all types except for Task when comparing a template :

{\n    \"types\": [\"Task\"],\n    \"exclude\": true\n}\n\n

The key of the template used as a base for comparison.

\n","type":"text/plain"},"type":"any","value":"277056","key":"templateKey"},{"description":{"content":"

The key of the item used as a target for comparison.

\n","type":"text/plain"},"type":"any","value":"278053","key":"itemKey"}]}},"response":[{"id":"a6e43386-2a05-4a7e-9dac-755fe5cbac78","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"properties\": [\"data.name\", \"data.status\"],\r\n \"types\": [\"Comment\"],\r\n \"exclude\": true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/templates/:templateKey/compare/:itemKey","host":["{{protocole}}{{url}}"],"path":["{{version}}","templates",":templateKey","compare",":itemKey"],"variable":[{"key":"templateKey","value":"277056","description":"The key of the template used as a base for comparison."},{"key":"itemKey","value":"278053","description":"The key of the item used as a target for comparison."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"50e-WdxJA4KSjoACf91aP8drALjCaPc\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"151ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"425"},{"key":"date","value":"Fri, 03 Feb 2023 16:05:25 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"unchangedItems\": [\n {\n \"_key\": \"278085\",\n \"_id\": \"items/278085\",\n \"_rev\": \"_ffeBqpi---\",\n \"type\": \"Task\",\n \"data\": {\n \"name\": \"Render\"\n },\n \"createdFrom\": \"277160\",\n \"createdBy\": \"313\",\n \"createdAt\": \"2023-02-03T17:02:20.985+01:00\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2023-02-03T17:02:20.985+01:00\"\n },\n {\n \"_key\": \"278600\",\n \"_id\": \"items/278600\",\n \"_rev\": \"_ffeCvQu---\",\n \"type\": \"Task\",\n \"data\": {\n \"name\": \"Anim\"\n },\n \"createdFrom\": \"277133\",\n \"createdBy\": \"313\",\n \"createdAt\": \"2023-02-03T17:03:31.243+01:00\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2023-02-03T17:03:31.243+01:00\"\n }\n ],\n \"untrackedItems\": [],\n \"modifiedItems\": [],\n \"missingItems\": [],\n \"originalItems\": [],\n \"unchangedEdges\": [\n {\n \"_key\": \"278096\",\n \"_id\": \"connections/278096\",\n \"_from\": \"items/278053\",\n \"_to\": \"items/278085\",\n \"_rev\": \"_ffeBqpq--_\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 463280\n },\n \"createdFrom\": \"277163\",\n \"createdBy\": \"313\",\n \"createdAt\": \"2023-02-03T17:02:20.987+01:00\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2023-02-03T17:02:20.987+01:00\"\n },\n {\n \"_key\": \"278609\",\n \"_id\": \"connections/278609\",\n \"_from\": \"items/278053\",\n \"_to\": \"items/278600\",\n \"_rev\": \"_ffeCvQ2---\",\n \"type\": \"Child\",\n \"data\": {\n \"weight\": 453280\n },\n \"createdFrom\": \"277136\",\n \"createdBy\": \"313\",\n \"createdAt\": \"2023-02-03T17:03:31.245+01:00\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2023-02-03T17:03:31.245+01:00\"\n }\n ],\n \"untrackedEdges\": [],\n \"modifiedEdges\": [],\n \"missingEdges\": [],\n \"originalEdges\": [],\n \"externalItems\": []\n}"}],"_postman_id":"6db43c86-2437-423d-83c2-e9b92dd4630d"},{"name":"Sync","id":"cddbf4b4-a134-40d8-a2e0-9355c877110e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"properties\": [\"data.name\", \"data.status\"],\r\n \"types\": [\"Task\"],\r\n \"exclude\": false,\r\n \"removeUntracked\": true,\r\n \"revertModified\": true,\r\n \"createMissing\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/templates/:templateKey/sync/:itemKey","description":"

Apply a template to an item.

\n
Authenticated.
Permissions: a on the item on which the template is applied.
\n

By default, all item's type in the types parameter will be included. To exclude elements, you can use the exclude boolean parameter.

Examples :

To only include Task when syncing a template :

{\n    \"types\": [\"Task\"],\n    \"exclude\": false\n}\n\n

To include all types except for Task when syncing a template :

{\n    \"types\": [\"Task\"],\n    \"exclude\": true\n}\n\n

The key of the template used as a base for synchronization.

\n","type":"text/plain"},"type":"any","value":"277056","key":"templateKey"},{"description":{"content":"

The key of the item used as a target for synchronization.

\n","type":"text/plain"},"type":"any","value":"278053","key":"itemKey"}]}},"response":[{"id":"e3bd4457-fb8e-4bb7-bb17-d0d3a473e7ff","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"properties\": [\"data.name\", \"data.status\"],\r\n \"types\": [\"Task\"],\r\n \"exclude\": true,\r\n \"removeUntracked\": true,\r\n \"revertModified\": true,\r\n \"createMissing\": true\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/templates/:templateKey/sync/:itemKey","host":["{{protocole}}{{url}}"],"path":["{{version}}","templates",":templateKey","sync",":itemKey"],"variable":[{"key":"templateKey","value":"277056","description":"The key of the template used as a base for synchronization."},{"key":"itemKey","value":"278053","description":"The key of the item used as a target for synchronization."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"f3-oyCS9OaCA7vX1ppbJtsUNo6TbDc\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"91ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"173"},{"key":"date","value":"Fri, 03 Feb 2023 16:08:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"278053\",\n \"_id\": \"items/278053\",\n \"_rev\": \"_ffeB8Lq--_\",\n \"type\": \"Shot\",\n \"data\": {\n \"name\": \"SC01\"\n },\n \"createdBy\": \"313\",\n \"createdAt\": \"2023-02-03T17:02:20.856+01:00\",\n \"updatedBy\": \"313\",\n \"updatedAt\": \"2023-02-03T17:02:38.938+01:00\",\n \"createdFrom\": \"278053\"\n}"}],"_postman_id":"cddbf4b4-a134-40d8-a2e0-9355c877110e"}],"id":"57894663-c586-4713-adea-744cd833337b","description":"

The operations related to the templates.

\n","_postman_id":"57894663-c586-4713-adea-744cd833337b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Usergroups","item":[{"name":"Get members","id":"aad834b6-4689-4da2-bed4-8603b95a93d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/usergroups/:_key/:mode","description":"

Get all users in the usergroup.

\n
Authenticated.\nPermissions: r on the usergoup.
\n

The key of the usergroup to get members of.

\n","type":"text/plain"},"type":"any","value":"domain","key":"_key"},{"description":{"content":"

Get \"all\", \"active\" or \"inactive\" members of the usergroup.

\n","type":"text/plain"},"type":"any","value":"all","key":"mode"}]}},"response":[],"_postman_id":"aad834b6-4689-4da2-bed4-8603b95a93d3"},{"name":"Add user in usergroup","id":"c960a7dc-77f5-4155-b36d-fbc1e4d6f9a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKey\": \"{{meKey}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/usergroups/:_key","description":"

Add a user in the usergroup.

\n
Authenticated.
Permissions: s on the usergroup.
\n

The key of the usergroup to add a member on.

\n","type":"text/plain"},"type":"any","value":"domain","key":"_key"}]}},"response":[],"_postman_id":"c960a7dc-77f5-4155-b36d-fbc1e4d6f9a0"},{"name":"Replace users in usergroup","id":"a9fabd4e-4e49-434a-bd22-7985cd17da47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKeys\": [\"{{meKey}}\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/usergroups/:_key","description":"

Replace users in the usergroup.

\n
Authenticated.
Permissions: s on the usergroup.
\n

The key of the usergroup to add a member on.

\n","type":"text/plain"},"type":"any","value":"domain","key":"_key"}]}},"response":[],"_postman_id":"a9fabd4e-4e49-434a-bd22-7985cd17da47"},{"name":"Remove a user from a usergroup","id":"62acc33e-3980-43ef-af44-37e46a221404","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKey\": \"{{meKey}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/usergroups/:_key","description":"

Remove a user from the usergroup.

\n
Authenticated.\nPermissions: a on the usergoup.
\n

The key of the usergroup to remove a member of.

\n","type":"text/plain"},"type":"any","value":"domain","key":"_key"}]}},"response":[],"_postman_id":"62acc33e-3980-43ef-af44-37e46a221404"}],"id":"347fa45e-518a-43a6-b5da-26b2e8952c53","description":"

API documentation about usergroups.

\n","event":[{"listen":"prerequest","script":{"id":"163e25ee-b514-4034-8fc8-b5fc1b1f6252","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"62b3e2cc-8a15-4f65-98f2-954e64af3f0a","type":"text/javascript","exec":[""]}}],"_postman_id":"347fa45e-518a-43a6-b5da-26b2e8952c53","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Organisations","item":[{"name":"Get members","id":"4db2ee5c-32e1-4cea-a4f1-133715c80fe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/organisations/:_key/members/:mode","description":"

Get all users in the usergroup.

\n
Authenticated.\nPermissions: r on the usergoup.
\n

The key of the organisation to get member of.

\n","type":"text/plain"},"type":"any","value":"domain","key":"_key"},{"description":{"content":"

Get \"all\", \"active\" or \"inactive\" members of the organisation.

\n","type":"text/plain"},"type":"any","value":"all","key":"mode"}]}},"response":[],"_postman_id":"4db2ee5c-32e1-4cea-a4f1-133715c80fe4"},{"name":"Add user in organisation","id":"6060c11e-99c3-4620-8647-f672db7f00e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"description":"

The key of the user to add in the organisation.

\n","key":"userKey","type":"text","value":"{{meKey}}"},{"key":"email","value":"{{email}}","type":"text","description":"

The email of the user to add in the organisation.

\n"}]},"url":"{{protocole}}{{url}}/{{version}}/organisations/:_key/member","description":"

Add a user in the usergroup.

\n
Authenticated.\nPermissions: a on the usergroup.
\n

The key of the organisation on which to add a member.

\n","type":"text/plain"},"type":"any","value":"341","key":"_key"}]}},"response":[{"id":"a59ed2c1-4250-4dcd-810e-2b80e585abb7","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKey\": \"{{meKey}}\",\r\n \"email\": \"{{email}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{protocole}}{{url}}/{{version}}/organisations/:_key/addMember","host":["{{protocole}}{{url}}"],"path":["{{version}}","organisations",":_key","addMember"],"variable":[{"key":"_key","value":"341","description":"The key of the organisation on which to add a member."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"f3-osJZvHGPganFZnsSd2AIba8Rbvg\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"8ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"169"},{"key":"date","value":"Fri, 03 Feb 2023 13:28:27 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"_key\": \"{{meKey}}\",\n \"_id\": \"items/{{meKey}}\",\n \"_rev\": \"_fdOztvK---\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"{{name}}\",\n \"email\": \"{{email}}\"\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"2026-05-03T20:40:48.395Z\",\n \"updatedBy\": \"0\",\n \"updatedAt\": \"2026-05-03T20:40:48.395Z\"\n}"}],"_postman_id":"6060c11e-99c3-4620-8647-f672db7f00e1"},{"name":"Remove a user from an organisation","id":"cf2b8bf1-36e6-40b8-a86c-72173bb15408","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"userKey\": \"{{meKey}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/organisations/:_key/members","description":"

Remove a user from the usergroup.

\n
Authenticated.\nPermissions: a on the usergoup.
\n

The key of the organisation to remove a member of.

\n","type":"text/plain"},"type":"any","value":"domain","key":"_key"}]}},"response":[],"_postman_id":"cf2b8bf1-36e6-40b8-a86c-72173bb15408"}],"id":"a2121df5-5369-4460-99db-a6f824b7678c","description":"

API documentation about usergroups.

\n","event":[{"listen":"prerequest","script":{"id":"163e25ee-b514-4034-8fc8-b5fc1b1f6252","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"62b3e2cc-8a15-4f65-98f2-954e64af3f0a","type":"text/javascript","exec":[""]}}],"_postman_id":"a2121df5-5369-4460-99db-a6f824b7678c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Edges","item":[{"name":"Get an edge","id":"38e515ee-780d-4c9e-9155-e8256c9f0636","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/edges/:_key?history=true","description":"

Get an edge by its _key property.

\n
Permissions: r on the item from which the edge originates.
\n

Replace createdBy and updatedBy with user data,

\n","type":"text/plain"},"key":"populate","value":"true"},{"description":{"content":"

Get the edge's history.

\n","type":"text/plain"},"key":"history","value":"true"}],"variable":[{"description":{"content":"

The key of the edge to get.

\n","type":"text/plain"},"type":"any","value":"1234","key":"_key"}]}},"response":[],"_postman_id":"38e515ee-780d-4c9e-9155-e8256c9f0636"},{"name":"Create an edge","id":"e560e4ab-e926-49cb-a5bd-97f1ffb5fbe3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"_from\": \"items/{{meKey}}\",\r\n \"fromKey\": \"{{meKey}}\",\r\n \"_to\": \"items/2345\",\r\n \"toKey\": \"2345\",\r\n \"type\": \"Child\",\r\n \"data\": {}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/edges","description":"

Create an edge between an item \"A\" to an item \"B\".

No need to provide _from if fromKey is already provided. Same for _to and toKey.

fromKey and toKey are priority on _from and _to.

If type is not provided, an edge of type Child will be created.

\n
Permissions: a on item \"A\".
\n

Patch an edge. This will merge the provided data with the existing.

\n
Permissions: w on the item from which the edge starts.
\n

The key of the edge to patch.

\n","type":"text/plain"},"type":"any","value":"1234","key":"_key"}]}},"response":[],"_postman_id":"b645da0a-7bce-4f5d-b5d4-a9aa4252692a"},{"name":"Update an edge","id":"2428137b-eaa1-4630-90cc-c728558f2292","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"data\": {}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/edges/:_key","description":"

Patch an edge. This will completely replace the existing data by the provided data.

\n
Permissions: w on the item from which the edge starts.
\n

The key of the edge to update.

\n","type":"text/plain"},"type":"any","value":"1234","key":"_key"}]}},"response":[],"_postman_id":"2428137b-eaa1-4630-90cc-c728558f2292"},{"name":"Remove an edge","id":"c21ac450-81ba-413a-a76b-fbbd66bbfbab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{protocole}}{{url}}/{{version}}/edges/:_key","description":"

Remove an edge permanently.

\n
Permissions: d on the item from which the edge starts.
\n

The key of the edge to remove.

\n","type":"text/plain"},"type":"any","value":"1243","key":"_key"}]}},"response":[],"_postman_id":"c21ac450-81ba-413a-a76b-fbbd66bbfbab"}],"id":"f8fb0f3e-7941-4336-a0a1-174791882bec","description":"

All the operations related to the edges.

\n","event":[{"listen":"prerequest","script":{"id":"7b03a5c3-a355-4035-98d8-8857dd9c63b8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3865133a-5076-4cc0-acc8-9139967c1000","type":"text/javascript","exec":[""]}}],"_postman_id":"f8fb0f3e-7941-4336-a0a1-174791882bec","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Trash","item":[{"name":"Traverse","id":"6c1123ae-75d4-4936-a0c8-788ffed05178","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"query\": \"# -()> 0, 100 * VIEW $output\",\r\n \"aliases\": {\r\n \"output\": {\r\n \"name\": \"item.data.name\",\r\n \"createdBy\": \"GETITEM(item.createdBy).data.name\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/trashed_items/:_key/traverse","description":"

Traverse trashed items.

\n
Permissions: r on each item being traversed.
\n

The key of the trashed item from which to start the traversal (startpoint).

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[],"_postman_id":"6c1123ae-75d4-4936-a0c8-788ffed05178"},{"name":"Restore","id":"6c8797ba-4248-4f73-89ec-a3f41affcde8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{protocole}}{{url}}/{{version}}/trashed_items/:_key/restore","description":"

Restore a trashed item.

\n
Authenticated.\nPermissions: a on the destination item for restoration.
\n

The key of the item to restore from the trash.

\n","type":"text/plain"},"type":"any","value":"12345","key":"_key"}]}},"response":[],"_postman_id":"6c8797ba-4248-4f73-89ec-a3f41affcde8"},{"name":"Remove","id":"d7d2d276-bfd0-4be6-b090-d44867974d15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{protocole}}{{url}}/{{version}}/trashed_items/:_key","description":"

Query the items connected to a specific item.

\n
Authenticated.\nPermissions: r on each item being traversed.
\n

The key of the trashed item to remove forever.

\n","type":"text/plain"},"type":"any","value":"1234","key":"_key"}]}},"response":[],"_postman_id":"d7d2d276-bfd0-4be6-b090-d44867974d15"}],"id":"f2b9b37b-04f9-4b56-93ab-ec127f433d54","description":"

The operations related to the trash.

\n","_postman_id":"f2b9b37b-04f9-4b56-93ab-ec127f433d54","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Jobs","item":[{"name":"Get my jobs","id":"6c3da189-3e16-480e-8a33-a96375b94980","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/jobs/me/:mode","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","jobs","me",":mode"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[{"description":{"content":"

The mode to use to receive the data: \"normal\" or \"stream\".

\n","type":"text/plain"},"type":"any","value":"normal","key":"mode"}]}},"response":[],"_postman_id":"6c3da189-3e16-480e-8a33-a96375b94980"},{"name":"Get job by id","id":"9c255291-dab9-4a05-abd9-3ff73a5a1b87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/jobs/:queue/:_key","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","jobs",":queue",":_key"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[{"description":{"content":"

The queue to which the job belongs.

\n","type":"text/plain"},"type":"any","value":"queries","key":"queue"},{"description":{"content":"

The key of the job to get.

\n","type":"text/plain"},"type":"any","value":"1234","key":"_key"}]}},"response":[],"_postman_id":"9c255291-dab9-4a05-abd9-3ff73a5a1b87"},{"name":"Get job by id Copy","id":"e0fe176d-7e4f-4b0e-9120-547a28fb9603","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{protocole}}{{url}}/{{version}}/jobs/:_key/restart","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","jobs",":_key","restart"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[{"description":{"content":"

The key of the job to restart.

\n","type":"text/plain"},"type":"any","value":"1234","key":"_key"}]}},"response":[],"_postman_id":"e0fe176d-7e4f-4b0e-9120-547a28fb9603"}],"id":"0c5e2631-a871-498d-89d5-3620b8126689","_postman_id":"0c5e2631-a871-498d-89d5-3620b8126689","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Multifactor Authentication","item":[{"name":"Webauthn","item":[{"name":"Add a new challenge","id":"e9d8189e-da44-4192-9d0f-f03dc16413cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{protocole}}{{url}}/{{version}}/mfa/webauthn/add","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","mfa","webauthn","add"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[{"id":"0fbab3e5-5ef7-4c2e-8f26-b3eb471e4798","name":"200 OK","originalRequest":{"method":"POST","header":[],"url":"{{protocole}}{{url}}/{{version}}/webauthn/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"2a5-bI7Ws+ffc3OPh3phKJ3uqZ+BSXw\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"6ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"497"},{"key":"date","value":"Fri, 03 Feb 2023 13:34:52 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"rp\": {\n \"name\": \"Aquarium Studio\",\n \"id\": \"localhost\",\n \"icon\": \"https://storage.googleapis.com/fatfishlab-public/aquarium-studio-website/aquarium.svg\"\n },\n \"user\": {\n \"id\": \"fHP8EOHOLSdkUnR...\",\n \"name\": \"System\",\n \"displayName\": \"System\"\n },\n \"challenge\": \"RO5eRoOxQ8tdyOo7P7Z7qBU11...\",\n \"pubKeyCredParams\": [\n {\n \"type\": \"public-key\",\n \"alg\": -7\n },\n {\n \"type\": \"public-key\",\n \"alg\": -257\n }\n ],\n \"timeout\": 120000,\n \"attestation\": \"direct\",\n \"authenticatorSelection\": {\n \"requireResidentKey\": false,\n \"userVerification\": \"required\"\n },\n \"status\": \"ok\",\n \"excludeCredentials\": []\n}"}],"_postman_id":"e9d8189e-da44-4192-9d0f-f03dc16413cd"},{"name":"Verify","id":"18e98353-73ca-4eac-9279-0112dcdd0c3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": \"\",\r\n \"rawId\": \"\",\r\n \"transports\": [\"usb\"],\r\n \"type\": \"public-key\",\r\n \"response\": {\r\n \"attestationObject\": \"\",\r\n \"clientDataJSON\": \"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/mfa/webauthn/add/verify","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","mfa","webauthn","add","verify"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"18e98353-73ca-4eac-9279-0112dcdd0c3f"},{"name":"Verify login","id":"292aac37-dc02-4d4e-9c16-c16f0e202d1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"{{email}}\",\r\n \"rawId\": \"xOfd...\",\r\n \"response\": {\r\n \"authenticatorData\": \"SZYN...\",\r\n \"signature\": \"Ei8f...\",\r\n \"userHandle\": null,\r\n \"clientDataJSON\": \"base64 url encoded data\"\r\n },\r\n \"authenticatorAttachment\": \"cross-platform\",\r\n \"getClientExtensionResults\": {},\r\n \"id\": \"xOfd...\",\r\n \"type\": \"public-key\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/mfa/webauthn/validate","urlObject":{"path":["{{version}}","mfa","webauthn","validate"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"292aac37-dc02-4d4e-9c16-c16f0e202d1d"}],"id":"45510684-fe6a-4072-a4d6-2616a1ef94f8","description":"

Multifactor Authentication Factor related operations. Aquarium implements the webauthn standard.

\n","_postman_id":"45510684-fe6a-4072-a4d6-2616a1ef94f8","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Backup Codes","item":[{"name":"Create backup codes","id":"18a54a08-9761-4e48-9357-9b678190284c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{protocole}}{{url}}/{{version}}/mfa/backup","description":"

Generates 10 backup codes usable if the authenticators failed.

\n
Permissions: w on the user
\n

Validate one backup code and remove it from the list. THis will return a token to authenticate the user.

\n","urlObject":{"path":["{{version}}","mfa","backup","validate"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[{"id":"06ed22c8-c8b4-45ff-8f5a-58c6d71e7704","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"{{email}}\",\r\n \"code\": \"9bcb...53dc2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/mfa/backup/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"26f-hrds5+o0/prFxNJG+NQA1z34FaA\""},{"key":"server-timing","value":"aquarium, query;dur=559ms"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"458"},{"key":"date","value":"Fri, 07 Apr 2023 13:02:48 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"fdsfd.....ViE6\",\n \"user\": {\n \"_key\": \"\",\n \"_id\": \"items/\",\n \"_rev\": \"_fvMig7-\",\n \"type\": \"User\",\n \"data\": {\n \"name\": \"\",\n \"email\": \"\"\n },\n \"active\": true,\n \"createdBy\": \"0\",\n \"createdAt\": \"1777840848\",\n \"updatedBy\": \"0\",\n \"updatedAt\": \"1777840848\"\n }\n}"},{"id":"3209cb86-7791-403f-813a-0a4c08817a8c","name":"403 Invalid code","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"{{email}}\",\r\n \"code\": \"9bcb6c08-5282-46c4-8766-dcaec9553dc2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/mfa/backup/validate"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"20-1F2xb+gewJNlz/xm1c4ERxM+Thk\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"52"},{"key":"date","value":"Fri, 07 Apr 2023 13:05:06 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Invalid backup code.\"\n}"},{"id":"3b5438ea-676e-425c-af8e-8f3d940f38e3","name":"404 No backup codes","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"{{email}}\",\r\n \"code\": \"9bcb6c08-5282-46c4-8766-dcaec9553dc2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/mfa/backup/validate"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"application/json; charset=UTF-8"},{"key":"etag","value":"W/\"22-PIYrJhqplxPYL3odOZpd+VRATP0\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"},{"key":"content-length","value":"57"},{"key":"date","value":"Fri, 07 Apr 2023 13:05:57 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"No backup codes found.\"\n}"}],"_postman_id":"4baa913f-fba0-4629-9cd5-2e4b05227c0a"}],"id":"4c4c4b78-3242-42c6-a894-6742aea89fa9","_postman_id":"4c4c4b78-3242-42c6-a894-6742aea89fa9","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}}],"id":"88074bfa-eb13-4e66-ad67-fa7b1f7157fa","_postman_id":"88074bfa-eb13-4e66-ad67-fa7b1f7157fa","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"SSO","item":[{"name":"OIDC","item":[{"name":"Get SSO with OIDC","id":"a68c65b7-5547-46c4-87b6-547cf897dcfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{protocole}}{{url}}/{{version}}/sso/oidc","description":"

Get SSO OIDC configuration

\n
Permissions 'r' on domain (Admin & Super Admin)
\n

Provide OIDC client id

\n","type":"text"},{"key":"clientSecret","value":"{{oidcClientSecret}}","description":"

Provide OIDC client secret

\n","type":"text"},{"key":"authorizationEndpoint","value":"{{oidcAuthorizationEndpoint}}","description":"

Provide OIDC Authorization URI

\n","type":"text"},{"key":"tokenEndpoint","value":"","description":"

Provicde OIDC Token URI (optional)

\n","type":"text"},{"key":"createUsers","value":"false","description":"

Allow automatic user creation if doesn't exists yet (optional)

\n","type":"text"}]},"url":"{{protocole}}{{url}}/{{version}}/sso/oidc","description":"

Create SSO OIDC configuration

\n
Permissions 'w' on domain (Super admin)
\n

Delete SSO OIDC configuration

\n
Permissions 'w' on domain (Super admin)
\n

Provide OIDC client id

\n","type":"text"},{"key":"clientSecret","value":"{{oidcClientSecret}}","description":"

Provide OIDC client secret

\n","type":"text"},{"key":"authorizationEndpoint","value":"{{oidcAuthorizationEndpoint}}","description":"

Provide OIDC Authorization URI

\n","type":"text"},{"key":"tokenEndpoint","value":"","description":"

Provicde OIDC Token URI (optional)

\n","type":"text"},{"key":"createUsers","value":"false","description":"

Allow automatic user creation if doesn't exists yet (optional)

\n","type":"text"}]},"url":"{{protocole}}{{url}}/{{version}}/sso/oidc","description":"

Update SSO OIDC configuration

\n
Permissions 'w' on domain (Super admin)
\n

\n
Permissions: none
\n

\n","urlObject":{"path":["{{version}}","sso","oidc","signin"],"host":["{{protocole}}{{url}}"],"query":[{"description":{"content":"

PKCE SHA256 hashed verifier

\n","type":"text/plain"},"key":"code","value":"{{oidcCode}}"},{"description":{"content":"

Redirect URL after Identity Provided signin (optional)

\n","type":"text/plain"},"key":"redirect","value":"{{oidcRedirect}}"}],"variable":[]}},"response":[],"_postman_id":"036388ed-92de-4d77-ac9f-4e4f3108191f"},{"name":"Signin (without redirect)","id":"61598bdf-ee91-43bd-aec6-2a82c427b6ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{protocole}}{{url}}/{{version}}/sso/oidc/signin/url?code={{oidcCode}}&redirect={{oidcRedirect}}","description":"

\n
Permissions: none
\n

\n","urlObject":{"path":["{{version}}","sso","oidc","signin","url"],"host":["{{protocole}}{{url}}"],"query":[{"description":{"content":"

PKCE SHA256 hashed verifier

\n","type":"text/plain"},"key":"code","value":"{{oidcCode}}"},{"description":{"content":"

Redirect URL after Identity Provided signin (optional)

\n","type":"text/plain"},"key":"redirect","value":"{{oidcRedirect}}"}],"variable":[]}},"response":[],"_postman_id":"61598bdf-ee91-43bd-aec6-2a82c427b6ed"},{"name":"Signin Callback","id":"f0f5451c-1211-4572-a862-650e64c40d10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/sso/oidc/callback?{...}=&verifier={{oidcVerifier}}","urlObject":{"path":["{{version}}","sso","oidc","callback"],"host":["{{protocole}}{{url}}"],"query":[{"description":{"content":"

All parameter returned by the Identity Provider after signin

\n","type":"text/plain"},"key":"{...}","value":""},{"description":{"content":"

PKCE verifier (none hashed)

\n","type":"text/plain"},"key":"verifier","value":"{{oidcVerifier}}"}],"variable":[]}},"response":[],"_postman_id":"f0f5451c-1211-4572-a862-650e64c40d10"}],"id":"d5208da6-6ced-4ac7-b13c-c64368d3b0a2","description":"

Manage SSO with OpenID Connect standard

\n","_postman_id":"d5208da6-6ced-4ac7-b13c-c64368d3b0a2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}}],"id":"ac6ea662-04d3-4b3b-9b45-29b4b049bd29","description":"

Manage Single Sign-on configurations and sign-in

\n","_postman_id":"ac6ea662-04d3-4b3b-9b45-29b4b049bd29","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Events","item":[{"name":"Create a custom event","id":"2221e817-84bb-41f4-97b7-09e4e34acff3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"topic\": \"test.postman\",\n\t\"data\": {\n\t\t\"--foo\": \"Hello World !\"\n\t}\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/events","description":"

Get the server status.

\n
Permissions: none.
\n

Retrieve a list of events.

\n
Authenticated.\nPermissions: User is admin or super-admin.
\n

Request Body

types (array of strings, optional): An array of event types to filter the results.
search (string, optional): A search string to filter the results.
offset (integer, optional): The offset for paginating through the results.
limit (integer, optional): The limit of results to be returned.
createdBy (string, optional): Filter the results by the creator of the event.
updatedBy (string, optional): Filter the results by the user who last updated the event.
start (string, optional): The start date for filtering the events.
end (string, optional): The end date for filtering the events.

Requeue an event to be processed again.

\n
Authenticated.
Permissions: User is admin or super-admin.
\n

Traverse events using an item or event as startpoint

\n
Authenticated.
Permissions: r on each item being traversed and admin or super-admin.
\n

Enter the _id of the item or event to use as startpoint

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"92d02bb5-f6e1-4f5c-8bff-ac133878f580"},{"name":"Get an event","id":"27be91a9-a708-45b6-a8bb-978bd6552eda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"types\": [\"item.create.Group\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/events/:_key?populate=false","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}},"urlObject":{"path":["{{version}}","events",":_key"],"host":["{{protocole}}{{url}}"],"query":[{"description":{"content":"

Replace the strings \"createdBy\" and \"updatedBy\" by an object representing a user.

\n","type":"text/plain"},"key":"populate","value":"false"}],"variable":[{"id":"b2389020-3151-41fe-afed-20abee720729","description":{"content":"

The _key of the event

\n","type":"text/plain"},"type":"any","value":"{{eventKey}}","key":"_key"}]}},"response":[],"_postman_id":"27be91a9-a708-45b6-a8bb-978bd6552eda"},{"name":"Get events as stream","id":"39dbc5ab-4236-4b66-8f53-5f1c21253fb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"types\": [\"item.create.Group\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/events/stream","description":"

Get events as stream

\n
Authenticated.
Permissions: User is admin or super-admin.
\n

\n
Permissions: none
\n

\n","urlObject":{"path":["{{version}}","bots",":_key","signin"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[{"id":"1b2a8e50-460c-4ece-ae8b-fc3678b8e50f","type":"any","value":"","key":"_key"}]}},"response":[],"_postman_id":"a9d33641-0139-4ee3-9201-e342b0f86202"},{"name":"Create a bot","id":"36cbf37b-ae16-408b-b44d-96f2ea84d00b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"My bot\",\r\n \"description\": \"My test bot\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{protocole}}{{url}}/{{version}}/bots","description":"

Create a user on the domain. If the number of active user exceeds the maximum of users allowed by all the valid licenses combined, then an inactive user will be created.

You can use the property inviteExpiration to choose how many seconds the invitation is valid. This property is ignored if a password is provided.

\n
Permissions: w on the domain usergroup.
\n

Change the state of a bot (active/inactive).

\n
Permissions: w on the bot.
\n

The key of the bot to set active.

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[],"_postman_id":"89ff61f0-d0a6-4566-87a3-d03beeadd078"},{"name":"Generate bot's secret","id":"7705451a-8da6-48f0-960f-e829f6d20914","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{protocole}}{{url}}/{{version}}/users/:_key/secret","description":"

Regenerate the bot's secret

\n
Permissions: w on the bot.
\n

The key of the bot

\n","type":"text/plain"},"type":"any","value":"{{meKey}}","key":"_key"}]}},"response":[],"_postman_id":"7705451a-8da6-48f0-960f-e829f6d20914"}],"id":"413580ab-219e-4edf-a18f-02c98c7bc198","_postman_id":"413580ab-219e-4edf-a18f-02c98c7bc198","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"76f77557-073d-4c32-9bae-909557adc20c","id":"76f77557-073d-4c32-9bae-909557adc20c","name":"Aquarium V2","type":"collection"}}},{"name":"Ping","id":"d04e206b-507f-4069-a2ff-d5cfd85d0130","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/ping","description":"

Ping the server.

\n","urlObject":{"path":["{{version}}","ping"],"host":["{{protocole}}{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d49df292-a615-49b7-9086-aef4e05394e6","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{protocole}}{{url}}/{{version}}/ping"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"access-control-allow-credentials","value":"true"},{"key":"access-control-allow-origin","value":"null"},{"key":"access-control-expose-headers","value":"Accept-Ranges,Content-Range"},{"key":"content-type","value":"text/plain; charset=UTF-8"},{"key":"etag","value":"\"5-dv2B8tXZGrCcINvgl7S82poObJs\""},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-response-time","value":"0ms"},{"key":"x-robots-tag","value":"noindex, nofollow, nosnippet, noarchive"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-length","value":"5"},{"key":"date","value":"Fri, 03 Feb 2023 14:07:50 GMT"}],"cookie":[],"responseTime":null,"body":"pong\n"}],"_postman_id":"d04e206b-507f-4069-a2ff-d5cfd85d0130"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"2ab3f2df-d88a-41c8-b887-e472647149ce","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a4894904-fb83-47a1-9ca7-6fc480591358","type":"text/javascript","exec":[""]}}],"variable":[{"key":"domain","value":"","type":"string"},{"key":"protocole","value":"https://","type":"string","disabled":true},{"key":"url","value":"your-aquarium.com","type":"string","disabled":true},{"key":"version","value":"v1","type":"string","disabled":true},{"key":"email","value":"","type":"string","disabled":true},{"key":"password","value":"","type":"string","disabled":true},{"key":"token","value":"","type":"string","disabled":true}]}