The ProDeal API allows third-party integrations to the ProDeal platform.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4189548","collectionId":"25a445fc-b007-4066-a706-a3544fbdad24","publishedId":"TVCmR4nx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-09-09T23:16:05.000Z"},"item":[{"name":"Current","item":[{"name":"Authentication","item":[{"name":"OAuth client credentials authentication","item":[{"name":"Get access token","id":"165f4224-79c2-4c95-9cab-e2e4e7fb9c98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"Required content type for OAuth token request
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","description":"OAuth 2.0 grant type
\n"},{"key":"client_id","value":"your_client_id","description":"Your OAuth client ID
\n"},{"key":"client_secret","value":"your_client_secret","description":"Your OAuth client secret
\n"}]},"url":"https://prodeal360-prod.auth.us-east-1.amazoncognito.com/oauth2/token","description":"Obtain an access token from AWS Cognito using the Client Credentials flow.
\nSend a POST request to the Cognito token endpoint with your client credentials.
\nOn success, returns a JSON object containing:
\naccess_token: The JWT to use for API requests
expires_in: Token lifetime in seconds
token_type: Always \"Bearer\"
Include the access token in subsequent API requests:
\nAuthorization: Bearer <access_token>\n\nFor example, to retrieve all rooms using a Bearer token:
\ncurl -X GET https://api.prodeal360.com/api/rooms \\\n -H \"Accept: application/json\" \\\n -H \"Authorization: Bearer <access_token>\"\n\nJWT-based authentication for API integrations using AWS Cognito.
\nAuthorization header as a Bearer tokenAccept JSON response
\n"},{"key":"Content-Type","value":"application/json","description":"Send JSON request
\n"}],"body":{"mode":"raw","raw":"{\n \"email\": \"test@acme.com\",\n \"password\": \"q1w2e3r4Q!W@E#R$\"\n}"},"url":"http://localhost:4000//api/session","description":"Creates a new session (login).
\nWhen a new session is created successfully, the return code is 201 Created and the status attribute is \"success\".
When the user has MFA enabled, the return code is 200 OK and the status attribute is \"mfa_required\". The response also includes the mfa_method field indicating the MFA type: \"software\" or \"email\". To complete authentication, perform a request to POST /api/session/mfa.
When the user needs to enroll in MFA, the return code is 200 OK and the status attribute is \"mfa_enrollment_required\".
Code 401 Unauthorized is returned when invalid credentials are entered.
Code 400 Bad Request is returned when email or password is missing.
Accept JSON response
\n"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/session","description":"Destroys the current session (logout).
\nReturns 204 No Content on success.
Accept JSON response
\n"},{"key":"Content-Type","value":"application/json","description":"Send JSON request
\n"}],"body":{"mode":"raw","raw":"{\n \"code\": \"123456\"\n}"},"url":"http://localhost:4000//api/session/mfa","description":"Validates the MFA code and completes the login process.
\nThis endpoint should be called after POST /api/session returns a response with status: \"mfa_required\".
When MFA validation is successful, the return code is 201 Created.
Code 403 Forbidden is returned when an invalid code is entered. You can retry with a new code using the same session.
Code 401 Unauthorized is returned when the session is expired or invalid. In this case, you need to start a new login flow with POST /api/session.
Code 400 Bad Request is returned when the code parameter is missing.
Cookie-based authentication for browser clients.
\nCall POST /api/session with email and password
On success, the server sets a session cookie (_prodeal360_key)
Include this cookie in all subsequent requests
\nThe session is maintained server-side and expires after inactivity
\nIf the user has MFA enabled, the login response will have status: \"mfa_required\". You must then call POST /api/session/mfa with the verification code to complete the login.
Accept JSON response
\n"},{"key":"Content-Type","value":"application/json","description":"Send JSON request
\n"}],"body":{"mode":"raw","raw":"{\n \"email\": \"user@example.com\",\n \"realm\": \"organization-uuid\",\n \"redirect_url\": \"https://app.prodeal360.com/rooms\"\n}"},"url":"http://localhost:4000//api/v2/magic-link","description":"Sends an email with a magic link to the specified email address if a user exists.
\nemail (required): User's email addressrealm (optional): Organization UUID. Defaults to the user's organization UUIDredirect_url (optional): URL to redirect to after successful authenticationReturns 204 No Content on success. The endpoint returns success even if no user exists (for security reasons).
To prevent abuse, users can only request a new magic link once every 3 minutes.
\n401 Unauthorized - User is not authorized to request a magic link500 Internal Server Error - Unexpected error occurredAccept JSON response
\n"}],"url":"http://localhost:4000//api/v2/magic-link?email=user@example.com&token=123456","description":"Validates the email and token parameters and creates a user session if valid.
\nemail (required, query): User's email addresstoken (required, query): The 6-digit magic link token sent via emailReturns 204 No Content on successful login. A session cookie is set automatically.
Requires a valid auth_session_token cookie that was set when the magic link was created.
400 Bad Request - Missing email or token parameters401 Unauthorized - Invalid token or expired session500 Internal Server Error - Unexpected error occurredUser's email address
\n","type":"text/plain"},"key":"email","value":"user@example.com"},{"description":{"content":"6-digit magic link token
\n","type":"text/plain"},"key":"token","value":"123456"}],"variable":[]}},"response":[{"id":"5d0c4aec-ee74-4718-8536-15f2dda7ea37","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Accept JSON response"}],"url":{"raw":"http://localhost:4000//api/v2/magic-link?email=john.doe@prodeal360.com&token=123456","host":["http://localhost:4000/"],"path":["api","v2","magic-link"],"query":[{"key":"email","value":"john.doe@prodeal360.com"},{"key":"token","value":"123456"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"key":"Set-Cookie","value":"loggedIn=true"}],"cookie":[],"responseTime":null,"body":""},{"id":"b2420eb2-74ae-4e24-b427-342f1a4f95af","name":"Invalid token","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Accept JSON response"}],"url":{"raw":"http://localhost:4000//api/v2/magic-link?email=john.doe@prodeal360.com&token=000000","host":["http://localhost:4000/"],"path":["api","v2","magic-link"],"query":[{"key":"email","value":"john.doe@prodeal360.com"},{"key":"token","value":"000000"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"invalid_token\",\n \"message\": \"Invalid or expired token\"\n}"},{"id":"3adbb180-e800-46e3-9877-2b0b54598dbc","name":"Missing parameters","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","description":"Accept JSON response"}],"url":"http://localhost:4000//api/v2/magic-link"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"missing_params\",\n \"message\": \"Missing parameters\"\n}"}],"_postman_id":"fa538314-3b53-46d7-b323-13ebc07c388d"}],"id":"471a2076-db55-4f44-af38-17899d8d90ea","_postman_id":"471a2076-db55-4f44-af38-17899d8d90ea","description":""}],"id":"caa8cec7-a5bd-496c-98b7-a535789cc520","_postman_id":"caa8cec7-a5bd-496c-98b7-a535789cc520","description":""},{"name":"Rooms","item":[{"name":"Clone","item":[{"name":"Clone room","id":"14ada7af-0c6f-450f-878f-d1afc38717c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My Cloned Room\",\n \"additional_data\": [\n \"documents\",\n \"host_team\",\n \"host_team_users\",\n \"admin_teams\",\n \"admin_teams_users\",\n \"guest_teams\",\n \"guest_teams_users\",\n \"notes\",\n \"item_statuses\",\n \"due_dates\",\n \"custom_column_values\",\n \"responsibilities\"\n ],\n \"template\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"http://localhost:4000//api/rooms/:source_room_id/clone","description":"Create a copy of an existing room with optional content duplication.
\nThe room is cloned synchronously, but document copying is done asynchronously.\nThe cloned room is initially created in \"unavailable\" state and will be set to \"open\"\nonce the cloning process completes.
\nWhat gets cloned by default:
\nWhat can be cloned via additional_data parameter:
admin_teams - Admin teams structureadmin_teams_users - Admin team membersguest_teams - Guest teams structureguest_teams_users - Guest team membershost_team - Host team structurehost_team_users - Host team membersdocuments - Documents and filesnotes - Notes attached to itemsitem_statuses - Item status configurationsdue_dates - Due date settingscustom_column_values - Custom column valuesresponsibilities - Team and user responsibilitiesWhat doesn't get cloned:
\nID of the room to clone
\n","type":"text/plain"},"type":"any","value":"3005","key":"source_room_id"}]}},"response":[{"id":"a247711a-1e5c-4e69-8121-a6ae9a5c4dd4","name":"Room cloned successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My Cloned Room\",\n \"additional_data\": [\n \"documents\",\n \"host_team\",\n \"host_team_users\",\n \"admin_teams\",\n \"admin_teams_users\",\n \"guest_teams\",\n \"guest_teams_users\",\n \"notes\",\n \"item_statuses\",\n \"due_dates\",\n \"custom_column_values\",\n \"responsibilities\"\n ],\n \"template\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:source_room_id/clone","host":["{{baseUrl}}"],"path":["api","rooms",":source_room_id","clone"],"variable":[{"key":"source_room_id","value":"3005","description":"ID of the room to clone"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"room_id\": 5652\n}"},{"id":"43145d2b-1f0a-40ef-9ccf-dd1f5ac88c1c","name":"Authentication required or invalid credentials","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My Cloned Room\",\n \"additional_data\": [\n \"documents\",\n \"host_team\",\n \"host_team_users\",\n \"admin_teams\",\n \"admin_teams_users\",\n \"guest_teams\",\n \"guest_teams_users\",\n \"notes\",\n \"item_statuses\",\n \"due_dates\",\n \"custom_column_values\",\n \"responsibilities\"\n ],\n \"template\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:source_room_id/clone","host":["{{baseUrl}}"],"path":["api","rooms",":source_room_id","clone"],"variable":[{"key":"source_room_id","value":"3005","description":"ID of the room to clone"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"unauthorized\",\n \"message\": \"Authentication required\"\n}"},{"id":"9ffd3e90-18ed-41a3-b364-94b461ba79a1","name":"User doesn't have permission to clone this room","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My Cloned Room\",\n \"additional_data\": [\n \"documents\",\n \"host_team\",\n \"host_team_users\",\n \"admin_teams\",\n \"admin_teams_users\",\n \"guest_teams\",\n \"guest_teams_users\",\n \"notes\",\n \"item_statuses\",\n \"due_dates\",\n \"custom_column_values\",\n \"responsibilities\"\n ],\n \"template\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:source_room_id/clone","host":["{{baseUrl}}"],"path":["api","rooms",":source_room_id","clone"],"variable":[{"key":"source_room_id","value":"3005","description":"ID of the room to clone"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"user_cant_clone_room\",\n \"message\": \"User can't clone this room.\"\n}"},{"id":"708496dd-0f67-4e14-90d5-1310fbb6c168","name":"Source room not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My Cloned Room\",\n \"additional_data\": [\n \"documents\",\n \"host_team\",\n \"host_team_users\",\n \"admin_teams\",\n \"admin_teams_users\",\n \"guest_teams\",\n \"guest_teams_users\",\n \"notes\",\n \"item_statuses\",\n \"due_dates\",\n \"custom_column_values\",\n \"responsibilities\"\n ],\n \"template\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:source_room_id/clone","host":["{{baseUrl}}"],"path":["api","rooms",":source_room_id","clone"],"variable":[{"key":"source_room_id","value":"3005","description":"ID of the room to clone"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"source_room_not_found\",\n \"message\": \"Couldn't find the source room.\"\n}"},{"id":"9cac8dc9-4f95-4419-9915-201144d24a3b","name":"Validation failed on one or more fields","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My Cloned Room\",\n \"additional_data\": [\n \"documents\",\n \"host_team\",\n \"host_team_users\",\n \"admin_teams\",\n \"admin_teams_users\",\n \"guest_teams\",\n \"guest_teams_users\",\n \"notes\",\n \"item_statuses\",\n \"due_dates\",\n \"custom_column_values\",\n \"responsibilities\"\n ],\n \"template\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:source_room_id/clone","host":["{{baseUrl}}"],"path":["api","rooms",":source_room_id","clone"],"variable":[{"key":"source_room_id","value":"3005","description":"ID of the room to clone"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"validation_failed\",\n \"message\": \"Validation failed\",\n \"errors\": [\n {\n \"code\": \"required\",\n \"field\": \"name\",\n \"message\": \"can't be blank\"\n },\n {\n \"code\": \"length\",\n \"field\": \"description\",\n \"message\": \"should be at most 500 character(s)\"\n }\n ]\n}"},{"id":"ccf7cc23-fb34-41a7-be99-95c798302472","name":"Internal server error - room clone failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"My Cloned Room\",\n \"additional_data\": [\n \"documents\",\n \"host_team\",\n \"host_team_users\",\n \"admin_teams\",\n \"admin_teams_users\",\n \"guest_teams\",\n \"guest_teams_users\",\n \"notes\",\n \"item_statuses\",\n \"due_dates\",\n \"custom_column_values\",\n \"responsibilities\"\n ],\n \"template\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:source_room_id/clone","host":["{{baseUrl}}"],"path":["api","rooms",":source_room_id","clone"],"variable":[{"key":"source_room_id","value":"3005","description":"ID of the room to clone"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"room_clone_failed\",\n \"message\": \"Failed to clone the room.\"\n}"}],"_postman_id":"14ada7af-0c6f-450f-878f-d1afc38717c4"}],"id":"8ca5418a-748c-4d76-8fa1-d5b5d6cf28b0","_postman_id":"8ca5418a-748c-4d76-8fa1-d5b5d6cf28b0","description":""},{"name":"Bookmark","item":[{"name":"Bookmark room","id":"04e075b9-1d8c-4e83-95b0-a5548a48e698","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:4000//api/rooms/:id/bookmark","description":"Add room to current user's bookmarks for quick access.\nBookmarked rooms appear in the user's favorites list.
\n","urlObject":{"path":["api","rooms",":id","bookmark"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"a8a25991-4160-457d-9c65-589d51f1aca1","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"5a87eb35-5485-4ce7-a09a-7bbbf48be7f6","name":"Room bookmarked successfully","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerRemove room from current user's bookmarks
\n","urlObject":{"path":["api","rooms",":id","bookmark"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"977d1b9c-d083-4a93-95b9-46e87795ea36","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"bbb236fc-dae9-4b83-91f5-19a6801c312a","name":"Bookmark removed successfully","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BearerJoin a room as a participant.
\nRequirements:
\nAfter joining, the user gains access according to their team assignments.
\n","urlObject":{"path":["api","rooms",":id","join"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"6bd8a7f8-c262-4d34-957b-4d50bb1320f5","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"9b6beae1-2668-4fab-918c-51081bcafe96","name":"Successfully joined room","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerLeave a room and remove yourself from all teams.
\nImportant:
\nReturns 200 with confirmation message on success.
Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"23abb87f-202c-4390-8a3b-8bfb7aad80f8","name":"Successfully left room","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerRetrieve column configuration for the room.
\nColumns define what fields are displayed in the room's item list view.\nThis is the default configuration that applies to all users unless\nthey have personal overrides.
\n","urlObject":{"path":["api","rooms",":id","columns"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"43d80adc-b574-40da-81df-58ae068c8581","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"f1a91897-42b5-48e4-aaff-9f357426591c","name":"Room column configuration","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerRetrieve the current user's personal column preferences for this room.
\nIf the user hasn't customized columns, this returns the room's default\ncolumn configuration. User preferences override room defaults.
\n","urlObject":{"path":["api","rooms",":id","user_columns"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"89d99407-c4ce-4494-9742-1916127e25d4","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"0b0db52f-6183-4960-ac80-ed89f4ada7cb","name":"User's column preferences","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerCreate an export job for room data in XLSX or CSV format.
\nExport includes:
\nProcess:
\nLarge rooms may take several minutes to export.
\n","urlObject":{"path":["api","rooms",":id","export"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"7a41e414-b4be-418c-a901-f3e052259030","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"a8739b71-fdf0-4cf3-b8a0-6eaf7f6c00e5","name":"Export job created successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerCheck the status of a room export job or download the completed file.
\nStatus values:
\npending: Export queuedprocessing: Export in progresscompleted: Export ready for downloadfailed: Export failed (check error message)When status is \"completed\", the response includes a download_url or\nreturns the file directly as binary data.
Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"},{"id":"42ad8ede-76d7-4d9d-9627-76fc0188420f","description":{"content":"Export job identifier
\n","type":"text/plain"},"type":"any","value":"string","key":"room_export_id"}]}},"response":[{"id":"8fce8977-d18b-44fa-bad4-9881cbddd280","name":"Export file or status information","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerCopy items to another folder or room.
\nCopy behavior:
\nCross-room copying:
\nSource room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"9a4b1e2f-ba6c-4bcf-ba7c-451f283c6d86","name":"Items copied successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerMove items to another folder within the same room.
\nMove behavior:
\nCannot move items across rooms - use copy instead.
\n","urlObject":{"path":["api","rooms",":id","items","move"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"9a5a62b3-7434-4e7d-9b68-92e08f6a12e3","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"b41f4b71-d419-4ef4-9422-3208db3a2214","name":"Items moved successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerMark multiple items as read for the current user.
\nUpdates the read status and timestamp for tracking user activity.\nUseful for implementing \"mark all as read\" functionality.
\n","urlObject":{"path":["api","rooms",":room_id","items","read"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"cefd3d5a-afc5-4436-a622-9e645f5bed78","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"}]}},"response":[{"id":"9f00d07c-8c9d-4957-9366-3f2127d0ab4f","name":"Items marked as read","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerMark multiple items as unread for the current user.
\nResets the read status to draw attention back to these items.\nUseful for flagging items that need revisiting.
\n","urlObject":{"path":["api","rooms",":room_id","items","unread"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"50cca6af-70e1-43c6-a0b6-9f81e2570407","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"}]}},"response":[{"id":"233416be-d180-476f-8788-6870b37aaee0","name":"Items marked as unread","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerConfigure which teams can access specific items.
\nAccess control:
\nteam_ids array to remove restrictionsPermissions:
\nRoom identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"}]}},"response":[{"id":"e59ddcc2-3481-40f9-ab2d-f1c3c761694d","name":"Access updated successfully","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerRetrieve access control information for an item.
\nResponse includes:
\nIf item access is not restricted, it inherits room-level permissions.
\n","urlObject":{"path":["api","rooms",":room_id","items",":item_id","access"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"2677943d-7b59-45ad-a573-48e810db27e4","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"},{"id":"c3b7ae37-1795-4af6-8e98-335e21bab95d","description":{"content":"Item identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"item_id"}]}},"response":[{"id":"a85b26c9-9db6-46d4-af8d-1f958b9272fa","name":"Item access information","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerGet all notes and comments on a specific item.
\nResponse includes:
\nNotes are returned in chronological order (oldest first).
\n","urlObject":{"path":["api","rooms",":room_id","items",":item_id","notes"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"08485e4f-d891-43a0-8520-f8e856e22c13","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"},{"id":"0311bf96-5382-461e-a50a-9e2c4bfabeaa","description":{"content":"Item identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"item_id"}]}},"response":[{"id":"f46c18fb-66c0-43c3-bc06-3bbd1c2c99fe","name":"List of notes","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerAdd a note or comment to an item.
\nUse cases:
\nNotes support plain text and basic formatting.
\n","urlObject":{"path":["api","rooms",":room_id","items",":item_id","notes"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"5664fa63-b27d-4574-848b-c01304adbd76","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"},{"id":"d18de8df-95bb-427c-a5fe-fd4cb0727936","description":{"content":"Item identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"item_id"}]}},"response":[{"id":"3b2a38b9-b711-42d8-b787-38c8be215b30","name":"Note created successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerUpdate the content of an existing note.
\nPermissions:
\nEdited notes show an \"edited\" indicator with timestamp.
\n","urlObject":{"path":["api","rooms",":room_id","items",":item_id","notes",":note_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"9670e58b-ce19-4540-9cfb-44926c65d7a9","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"},{"id":"5c248111-f0a5-44bf-8dbb-7457216e1b12","description":{"content":"Item identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"item_id"},{"id":"c8e39bf5-20cd-4268-a6e8-1cce369b26b2","description":{"content":"Note identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"note_id"}]}},"response":[{"id":"f28f1de3-af7e-4339-9862-a9bdfd88c97b","name":"Note updated successfully","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerDelete a note permanently.
\nPermissions:
\nThis action cannot be undone.
\n","urlObject":{"path":["api","rooms",":room_id","items",":item_id","notes",":note_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"c9c5ca85-6d3f-4686-958d-20946cdf6d11","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"},{"id":"a0b7fe5c-8b38-44f2-84fd-aec8211e093f","description":{"content":"Item identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"item_id"},{"id":"78422ba6-a04c-435c-816c-d46923aa500d","description":{"content":"Note identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"note_id"}]}},"response":[{"id":"1c166945-e1da-4fb0-a67e-c2e79a8113dc","name":"Note deleted successfully","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BearerDownload the latest version of a document.
\nReturns the file content as binary data with appropriate Content-Type\nand Content-Disposition headers for browser download.
\nOnly works for document items (not folders).
\n","urlObject":{"path":["api","rooms",":room_id","items",":item_id","download"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"ada1c47a-165b-453a-8349-8baf5759a76c","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"},{"id":"29ef8beb-0a1d-40c5-9ad0-307b1f218357","description":{"content":"Item identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"item_id"}]}},"response":[{"id":"5a27c93b-3495-491a-9e33-67afe77b994a","name":"File download","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/octet-stream"},{"key":"Authorization","value":"BearerDownload a specific historical version of a document.
\nUseful for:
\nReturns the file content as binary data.
\n","urlObject":{"path":["api","rooms",":room_id","items",":item_id","download",":file_version_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"d33c5752-a863-4bda-9572-9db8813089f7","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"},{"id":"584612a3-7996-4419-8d7a-3c85fdac408b","description":{"content":"Item identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"item_id"},{"id":"27f93de4-9be9-4780-ab3a-289a2c3a60bd","description":{"content":"File version identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"file_version_id"}]}},"response":[{"id":"77935638-5160-42f8-b9eb-f2d82d15fbc5","name":"File download","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/octet-stream"},{"key":"Authorization","value":"BearerGet complete version history of a document.
\nResponse includes for each version:
\nVersions are returned in reverse chronological order (latest first).
\n","urlObject":{"path":["api","rooms",":room_id","items",":item_id","versions"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"0f4940db-35c1-410d-9810-c5626757c85d","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"},{"id":"03bf35ea-eb98-459b-b0bc-7b811db0de27","description":{"content":"Item identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"item_id"}]}},"response":[{"id":"8020b908-a5ff-443c-9422-ea4540bcecde","name":"List of file versions","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerCreate a ZIP archive containing multiple items for download.
\nProcess:
\nDownload includes:
\nLarge downloads may take several minutes to prepare.
\n","urlObject":{"path":["api","rooms",":room_id","items","bulk_download"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"441454e6-3c64-425b-9c23-65eb42a1a7da","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"}]}},"response":[{"id":"92f4eb7b-c808-4db9-966a-36f46a561bc7","name":"Download job created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerCheck the status of a bulk download job or download the ZIP file.
\nStatus values:
\npending: Download queuedprocessing: Creating ZIP archivecompleted: Ready for downloadfailed: Download failedWhen completed, returns ZIP file as binary data or provides download URL.
\n","urlObject":{"path":["api","rooms",":room_id","items","bulk_download",":id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"9b1ffa2e-ef5d-4b85-b143-5e30685f681c","description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"room_id"},{"id":"0eebc1e4-7157-4b82-aae9-524f8333a07b","description":{"content":"Download job identifier
\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"742f471c-8728-4170-aac9-3aee5b7aba14","name":"Download file or status","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerGet a list of items (documents and folders) in a room.
\nGeneral parameters:
\nUse parent_id parameter to list items in a specific folder
Use parent_id=null or omit it to list root-level items
Use include_files=false to exclude documents. (default true)
Use include_children=true to include children items for the folders. (default false)
Use include_document_count=false to not calculate the number of documents per each folder. (default true)
Use include_access_level=false to not calculate the access level of each accessible team per each folder. (default true)
Use format=flat to return the items in a flat list. (default tree)
Sorting:
\nUse the sort parameter with comma-separated field names
Prefix field name with - for descending order
Available sort fields:
\nid
name
parent_id
inserted_at
updated_at
manually_approved
rank
status
custom_value
due_date
type
creator_user_id
creator_team_id
room_id
current_file_version_id
legacy_document_id
deleted_at
path
full_path
uuid
sid
index
locked
file_status
original_name
due_date_reminder
updater_user_id
read_only
last_modified_at
last_modified_user_id
file_request_enabled
file_request_id
public_link_enabled
Example: sort=-last_modified_at,name sorts by last_modified_at descending, then name ascending
Filtering:
All filter parameters should be passed in the query string.
Filters available:
\nitems_ids: comma-separated item ids
term: wildcard search in sid and name fields
last_modified_at[ge]: items modified after this date (ISO 8601 format)
last_modified_at[le]: items modified before this date (ISO 8601 format)
type: folder or document
file_extension: comma-separated documents extensions
status: comma-separated item statuses
file_status: created, uploading, moving, converting, ready, error_uploading, error_moving or error_converting
unread: files or notes
responsible_teams_ids: comma-separated team ids
responsible_users_ids: comma-separated user ids
file_request: true or false
Example: type=document&status=open will return the documents with status = open
Response includes:
\nEach item in the response array is an object with the following fields:
\nid (number): Unique identifier of the item
uuid (string): UUID of the item
sid (string): Short identifier
name (string): Name of the item
type (string): Type of the item (heading, line_item, folder or document)
level (integer): Nesting level
status (string): Status of the item (e.g., open, in_progress)
fileStatus (string): File status (created, uploading, moving, converting, ready, error_uploading, error_moving or error_converting)
fileRequestEnabled (boolean): Whether file request is enabled
locked (boolean): Whether the item is locked
readOnly (boolean): Whether the item is read-only
unread (boolean): Whether the item is unread
rank (number): Sort rank
size (number): File size
documentCount (number): Number of documents inside this folder
newNotesCount (number): Number of new notes
parentId (number): ID of the parent item
parentUuid (number): UUID of the parent item
dueDate (string): Due date (ISO 8601)
dueDateReminder (string): Due date reminder
lastNote (string): Last note
lastModifiedAt (string): Last modification date (ISO 8601)
lastModifiedUserId (number): User ID of last modifier
lastModifiedUserName (string): Username of last modifier
updatedAt (string): Updated at date (ISO 8601)
updaterUserId (number): User ID of updater
updaterUserName (string): Username of updater
creatorUserId (number): User ID of creator
creatorUserName (string): Username of creator
children (array): Child items (when include_children=true)
ancestors (array): List of ancestor items with id and name
responsibleTeamsAndUsers (array): List of responsible teams and users
accessibleTeams (array): List of teams with access, each containing:
id (number): Team ID
name (string): Team name
abbreviation (string): Team abbreviation
accessLevel (string): Access level (full, partial or none)
roleId (string): Role ID (host_admin, admin, restricted or view_only)
typeName (string): Type name
accessibleItems (array): Accessible items
Room identifier
\n","type":"text/plain"},"type":"any","value":"999","key":"id"}]}},"response":[{"id":"c4190615-aabf-438b-8ab3-b2ef0168d3cc","name":"List of items","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerCreate one or more items in a room. Items must be provided inside an items array.
Item type is determined automatically based on the parent hierarchy:
\nNo parent (parent_id: null) → creates a heading (top-level item)
Parent is a heading → creates a line_item
\nParent is a line_item or folder → creates a folder
\nTo create a document, explicitly set \"type\": \"document\" on the item inside the items array.
Creating flat items in a parent:
\n{\n \"parent_id\": 1,\n \"items\": [\n { \"name\": \"Folder A\" },\n { \"name\": \"Folder B\" }\n ]\n}\n\nCreating nested items (with children):
\n{\n \"items\": [\n {\n \"name\": \"Heading 1\",\n \"children\": [\n {\n \"name\": \"Line Item 1\",\n \"children\": [\n { \"name\": \"Folder 1\" }\n ]\n }\n ]\n }\n ]\n}\n\nOptional parameters:
\nparent_id : ID of the parent item. Omit or set to null for root-level items.
rename_duplicates : If true, when a duplicated item name is encountered, it should rename appending a counter (n) or throw. (default false).
On success, the API returns an array of created item objects. Each object in the array represents a newly created item and contains the following properties:
\n","urlObject":{"path":["api","rooms",":id","items"],"host":["http://localhost:4000/"],"query":[],"variable":[{"description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"999","key":"id"}]}},"response":[{"id":"c61f93c5-14a8-4cf1-8c78-694f370365d1","name":"Items created successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"name\": \"Legal Documents\"\n }\n ],\n \"parent_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:id/items","host":["{{baseUrl}}"],"path":["api","rooms",":id","items"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 2661,\n \"name\": \"Legal Documents\",\n \"original_name\": \"Legal Documents\",\n \"type\": \"heading\",\n \"parent_id\": null,\n \"rank\": 1000,\n \"deepness\": 0,\n \"level\": 0,\n \"full_path\": null,\n \"status\": null,\n \"file_status\": \"ready\",\n \"empty\": true,\n \"read_only\": null,\n \"unread\": false,\n \"subscribed\": false,\n \"has_notes\": false,\n \"new_notes_count\": 0,\n \"custom_column_value\": null,\n \"due_date\": null,\n \"is_overdue\": false,\n \"due_date_reminder\": null,\n \"creator_user_id\": 123,\n \"creator_user_name\": \"John Doe\",\n \"updater_user_id\": 123,\n \"updater_user_name\": \"John Doe\",\n \"last_modified_at\": \"2025-01-15T10:30:00.000Z\",\n \"last_modified_user_id\": 123,\n \"last_modified_user_name\": \"John Doe\",\n \"uploader_client_uid\": null,\n \"accessible_teams\": [\n {\n \"id\": 1,\n \"name\": \"Host Admin Team\",\n \"abbreviation\": \"HA\",\n \"role_id\": 1,\n \"type_name\": \"host_admin\"\n }\n ],\n \"responsible_teams\": [],\n \"ancestors\": []\n }\n]"},{"id":"c019e199-d7c7-44ce-a47e-7a5d876fbb5a","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"name\": \"Legal Documents\"\n }\n ],\n \"parent_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:id/items","host":["{{baseUrl}}"],"path":["api","rooms",":id","items"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"cant_create_document_without_valid_parent\",\n \"message\": \"Document items can't have children items.\"\n}"},{"id":"ff9e95f1-4dcb-40dd-860c-51760a66e161","name":"Authentication required or invalid credentials","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"name\": \"Legal Documents\"\n }\n ],\n \"parent_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:id/items","host":["{{baseUrl}}"],"path":["api","rooms",":id","items"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"unauthorized\",\n \"message\": \"Authentication required\"\n}"},{"id":"6e86244d-523c-401a-a1f3-3a3281c93954","name":"Insufficient permissions to create items","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"name\": \"Legal Documents\"\n }\n ],\n \"parent_id\": null\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:id/items","host":["{{baseUrl}}"],"path":["api","rooms",":id","items"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"user_cant_create_items\",\n \"message\": \"User can't create items in the given room.\"\n}"}],"_postman_id":"065e3697-7baa-4b69-a70a-d09688808e7d"},{"name":"Update items","id":"3c6876ad-f563-4864-8d23-b6b5f5492cca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": 340934,\n \"name\": \"New heading name 2\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"http://localhost:4000//api/rooms/:id/items","description":"Update one or more items in a room.
\nThe request body is a JSON array sent at the top level (not wrapped in an object).
Each element must include the item id and the fields to update.
Updatable fields (host_admin / admin):
\nname — Item name (max 200 characters)
status — Item status
custom_value — Custom column value
due_date — Due date
position — Reorder item among its siblings (0-indexed)
due_date_reminder — Due date reminder settings (embedded object)
Updatable fields (guest):
\nname — Only if the user is the creator of the item
status — Only if allow_guest_team_change_item_status is enabled on the room
custom_value — Only for folder-class items (heading, line_item, folder)
Updatable fields (restricted):
\nstatus — Item status onlyStatus bulk update:
When all items in the request only contain id and status fields with the same status value,
a more efficient bulk update is performed.
Examples:
\nUpdate the name of a single item:
\n[\n {\n \"id\": 10,\n \"name\": \"New heading name\"\n }\n]\n\nUpdate the position of an item:
\n[\n {\n \"id\": 15,\n \"position\": 5\n }\n]\n\nBulk update status for multiple items:
\n[\n { \"id\": 10, \"status\": \"approved\" },\n { \"id\": 15, \"status\": \"approved\" }\n]\n\nOn success, the API returns an array of updated item objects. Each object in the array represents an updated item and contains the following properties:
\n","urlObject":{"path":["api","rooms",":id","items"],"host":["http://localhost:4000/"],"query":[],"variable":[{"description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"999","key":"id"}]}},"response":[{"id":"a4da5562-8dcb-4f21-aa30-015b38fb0e65","name":"Items updated successfully","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": 10,\n \"name\": \"New heading name\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:id/items","host":["{{baseUrl}}"],"path":["api","rooms",":id","items"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 10,\n \"name\": \"New heading name\",\n \"original_name\": null,\n \"type\": \"heading\",\n \"parent_id\": null,\n \"rank\": 1000,\n \"deepness\": 0,\n \"level\": 0,\n \"full_path\": null,\n \"status\": null,\n \"file_status\": \"ready\",\n \"empty\": false,\n \"read_only\": null,\n \"unread\": false,\n \"subscribed\": false,\n \"has_notes\": false,\n \"new_notes_count\": 0,\n \"custom_column_value\": null,\n \"due_date\": null,\n \"is_overdue\": false,\n \"due_date_reminder\": null,\n \"creator_user_id\": 123,\n \"creator_user_name\": \"John Doe\",\n \"updater_user_id\": 123,\n \"updater_user_name\": \"John Doe\",\n \"last_modified_at\": \"2025-01-15T10:30:00.000Z\",\n \"last_modified_user_id\": 123,\n \"last_modified_user_name\": \"John Doe\",\n \"uploader_client_uid\": null,\n \"accessible_teams\": [\n {\n \"id\": 1,\n \"name\": \"Host Admin Team\",\n \"abbreviation\": \"HA\",\n \"role_id\": 1,\n \"type_name\": \"host_admin\"\n }\n ],\n \"responsible_teams\": [],\n \"ancestors\": []\n }\n]"},{"id":"4626bbb1-3b69-4a90-9131-e518d672eb89","name":"Bad request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": 10,\n \"name\": \"New heading name\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:id/items","host":["{{baseUrl}}"],"path":["api","rooms",":id","items"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"cant_update_items_name_already_exists\",\n \"message\": \"Item name already exists in the given path.\"\n}"},{"id":"39149495-81eb-40b6-a1b7-daba11b998bf","name":"Authentication required or invalid credentials","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": 10,\n \"name\": \"New heading name\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:id/items","host":["{{baseUrl}}"],"path":["api","rooms",":id","items"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"unauthorized\",\n \"message\": \"Authentication required\"\n}"},{"id":"a00e6ca6-30b5-46f2-b72a-f5ffbc66c9fb","name":"Insufficient permissions to update items","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"id\": 10,\n \"name\": \"New heading name\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:id/items","host":["{{baseUrl}}"],"path":["api","rooms",":id","items"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"user_cant_update_items\",\n \"message\": \"User can't update items in the given room.\"\n}"}],"_postman_id":"3c6876ad-f563-4864-8d23-b6b5f5492cca"},{"name":"Get item","id":"d1d30394-d528-48e9-bf1a-5bdd78ec2ff1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:4000//api/rooms/:room_id/items/:item_id","description":"Retrieve detailed information about a specific item.
\nNOTE: Getting an item marks it as read for the current user.
\nOn success, the API returns an item object containing the following properties:
\n","urlObject":{"path":["api","rooms",":room_id","items",":item_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"999","key":"room_id"},{"description":{"content":"Item identifier
\n","type":"text/plain"},"type":"any","value":"340930","key":"item_id"}]}},"response":[{"id":"adf00b43-28bd-426a-84d6-29d945082f71","name":"Item details","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerDelete multiple items at once.
\nThe request body must contain an item_ids array with the IDs of the items to delete.
Permissions:
\nHost admins and admins can delete any item.
\nGuests can only delete items they created (creator_user_id matches their user ID).
Restricted users cannot delete items.
\nIf any item in the list fails the permission check, the entire request is rejected.
\nExample curl:
\ncurl -X DELETE /api/rooms/123/items \\\n -H \"Content-Type: application/json\" \\\n -d '{\"item_ids\": [886, 9087]}'\n\nRoom identifier
\n","type":"text/plain"},"type":"any","value":"999","key":"id"}]}},"response":[{"id":"94d8971f-f82a-4db8-b48f-fb1f7bea3dfb","name":"Items deleted successfully (empty response body)","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_ids\": [\n 886,\n 9087\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:id/items","host":["{{baseUrl}}"],"path":["api","rooms",":id","items"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"8c557599-861d-474e-aae0-2684f0596701","name":"User does not have permission to delete the given items","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_ids\": [\n 886,\n 9087\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:id/items","host":["{{baseUrl}}"],"path":["api","rooms",":id","items"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"user_cant_delete_items\",\n \"message\": \"User can't delete given items.\"\n}"},{"id":"84689a11-7e6e-4e6c-9ec7-2ed5e3d0431d","name":"Unexpected error during deletion","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"item_ids\": [\n 886,\n 9087\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/api/rooms/:id/items","host":["{{baseUrl}}"],"path":["api","rooms",":id","items"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"item_delete_failed\",\n \"message\": \"Failed to delete given items.\"\n}"}],"_postman_id":"ba6ad7b5-063d-4f11-8639-5ffd5c4673b6"},{"name":"Get view URL","id":"6f724b8a-baa7-44f2-bf96-af0a485baa20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:4000//api/rooms/:room_id/items/:item_id/view","description":"Get a URL for viewing the document in a browser viewer.
\nResponse includes:
\nview_url: URL to view document onlineUseful for document preview functionality.
\n","urlObject":{"path":["api","rooms",":room_id","items",":item_id","view"],"host":["http://localhost:4000/"],"query":[],"variable":[{"description":{"content":"Room identifier
\n","type":"text/plain"},"type":"any","value":"999","key":"room_id"},{"description":{"content":"Item identifier
\n","type":"text/plain"},"type":"any","value":"340889","key":"item_id"}]}},"response":[{"id":"d5219ccc-e961-4cb3-8897-4bb9f14d65ba","name":"View URL","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerStart an asynchronous room import workflow from an S3 bucket.
\nEach top-level folder under the configured prefix in the bucket becomes a new room, with the folder name used as the room name. Any nested structure under that folder is imported into the corresponding room.
\nBucket folder semantics:
\n/\n Deal 1/ <- Room \"Deal 1\"\n Sub Folder 1/\n Document 1\n Sub Folder 2/\n Sub Folder 4/\n Deal 2/ <- Room \"Deal 2\"\n Sub Folder 3/\n Sub Folder 4/\n\nThe import runs in the background. Use GET /api/rooms/import/{id} with the returned workflowId to poll for progress.
Retrieve the current status of a room import workflow previously started via POST /api/rooms/import.
Poll this endpoint to track the progress of the import. The state field indicates the current phase of the workflow (e.g. executing, completed, failed).
The workflow ID returned from the import request
\n","type":"text/plain"},"type":"any","value":"019caeb8-c494-7b00-a497-fb1a533fa5e3","key":"id"}]}},"response":[{"id":"6ee79ba9-631b-411c-9d84-ee8033e629e9","name":"Import workflow status retrieved successfully","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/rooms/import/:id","host":["{{baseUrl}}"],"path":["api","rooms","import",":id"],"variable":[{"key":"id","value":"019caeb8-c494-7b00-a497-fb1a533fa5e3","description":"The workflow ID returned from the import request"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"bucket\": \"prodeal360-dev-external-2\",\n \"roomKind\": \"folder_view\",\n \"state\": \"executing\",\n \"workflowId\": \"019caeb8-c494-7b00-a497-fb1a533fa5e3\"\n}"},{"id":"11ca42cb-e70f-4e4e-814d-f2a4b69cb4cf","name":"Authentication required or invalid credentials","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/rooms/import/:id","host":["{{baseUrl}}"],"path":["api","rooms","import",":id"],"variable":[{"key":"id","value":"019caeb8-c494-7b00-a497-fb1a533fa5e3","description":"The workflow ID returned from the import request"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"unauthorized\",\n \"message\": \"Authentication required\"\n}"},{"id":"7d1d5707-b2c3-48c5-b1ba-9b880397d0bd","name":"Import workflow not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/rooms/import/:id","host":["{{baseUrl}}"],"path":["api","rooms","import",":id"],"variable":[{"key":"id","value":"019caeb8-c494-7b00-a497-fb1a533fa5e3","description":"The workflow ID returned from the import request"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"Import workflow not found\"\n}"}],"_postman_id":"d2721a25-eccd-4bec-ba83-08dc82d233e9"}],"id":"473009b8-ee5d-4947-8e09-d2db69b9224e","_postman_id":"473009b8-ee5d-4947-8e09-d2db69b9224e","description":""},{"name":"List rooms","id":"cb23eac8-dfb5-416d-9dea-0bb9fef00877","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:4000//api/rooms","description":"Get list of rooms accessible to the current user based on their permissions.
\nThe endpoint supports filtering, pagination, and sorting. Results are automatically filtered
to only include rooms the authenticated user has access to. Training/deal rooms are excluded
by default unless explicitly included via filters.
Pagination:
\nPagination params are passed by query params: page-number, per-page, total, total-pages
\nResults are paginated with a default page size of 50 items
\nMaximum page size is 100 items
\nMinimum page size is 1 item
\nPagination headers are included in the response (page-number, per-page, total, total-pages)
\nFiltering:
All filter parameters should be passed in the query string. Multiple values can be provided as comma-separated strings.
state: Filter by room state. Valid values: open (active), closed (inactive), archived
division_id: Filter by division ID(s). Comma-separated for multiple values
workspace_id: Filter by workspace ID. Use null to get rooms without a workspace
room_type: Filter by room type (e.g., \"real_estate_-_acquisition\", \"aviation\", \"energy\")
room_kind: Filter by room kind. Valid values: checklist_view, folder_view
template: Filter by template status. Valid values: true, false, all (to include both)
name: Search rooms by name (partial match, case-insensitive)
name_or_id: Search by room name or ID
search_term: General search term for room name
id: Filter by specific room ID(s). Comma-separated for multiple values
bookmarked: Filter by bookmarked status. Valid values: true, false
roles: Filter by user's role in the room. Comma-separated values: host_admin, admin, guest, restricted
creators: Filter by creator user ID(s). Comma-separated for multiple values
cost_center_id: Filter by cost center ID(s). Comma-separated for multiple values
asset_type or building_type: Filter by asset/building type
inserted_at_min: Filter rooms created after this date (ISO 8601 format)
inserted_at_max: Filter rooms created before this date (ISO 8601 format)
meta_\\\\\\*: Filter by custom metadata fields. Replace \\\\\\* with the metadata key name
Sorting:
\nUse the sort parameter with comma-separated field names
Prefix field name with - for descending order
Default sorting: by name and ID (ascending)
\nAvailable sort fields: name, created_date, interacted_at, division, workspace, room_creator, type, closing_date, transaction_amount
Example: sort=-created_date,name sorts by created_date descending, then name ascending
Response:
Returns an array of room objects with metadata including creator, teams, division, organization,
progress details, and user-specific information like role and favorite status.
Only accept JSON documents
\n"},{"key":"Content-Type","value":"application/json","description":"Return JSON document
\n"}],"body":{"mode":"raw","raw":"{\n \"file_name\": \"document.pdf\",\n \"parent_id\": 123,\n \"accessible_team_ids\": [1, 2, 3]\n}"},"url":"http://localhost:4000//api/rooms/:room_id/presigned-upload-url","description":"This endpoint generates a presigned URL for uploading a file directly to the room.
\nRequest presigned URL: Call this endpoint with the file metadata (name, destination folder, team access).
\nReceive presigned URL: The server returns a time-limited presigned URL.
\nUpload file: Use the presigned URL to make a PUT request with the file content. Example using curl: curl -X PUT \"https://storage.example.com/...\" --data-binary @/path/to/document.pdf -H \"Content-Type: application/pdf\"
File processing: After a successful upload, the file is processed and made available in the room once processing is complete.
\nThe presigned URL is valid for 1 hour after generation.
\nWhen uploading to the presigned URL, use PUT method with the file content as the request body.
Set the appropriate Content-Type header when uploading to match the file type.
Update room properties and settings.
\nPermissions:
\nRoom hosts can update all properties
\nRoom admins can update most properties
\nOther users cannot update rooms
\nRoom identifier
\n","type":"text/plain"},"type":"any","value":"926","key":"id"}]}},"response":[{"id":"d3ae6789-4b9f-4a4d-a4a7-624fb1418a6b","name":"Room updated successfully","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerRequirements:
\nThe user must be a host_admin of the room.
\nThe user must belong to the same organization that owns the room.
\nRoom deletion must be enabled for the user's organization (room_deletion_enabled setting).
Room identifier
\n","type":"text/plain"},"type":"any","value":"926","key":"id"}]}},"response":[{"id":"6f9ae07e-56e4-41c6-b4cc-810609c88c02","name":"Room successfully deleted (soft delete). No content returned.","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"{{baseUrl}}/api/rooms/:id","host":["{{baseUrl}}"],"path":["api","rooms",":id"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"777df152-5673-4736-9d65-9e581b0237f5","name":"Authentication required or invalid credentials","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/rooms/:id","host":["{{baseUrl}}"],"path":["api","rooms",":id"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"unauthorized\",\n \"message\": \"Authentication required\"\n}"},{"id":"709bccfe-38c8-4a54-9a85-6855cf271026","name":"Insufficient permissions to delete the room","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/rooms/:id","host":["{{baseUrl}}"],"path":["api","rooms",":id"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"room_not_found\",\n \"message\": \"Room ID 3005 not found.\"\n}"},{"id":"5c624def-0984-41e0-be0a-56f52e44583d","name":"Unexpected server error during deletion","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/rooms/:id","host":["{{baseUrl}}"],"path":["api","rooms",":id"],"variable":[{"key":"id","value":"3005","description":"Room identifier"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"room_delete_failed\",\n \"message\": \"Failed to delete room ID 3005.\"\n}"}],"_postman_id":"99cd7669-dfbf-47c7-a318-e81633ad2e6a"}],"id":"470f6779-f75c-49e9-8e27-48c6cfd71cdd","_postman_id":"470f6779-f75c-49e9-8e27-48c6cfd71cdd","description":""},{"name":"Organizations","item":[{"name":"Rooms","item":[{"name":"List organization rooms","id":"a81721f8-cf7e-49d7-b31a-fd787f51d592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:4000//api/organizations/:organization_id/rooms?page=1&per_page=50","description":"Get all rooms in an organization (organization admin only).
\nProvides comprehensive view of all rooms regardless of user's\nindividual room memberships. Useful for administration and reporting.
\n","urlObject":{"path":["api","organizations",":organization_id","rooms"],"host":["http://localhost:4000/"],"query":[{"description":{"content":"Page number (1-indexed)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Items per page (1-100)
\n","type":"text/plain"},"key":"per_page","value":"50"}],"variable":[{"id":"4c60550f-15bf-45f5-8868-b0b32fcd2cc9","description":{"content":"Organization identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"organization_id"}]}},"response":[{"id":"be0e0439-2fcd-4c3d-a1b4-2cb9903f8e2b","name":"List of rooms","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerGet all users in an organization (organization admin only).
\nResponse includes:
\nUseful for user management and reporting.
\n","urlObject":{"path":["api","organizations",":id","users"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"a85fc90d-7d94-469a-9856-c3fab9eca82a","description":{"content":"Organization identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"630e3894-8e6b-4a7a-8f61-737f20cdfa26","name":"List of users","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerThis endpoint retrieves detailed information about an organization invitation using a unique invite token. It allows users to view the details of an invitation before accepting or declining it.
\nThe primary purpose of this endpoint is to validate and fetch organization invite details when a user receives an invitation link. This is typically used in the invitation acceptance flow to display relevant information about the organization and the invitation itself.
\nThe token is a unique identifier generated when an organization invitation is created
\nTokens are typically long alphanumeric strings (e.g., a2f83aa02c5c4491aa3fa3dc4212e919)
Each token corresponds to a specific invitation and can only be used to retrieve that particular invite's details
\nThe response returns comprehensive information about the organization invitation, which may include:
\nOrganization details (name, ID, type)
\nInviter information (who sent the invitation)
\nInvitee details (email address, role being offered)
\nInvitation status (pending, completed or deleted)
\nInvitation metadata (creation date, expiration date)
\nWhen a user clicks on an organization invitation link from their email, this endpoint is called to:
\nValidate that the invitation token is valid
\nDisplay organization information to the user
\nPresent accept/decline options
\nBefore allowing a user to accept an invitation, the application can:
\nVerify the token hasn't expired
\nCheck if the invitation is still pending
\nEnsure the invitation hasn't been revoked
\nUsers can check the current status of an invitation using the token.
\n","urlObject":{"path":["api","organizations","invite"],"host":["http://localhost:4000/"],"query":[{"key":"token","value":"a2f83aa02c5c4491aa3fa3dc4212e919"}],"variable":[]}},"response":[],"_postman_id":"8174fd46-c94c-4120-a4e1-83fb3e0b8d6f"},{"name":"Invite users","id":"913ceb51-cd04-487a-a223-4bb493d68fb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"emails\": [\"user-to-invite@example.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4000//api/organizations/:id/users","description":"This endpoint allows you to invite one or more users to join a specific organization. The invited users will receive an invitation to access the organization based on the provided email addresses.
\nThe request body must be a JSON object with the following structure:
\n{\n \"emails\": [\"user1@example.com\", \"user2@example.com\"]\n}\n\nAuthentication is required to access this endpoint
\nThe authenticated user must be an organization administrator
\nMultiple email addresses can be invited in a single request by including them in the emails array
Invalid email formats may result in an error response
\nIf the organization ID does not exist or the user lacks permissions, the request will fail with an appropriate error code
\nThis endpoint removes one or more users from an organization. It allows administrators to revoke user access by providing a list of email addresses to be removed from the specified organization.
\nExample: /api/organizations/2/users
Example: ?force=true
The request body must be a JSON object containing an array of user email addresses to remove.
\n{\n \"emails\": [\n \"user1@example.com\",\n \"user2@example.com\"\n ]\n}\n\nRequired Permission: Organization administrator
\nAuthentication: Valid authentication token must be provided
\nUser Validation: All email addresses in the request must not exists in Prodeal
\nReturns detailed information about a single user within an organization.\nThe requesting user must have an org_admin or support organization role\nand must belong to the same organization.
organization_id (required): The ID of the organization.user_id (required): The ID of the user to retrieve.Returns the user's profile information including name, email, contact details,\norganization role, MFA settings, divisions, and organization membership.
\n401 — Authentication required403 — Requesting user is not an org admin / support, or does not belong to the organization404 — Target user not found or belongs to a different organizationThe ID of the organization the user belongs to
\n","type":"text/plain"},"type":"any","value":"6927","key":"organization_id"},{"description":{"content":"The ID of the user to retrieve
\n","type":"text/plain"},"type":"any","value":"6927","key":"user_id"}]}},"response":[{"id":"3850d6e4-942b-4b85-a62f-2bc6e4782f91","name":"User details returned successfully","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/v260323/organizations/:organization_id/users/:user_id","host":["{{baseUrl}}"],"path":["api","v260323","organizations",":organization_id","users",":user_id"],"variable":[{"key":"organization_id","value":"6927","description":"The ID of the organization the user belongs to"},{"key":"user_id","value":"6927","description":"The ID of the user to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 42,\n \"calendarIdentifier\": \"abc123\",\n \"contactDetails\": [\n {\n \"id\": \"1\",\n \"label\": \"Mobile\",\n \"number\": \"+1234567890\"\n }\n ],\n \"email\": \"jane.doe@example.com\",\n \"emails\": [\n \"jane.doe@example.com\"\n ],\n \"firstName\": \"Jane\",\n \"fullName\": \"Jane Doe\",\n \"insertedAt\": \"2024-01-15T10:30:00\",\n \"isCertified\": false,\n \"isGuestAccessApprover\": false,\n \"isOrgAdmin\": true,\n \"organizationRole\": \"org_admin\",\n \"jobTitle\": \"VP of Finance\",\n \"lastName\": \"Doe\",\n \"lastSeenUtc\": null,\n \"location\": null,\n \"membershipStatus\": \"active\",\n \"mfaType\": null,\n \"newChecklistEnabled\": true,\n \"timezone\": \"America/New_York\",\n \"acceptProductUpdates\": true,\n \"publicEmail\": false,\n \"inAppMarketingEnabled\": true,\n \"organization\": {\n \"id\": 1,\n \"name\": \"Acme Corp\"\n },\n \"divisions\": [\n {\n \"id\": 10,\n \"name\": \"M&A Advisory\"\n }\n ]\n}"},{"id":"526e6338-ad32-4e16-a66a-c37b135a008b","name":"Unauthorized — missing or invalid authentication","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/v260323/organizations/:organization_id/users/:user_id","host":["{{baseUrl}}"],"path":["api","v260323","organizations",":organization_id","users",":user_id"],"variable":[{"key":"organization_id","value":"6927","description":"The ID of the organization the user belongs to"},{"key":"user_id","value":"6927","description":"The ID of the user to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"fda8dbae-5cee-486a-874a-5c05fce0d7c2","name":"Forbidden — user is not an org_admin or support user, or does not belong to the requested organization","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/v260323/organizations/:organization_id/users/:user_id","host":["{{baseUrl}}"],"path":["api","v260323","organizations",":organization_id","users",":user_id"],"variable":[{"key":"organization_id","value":"6927","description":"The ID of the organization the user belongs to"},{"key":"user_id","value":"6927","description":"The ID of the user to retrieve"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"forbidden\",\n \"message\": \"User is not an organization admin or a support user.\"\n}"},{"id":"52c85370-b962-4b35-b4a3-812000014abc","name":"User not found or does not belong to the organization","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/v260323/organizations/:organization_id/users/:user_id","host":["{{baseUrl}}"],"path":["api","v260323","organizations",":organization_id","users",":user_id"],"variable":[{"key":"organization_id","value":"6927","description":"The ID of the organization the user belongs to"},{"key":"user_id","value":"6927","description":"The ID of the user to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"not_found\",\n \"message\": \"Couldn't find the given user.\"\n}"}],"_postman_id":"58259efb-1f01-413b-984b-580ebc0b242e"}],"id":"56f80718-0901-4e26-8d1f-515bce90b4ee","_postman_id":"56f80718-0901-4e26-8d1f-515bce90b4ee","description":""},{"name":"Divisions","item":[{"name":"List divisions","id":"b2c99d90-24a5-47ad-a878-ee42a7be0b4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:4000//api/organizations/:id/divisions","description":"Get list of divisions in an organization that the current user has access to.
\nImportant Notes:
\nDivisions:\nDivisions provide organizational hierarchy and are used to organize rooms and users within\nan organization. Users can be assigned to one or more divisions, and rooms can be\nassociated with divisions for better organization and access control.
\nAccess Control:
\nid parameterOrganization identifier. Must match the organization the authenticated user belongs to.
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"5d5bdb78-9d94-459b-8a45-1e67a649151f","name":"List of divisions successfully retrieved","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/organizations/:id/divisions","host":["{{baseUrl}}"],"path":["api","organizations",":id","divisions"],"variable":[{"key":"id","value":"3005","description":"Organization identifier. Must match the organization the authenticated user belongs to."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 4611,\n \"name\": \"Commercial Real Estate\"\n },\n {\n \"id\": 5366,\n \"name\": \"Residential Real Estate\"\n },\n {\n \"id\": 7890,\n \"name\": \"Aviation Division\"\n }\n]"},{"id":"cb36a881-9340-4f66-a433-b22bf9ed6f8c","name":"Authentication required or invalid credentials","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/organizations/:id/divisions","host":["{{baseUrl}}"],"path":["api","organizations",":id","divisions"],"variable":[{"key":"id","value":"3005","description":"Organization identifier. Must match the organization the authenticated user belongs to."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"unauthorized\",\n \"message\": \"Authentication required\"\n}"},{"id":"a6aa4fda-07ad-4876-ac1e-69c64eeeae78","name":"User is not a member of the specified organization or lacks permission to read divisions","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/organizations/:id/divisions","host":["{{baseUrl}}"],"path":["api","organizations",":id","divisions"],"variable":[{"key":"id","value":"3005","description":"Organization identifier. Must match the organization the authenticated user belongs to."}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"user_cant_read_divisions\",\n \"message\": \"User can't read divisions for the given organization.\"\n}"}],"_postman_id":"b2c99d90-24a5-47ad-a878-ee42a7be0b4b"}],"id":"84da13c6-66ff-4840-bb6f-c87e8bc2115c","_postman_id":"84da13c6-66ff-4840-bb6f-c87e8bc2115c","description":""},{"name":"Activity Report","item":[{"name":"Get activity report","id":"31e2ffc7-818c-46b3-bf33-6bf6cd99e1fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"http://localhost:4000//api/organizations/:id/activity-report?start_date=2023-01-01&end_date=2023-12-31","description":"Retrieve detailed activity report for an organization.
\nReport includes:
\nFiltering:
\nstart_date and end_date to limit time rangeUseful for compliance, auditing, and usage analytics.
\n","urlObject":{"path":["api","organizations",":id","activity-report"],"host":["http://localhost:4000/"],"query":[{"description":{"content":"Report start date (ISO 8601)
\n","type":"text/plain"},"key":"start_date","value":"2023-01-01"},{"description":{"content":"Report end date (ISO 8601)
\n","type":"text/plain"},"key":"end_date","value":"2023-12-31"}],"variable":[{"id":"1cfb7dcf-bdf9-4bc8-92b2-eedbbb58d489","description":{"content":"Organization identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"c038d4e3-6d22-4bd0-a2b5-57f172f9196e","name":"Activity report data","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerExport organization activity report to CSV or XLSX format.
\nExport includes:
\nReturns file directly as download (not async job).
\n","urlObject":{"path":["api","organizations",":id","activity-report","export"],"host":["http://localhost:4000/"],"query":[{"description":{"content":"Export file format
\n","type":"text/plain"},"key":"format","value":"xlsx"},{"description":{"content":"Report start date
\n","type":"text/plain"},"key":"start_date","value":"1974-04-17"},{"description":{"content":"Report end date
\n","type":"text/plain"},"key":"end_date","value":"1974-04-17"}],"variable":[{"id":"0ebeb281-f192-46f1-940e-c41e17d16ed8","description":{"content":"Organization identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"7b95773b-6f4c-4a6e-a53d-36e951c4f283","name":"Exported report file","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"text/csv"},{"key":"Authorization","value":"BearerGet all rooms in a specific division.
\nPermissions:
\nResults are paginated.
\n","urlObject":{"path":["api","divisions",":id","rooms"],"host":["http://localhost:4000/"],"query":[{"description":{"content":"Page number (1-indexed)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Items per page (1-100)
\n","type":"text/plain"},"key":"per_page","value":"50"}],"variable":[{"id":"927dbbf6-1f14-4a6b-b5c4-b38b0d6c8348","description":{"content":"Division identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"60aa0b2a-e4a6-4158-af57-abd3e935ccfd","name":"List of rooms in division","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerGet all users in a specific division with their roles.
\nResponse includes:
\nDivision identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"9e1e8626-9c13-431b-b518-0bef8abd7f42","name":"List of division users","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerAdd a user to a division with specified role.
\nPermissions:
\nAvailable roles:
\nadmin: Division administratormember: Regular division memberDivision identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"c5cfe628-16a6-44aa-83ea-c4d9d7fe7c35","name":"User added to division successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerBulk update or replace division users and their roles.
\nUse cases:
\nRequires division admin or organization admin permissions.
\n","urlObject":{"path":["api","divisions",":id","users"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"f7d9aae8-6ad1-427a-b41c-48f4b1f08804","description":{"content":"Division identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"3e834966-bf9a-4b9d-8103-fd0a282f3f94","name":"Division users updated successfully","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerRemove a user from a division.
\nImportant:
\nRequires division admin or organization admin permissions.
\n","urlObject":{"path":["api","divisions",":division_id","users",":user_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"925a806e-c234-4dfb-a519-edd2dfc1ce95","description":{"content":"Division identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"division_id"},{"id":"77ab6dfc-7f8a-450f-8749-1f68f7126937","description":{"content":"User identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"user_id"}]}},"response":[{"id":"404757b2-18d6-408f-b0f4-ec5ff70bf78a","name":"User removed from division successfully","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BearerGet column preferences configured for a specific team.
\nTeam column preferences override room defaults for team members.\nUseful for customizing views per team role.
\n","urlObject":{"path":["api","teams",":id","columns"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"2fac4af5-1917-44a9-8133-b1bf1d462597","description":{"content":"Team identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"3ced6207-3e9b-45fb-b914-14d740a7b05b","name":"Team column preferences","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerUpdate column preferences for a team.
\nPermissions:
\nUse to standardize column views for specific team roles.
\n","urlObject":{"path":["api","teams",":id","columns"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"4e133746-6e96-48db-8526-0a4604d7475a","description":{"content":"Team identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"8a3671f3-a32f-48de-aa09-a9c2d98b1958","name":"Team columns updated successfully","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerGet list of teams accessible to the current user.
\nTeams are room-specific and control access and permissions\nwithin rooms. Users can be members of multiple teams.
\n","urlObject":{"path":["api","teams"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"4095263b-684e-416d-90c0-5bcd05b823f5","name":"List of teams","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerRetrieve all metadata key-value pairs for the current user.
\nMetadata provides flexible storage for user-specific settings,\npreferences, and application state.
\n","urlObject":{"path":["api","users","me","metadata"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"2287780e-563e-444e-8ed9-2702abd2807d","name":"User metadata","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerRetrieve a specific metadata value by key
\n","urlObject":{"path":["api","users","me","metadata",":key"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"31ef275f-20c7-433c-9748-56ee84c7a689","description":{"content":"Metadata key
\n","type":"text/plain"},"type":"any","value":"string","key":"key"}]}},"response":[{"id":"f8ea3537-5ee8-4a69-ac0c-77c7e4885288","name":"Metadata value","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerSet or update a metadata key-value pair.
\nCreates the key if it doesn't exist, updates if it does.\nUseful for storing user preferences and application state.
\n","urlObject":{"path":["api","users","me","metadata",":key"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"115a20bd-0781-4f95-a2d2-99214e7c4f88","description":{"content":"Metadata key
\n","type":"text/plain"},"type":"any","value":"string","key":"key"}]}},"response":[{"id":"8674d3de-273b-4e2f-9501-fa379042648b","name":"Metadata updated successfully","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerRemove a metadata key-value pair
\n","urlObject":{"path":["api","users","me","metadata",":key"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"ec06822b-2007-469e-a057-d00f54cb5449","description":{"content":"Metadata key
\n","type":"text/plain"},"type":"any","value":"string","key":"key"}]}},"response":[{"id":"bfb27a52-ebf1-4e0e-b63a-fd20b2446620","name":"Metadata deleted successfully","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BearerGet list of users in the current organization.
\nReturns basic user information visible to the current user\nbased on organizational permissions.
\n","urlObject":{"path":["api","users"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"4cef20ac-2ecb-4a3c-ba9d-b85ce844f5d1","name":"List of users","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerUpdate user profile information.
\nPermissions:
\nUpdatable fields:
\nUser identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"e2274d17-c65b-48ba-9324-497e436b26fd","name":"User updated successfully","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerFull-text search across all accessible content in the platform. Results are scoped to the authenticated user's team memberships and division access.
\nSearch scope:
\nRelevance scoring:\nResults are boosted by type: rooms (9x), templates (7x), documents (5x), notes (3x), items (1x). Within rooms, exact wildcard matches on name receive an additional boost.
\nFiltering:
\ntype — restrict which Elasticsearch indices are searched (comma-separated)room_id — restrict results to one or more rooms (comma-separated)updated_at_min / updated_at_max — date range filter on updated_at (ISO 8601)Pagination:
\npage and per_page query parameterstotal, page-number, per-page, total-pages, linkResponse:\nReturns a flat JSON array of search result objects. Each object includes a result_type field indicating the source index. The remaining fields vary by result type — see the response schema for details.
Full-text search query. Searched across names, room/item/document detail fields, file attachment content, and note messages. Supports simple query string syntax (AND/OR operators).
\n","type":"text/plain"},"key":"q","value":"contract"}],"variable":[]}},"response":[{"id":"23707202-4c00-4892-aaa2-42280d712556","name":"Search results","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/api/search?q=contract&type=documents,notes&room_id=42&updated_at_min=2025-01-01&updated_at_max=2025-12-31&page=1&per_page=25","host":["{{baseUrl}}"],"path":["api","search"],"query":[{"description":"Full-text search query. Searched across names, room/item/document detail fields, file attachment content, and note messages. Supports simple query string syntax (AND/OR operators).","key":"q","value":"contract"},{"description":"Elasticsearch index name(s) to restrict the search to. When omitted all indices are searched. Comma-separated for multiple values.","key":"type","value":"documents,notes"},{"description":"Filter results to a specific room. Accepts a single room ID or comma-separated IDs.","key":"room_id","value":"42"},{"description":"Filter results updated on or after this date (ISO 8601 format, e.g. 2025-01-01).","key":"updated_at_min","value":"2025-01-01"},{"description":"Filter results updated on or before this date (ISO 8601 format, e.g. 2025-12-31).","key":"updated_at_max","value":"2025-12-31"},{"description":"Page number for pagination (1-indexed). Defaults to 1.","key":"page","value":"1"},{"description":"Number of results per page. Defaults to 50. Minimum 1, maximum 100.","key":"per_page","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Total number of matching results across all pages","type":"text/plain"},"key":"total","value":"128"},{"disabled":false,"description":{"content":"Current page number","type":"text/plain"},"key":"page-number","value":"1"},{"disabled":false,"description":{"content":"Number of results per page","type":"text/plain"},"key":"per-page","value":"50"},{"disabled":false,"description":{"content":"Total number of pages","type":"text/plain"},"key":"total-pages","value":"3"},{"disabled":false,"description":{"content":"RFC 5988 link header with pagination URLs (first, last, prev, next)","type":"text/plain"},"key":"link","value":"Get all subscriptions for the current user.
\nSubscriptions include:
\nEvent type
\nTarget URL
\nActive status
\nSigning secret (if configured)
\nSubscription metadata
\nCreate a subscription to receive notifications when a given event occurs.
\ndocument_upload: Document uploaded
document_update: Document updated
document_delete: Document deleted
folder_create: Folder created
folder_update: Folder updated
folder_delete: Folder deleted
bulk_action_copy_items: Items copied between rooms
bulk_action_move_items: Items moved between rooms
roomIds: Filter by room IDs (e.g., roomIds=1,2,3)
attributes: Filter by changed attributes, only for update events (e.g., attributes=status,name)
sourceRoomIds / targetRoomIds: Filter bulk actions by source/target room
POST request to targetUrl
JSON body with event data
\nYour endpoint must return 2xx status code.
\n","urlObject":{"path":["api","resthooks","subscriptions"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"80222b05-3f57-482e-af07-47d57369f943","name":"Subscription created successfully","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerRetrieve details of a given subscription.
\n","urlObject":{"path":["api","resthooks","subscriptions",":id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"84a4992a-bdeb-45d6-843c-4ef7b93d88e6","description":{"content":"Subscription identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"3c1e88af-bd98-4acc-953f-97f30fffb021","name":"Subscription details","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerUpdate subscription settings.
\nSubscription identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"b2bae001-e1e4-4c9a-9772-3bddd214d418","name":"Subscription updated successfully","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerUnsubscribe from webhook events.
\nPermanently removes the subscription. No further events will\nbe sent to the target URL.
\n","urlObject":{"path":["api","resthooks","subscriptions",":id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"39057280-c89d-48c3-826e-087013245fd8","description":{"content":"Subscription identifier
\n","type":"text/plain"},"type":"any","value":"3005","key":"id"}]}},"response":[{"id":"8d88fb3e-7b08-4b76-9409-22779a1a1a51","name":"Subscription deleted successfully","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"BearerREST Hooks allow your application to receive real-time data updates (via HTTP POST) when specific events occur, rather than constantly polling for changes.
\nSubscriptions are associated with the user who created them, and events are only sent based on that user's permissions.
\nAvailable events:
\ndocument_upload - Document uploaded
document_update - Document updated
document_delete - Document deleted
folder_create - Folder created
folder_update - Folder updated
folder_delete - Folder deleted
bulk_action_copy_items - Items copied between rooms
bulk_action_move_items - Items moved between rooms
Filters:
\nroomIds - Filter events by room IDs
attributes - Filter update events by changed attributes
sourceRoomIds / targetRoomIds - Filter bulk actions by source/target room
Examples: To receive notifications for all document uploads in room with ID 10, create a subscription with event=document_upload and filter=roomIds=10. To receive notifications when a document's status or name changes, use event=document_update and filter=attributes=status,name.
If you want Prodeal to sign the webhook requests so your server can verify their authenticity, provide a signingSecret when creating or updating a subscription.
When a signing secret is configured, every webhook request will include an X-Signature HTTP header containing the HMAC-SHA256 hex digest of the request body.
To verify the signature on your server, compute the HMAC-SHA256 of the raw request body using your signing secret and compare it with the X-Signature header value.
Example verification (Python):
\nimport hashlib\nimport hmac\n\ndef verify_signature(body: bytes, secret: str, signature: str) -> bool:\n expected = hmac.new(\n secret.encode('utf-8'),\n body,\n hashlib.sha256\n ).hexdigest()\n return hmac.compare_digest(expected, signature)\nRetrieve file request information by token.
\nPublic endpoint - no authentication required.\nUsed to display file request form to external users.
\nResponse includes:
\nFile request token (from invitation link)
\n","type":"text/plain"},"type":"any","value":"string","key":"token"}]}},"response":[{"id":"faab2665-75d3-407d-bdb7-17dd8b0aa0c0","name":"File request details","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerGet a presigned URL for uploading files directly to storage.
\nUsage:
\nfile_id when creating itemNo authentication required - works for public file requests.
\n","urlObject":{"path":["api","file-requests","presigned-upload-url"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"84f76fd7-d1f2-4aef-a4bd-cf6966fcf8e7","name":"Presigned upload URL","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"BearerOnly accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"test@acme.com\",\n \"password\": \"q1w2e3r4Q!W@E#R$\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session","description":"When a new session is created, the return code is 201, and the value of the state attribute is \"success\".
When the user has MFA enabled, the return code is 200 and the value of the state attribute is \"mfa_required\". To authenticate, you need to perform another request - Validate OTP code.
Code 422 is returned when invalid credentials are entered.
User and organization objects are included in the response.
\n","urlObject":{"path":["api","v2","session"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"c813cc81-57c4-4231-8935-744d8f14c67a","name":"MFA required response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"jdoe@example.com\",\n \"password\": \"mfa required\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"content-length","key":"content-length","value":"131","description":"The length of the response body in octets (8-bit bytes)"},{"name":"content-type","key":"content-type","value":"application/vnd.api+json; charset=utf-8","description":"The mime type of this content"}],"cookie":[{"expires":"Thu Jun 04 2020 15:25:03 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"GA1.1.1691954976.1528210849","key":"_ga"},{"expires":"Mon Aug 12 2019 14:10:57 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"d0795498-c8e7-461f-ac9a-32cf2175ee13","key":"intercom-id-d0rwjug4"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"libraryContent%3Dbrowse%26advImgDetails%3Dhide%26hidetb%3D0","key":"wp-settings-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":true,"value":"WP+Cookie+check","key":"wordpress_test_cookie"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"1537052594","key":"wp-settings-time-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"258321d5693b72c21c1822711d7e611e","key":"phpMyAdmin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"%7B%22iv%22%3A%22oDZwYNwjWbHtCIMVF4HYWw%3D%3D%22%2C%22mac%22%3A%22f7dc03bdc2e058c862e8c4902bee107dcb492188%22%2C%22payload%22%3A%22F32XqdxcuphocRuxKdNhsl2Tx8cpSQQc15v2VNdlslg%3D%22%7D","key":"pmaAuth-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"luis%40prodeal360.com","key":"last_email_loggedin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"SFMyNTY.g3QAAAACbQAAAAdhdXRoX2lkYQRtAAAAB3VzZXJfaWRhAQ.LwfLEUKK8YgG5yZe4Hphbfo204iJarVeCUOCWvQkivE","key":"_prodeal360_key"}],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"data\": {\n \"type\": \"session\",\n \"id\": \"1\",\n \"attributes\": {\n \"state\": \"mfa_required\",\n \"email\": \"jdoe@example.com\"\n }\n }\n}"},{"id":"d967ea4c-c255-4286-a418-ef29e9c391db","name":"Authentication failure","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"jdoe@example.com\",\n \"password\": \"wrong password\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"169"},{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"errors\": [\n {\n \"title\": \"invalid credentials\",\n \"status\": \"422\",\n \"source\": {\n \"pointer\": \"data/attributes/email\"\n },\n \"detail\": \"Email invalid credentials\"\n }\n ]\n}"},{"id":"62993582-f8e7-4022-8061-a96df1038f08","name":"Authentication successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"jdoe@example.com\",\n \"password\": \"password\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"684"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"organization\",\n \"id\": \"1\",\n \"attributes\": { \n \"status-merged-enabled\": false,\n \"name\": \"Example Organization\",\n \"mfa-required\": false,\n \"file-counter-enabled\": true,\n \"esignature-annotations-enabled\": false,\n \"domains\": null,\n \"default\": true,\n \"sso-enabled\": false\n }\n },\n {\n \"type\": \"user\",\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"1\"\n }\n }\n },\n \"id\": \"3\",\n \"attributes\": {\n \"workspaces-flag-enabled\": false,\n \"online\": true,\n \"location\": null,\n \"last-name\": \"Doe\",\n \"job-title\": \"Seller\",\n \"is-org-admin\": true,\n \"is-certified\": true,\n \"full-name\": \"John Doe\",\n \"first-name\": \"Doe\",\n \"otp-enabled\": false,\n \"emails\": [\n \"jdoe@example.com\"\n ]\n }\n }\n ],\n \"data\": {\n \"type\": \"session\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"3\"\n }\n }\n },\n \"id\": \"\",\n \"attributes\": {\n \"state\": \"success\",\n \"email\": \"jdoe@example.com\"\n }\n }\n}"}],"_postman_id":"e7ccab41-7841-46ed-9e9a-ea9e973d543d"},{"name":"Delete session (Sign out)","id":"6779c2b4-714e-4f2f-becc-fa2f5597eec6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/session","urlObject":{"path":["api","v2","session"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"d55b80c3-db12-484f-b25b-f4c756985121","name":"Sign out successful","originalRequest":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/session"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6779c2b4-714e-4f2f-becc-fa2f5597eec6"}],"id":"9dc206fe-5547-4802-b082-e0655699d109","event":[{"listen":"prerequest","script":{"id":"cc7e5fbe-922d-4ad8-a6f7-58c492dbfb7f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9bde24e3-2658-4904-b9d8-eff139b779fa","type":"text/javascript","exec":[""]}}],"_postman_id":"9dc206fe-5547-4802-b082-e0655699d109","description":""},{"name":"Multi-Factor Authentication (MFA)","item":[{"name":"Validate MFA OTP code","id":"9ba38e03-b69c-4eb9-8700-8f4bb6344236","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"mfa\",\n \"attributes\": {\n \"otp\": \"123456\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session/mfa","description":"When a new session is created, the return code is 201 and the status is \"success\".
Code 422 is returned when invalid OTP code is entered. If the OTP validation fails, it is necessary to create a new session to try again.
User and organization objects are included in the response.
\n","urlObject":{"path":["api","v2","session","mfa"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"1ecd1f74-ef11-44fc-a732-3fa421850107","name":"MFA Validation successful","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"mfa\",\n \"attributes\": {\n \"otp\": \"123456\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session/mfa"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"name":"content-length","key":"content-length","value":"126","description":"The length of the response body in octets (8-bit bytes)"},{"name":"content-type","key":"content-type","value":"application/vnd.api+json; charset=utf-8","description":"The mime type of this content"}],"cookie":[{"expires":"Thu Jun 04 2020 15:25:03 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"GA1.1.1691954976.1528210849","key":"_ga"},{"expires":"Mon Aug 12 2019 14:10:57 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"d0795498-c8e7-461f-ac9a-32cf2175ee13","key":"intercom-id-d0rwjug4"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"libraryContent%3Dbrowse%26advImgDetails%3Dhide%26hidetb%3D0","key":"wp-settings-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":true,"value":"WP+Cookie+check","key":"wordpress_test_cookie"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"1537052594","key":"wp-settings-time-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"258321d5693b72c21c1822711d7e611e","key":"phpMyAdmin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"%7B%22iv%22%3A%22oDZwYNwjWbHtCIMVF4HYWw%3D%3D%22%2C%22mac%22%3A%22f7dc03bdc2e058c862e8c4902bee107dcb492188%22%2C%22payload%22%3A%22F32XqdxcuphocRuxKdNhsl2Tx8cpSQQc15v2VNdlslg%3D%22%7D","key":"pmaAuth-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"luis%40prodeal360.com","key":"last_email_loggedin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"SFMyNTY.g3QAAAACbQAAAAdhdXRoX2lkYQRtAAAAB3VzZXJfaWRhBA.F98DrJa9Fi3H4iDhNP1RxXtchcyavf4XTYLsiN_wRqs","key":"_prodeal360_key"}],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"organization\",\n \"id\": \"1\",\n \"attributes\": {\n \"status-merged-enabled\": false,\n \"name\": \"Example Organization\",\n \"mfa-required\": false,\n \"file-counter-enabled\": true,\n \"esignature-annotations-enabled\": false,\n \"domains\": null,\n \"default\": true,\n \"sso-enabled\": false\n }\n },\n {\n \"type\": \"user\",\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"1\"\n }\n }\n },\n \"id\": \"3\",\n \"attributes\": {\n \"workspaces-flag-enabled\": false,\n \"online\": true,\n \"location\": null,\n \"last-name\": \"Doe\",\n \"job-title\": \"Seller\",\n \"is-org-admin\": true,\n \"is-certified\": true,\n \"full-name\": \"John Doe\",\n \"first-name\": \"Doe\",\n \"otp-enabled\": true,\n \"emails\": [\n \"user@prodeal360.com\"\n ]\n }\n }\n ],\n \"data\": {\n \"type\": \"session\",\n \"id\": \"\",\n \"attributes\": {\n \"state\": \"success\",\n \"email\": \"user@prodeal360.com\"\n }\n }\n}"},{"id":"6b0cb511-81f7-4fbd-9442-4f5073b12d31","name":"MFA Validation failed","originalRequest":{"method":"GET","header":[]},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"name":"content-length","key":"content-length","value":"169","description":"The length of the response body in octets (8-bit bytes)"},{"name":"content-type","key":"content-type","value":"application/json; charset=utf-8","description":"The mime type of this content"}],"cookie":[{"expires":"Thu Jun 04 2020 15:25:03 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"GA1.1.1691954976.1528210849","key":"_ga"},{"expires":"Mon Aug 12 2019 14:10:57 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"d0795498-c8e7-461f-ac9a-32cf2175ee13","key":"intercom-id-d0rwjug4"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"libraryContent%3Dbrowse%26advImgDetails%3Dhide%26hidetb%3D0","key":"wp-settings-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":true,"value":"WP+Cookie+check","key":"wordpress_test_cookie"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"1537052594","key":"wp-settings-time-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"258321d5693b72c21c1822711d7e611e","key":"phpMyAdmin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"%7B%22iv%22%3A%22oDZwYNwjWbHtCIMVF4HYWw%3D%3D%22%2C%22mac%22%3A%22f7dc03bdc2e058c862e8c4902bee107dcb492188%22%2C%22payload%22%3A%22F32XqdxcuphocRuxKdNhsl2Tx8cpSQQc15v2VNdlslg%3D%22%7D","key":"pmaAuth-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"luis%40prodeal360.com","key":"last_email_loggedin"}],"responseTime":null,"body":"{\n \"jsonapi\": {\"version\":\"2.0\"},\n \"errors\":[\n {\n \"title\":\"Invalid credentials\",\n \"status\":\"422\",\n \"source\": {\n \"pointer\":\"data/attributes/email\"\n },\n \"detail\":\"Email Invalid credentials\"\n }\n ]\n}"}],"_postman_id":"9ba38e03-b69c-4eb9-8700-8f4bb6344236"},{"name":"Start MFA enrollment","id":"8bc827f8-dd1e-4beb-9dfa-22bd4ed4c52c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"otp-auth\"\n }\n}"},"url":"http://localhost:4000//api/v2/me/mfa/otp-auth","description":"Used to activate MFA for the current account. The flow of enabling MFA consists of 2 steps - starting and confirming the enrollment.
\nThe most important attributes are secret, uri and qrcode - all of them used for configuring the account in the authenticator app (manually, by using app link, or by scanning QR code).
Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"mfa-enrollment\",\n \"attributes\": {\n \"code\": \"123456\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/me/mfa","description":"The second step for setting up the MFA - confirming with the OTP code.
\nCode 204 is returned on success.
Code 422 is returned when invalid OTP code is entered.
Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/me/mfa","description":"Used to turn off the MFA for the current account. On success, returns status code 204.
MFA increases the security by asking users to provide a unique time-based PIN (OTP code) every time they want to sign in. Users that have MFA enabled, have one extra step during sign in - validating the OTP code.
\n","_postman_id":"79976cad-275a-40ee-9d1f-115517bdb99b"},{"name":"Single Sign-On (SSO)","item":[{"name":"Get SSO login URL","id":"96e76eae-6427-4b7e-bdcb-2c36ee9fc552","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"user@prodeal360.com\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session/sso_url","description":"Returns the URL that opens the SSO page.
\n","urlObject":{"path":["api","v2","session","sso_url"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"637611e2-7c4a-461a-aee0-5286976611cc","name":"Get SSO URL Success","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"user@prodeal360.com\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session/sso_url"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"data\": {\n \"type\": \"sso\",\n \"id\": \"\",\n \"attributes\": {\n \"url\": \"http://localhost:4000/sso/example\"\n }\n }\n}"}],"_postman_id":"96e76eae-6427-4b7e-bdcb-2c36ee9fc552"},{"name":"Get SSO login URL via email","id":"dfb638d9-4427-4f8e-b0ef-f3a06d539235","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"user@prodeal360.com\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session/send_sso_url","description":"Similar to the request above, except this one does not contain SSO URL in the response. It is used to send the email to the given email address, that will contain the SSO URL.
\n","urlObject":{"path":["api","v2","session","send_sso_url"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"68713921-6020-434d-a3bd-db3113f685e2","name":"Email with SSO login URL sent","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"user@prodeal360.com\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session/send_sso_url"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"dfb638d9-4427-4f8e-b0ef-f3a06d539235"}],"id":"dfc16fcc-093a-494f-aec2-0f0b5ca7e7aa","description":"Some organizations use a single sign-on. For them, the authentication process is different, since they use their own authentication provider.
\n","event":[{"listen":"prerequest","script":{"id":"a73a215c-e5e0-43d2-aedd-11b763a479dd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6d282278-7431-41f8-8f89-9cbde29d1762","type":"text/javascript","exec":[""]}}],"_postman_id":"dfc16fcc-093a-494f-aec2-0f0b5ca7e7aa"},{"name":"Update Password","item":[{"name":"Request password reset link","id":"2dae073d-c275-4ce4-b949-eb1e8de43aa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"user@prodeal360.com\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session/password/reset-request","description":"Used for sending the \"reset password link\" via email. The link contains token, that is necessary for the second step of the resetting password.
\nOn success, returns status code 204.
Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"user@prodeal360.com\",\n \"confirmation-code\": \"token\",\n \"password\": \"new password\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session/password/reset-confirm","description":"Used for setting up a new password in the reset password flow. After resetting the password, the user either stays logged in, or OTP code verification is required.
\nUser and organization objects are included in the response.
\n","urlObject":{"path":["api","v2","session","password","reset-confirm"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"86bd1740-5eba-4ab4-b0df-877a32478a25","name":"Invalid password reset token or weak password","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"user@prodeal360.com\",\n \"confirmation-code\": \"token\",\n \"password\": \"new password\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session/password/reset-confirm"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"errors\": [\n {\n \"title\": \"403 Forbidden\",\n \"status\": \"403\",\n \"source\": {\n \"pointer\": null\n },\n \"detail\": \"You are not authorized to perform this action\",\n \"code\": \"FORBIDDEN\"\n }\n ]\n}"},{"id":"941a0b7b-b84c-41b8-86ce-94ba827c1c65","name":"Password reset confirmation success","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"user@prodeal360.com\",\n \"confirmation-code\": \"...\",\n \"password\": \"NewPassw0rd!\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/session/password/reset-confirm"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"620"},{"key":"set-cookie","value":"_prodeal360=SFMyNTY.g3QAAAAFbQAAAAxhY2Nlc3NfdG9rZW5kAANuaWxtAAAACmV4cGlyZXNfaW5kAANuaWxtAAAADHJlZGlyZWN0X3VybGQAA25pbG0AAAANcmVmcmVzaF90b2tlbmQAA25pbG0AAAAHdXNlcl9pZGEB.Wxs7IuqyfeirqIoDIuKnjTqddaY6LX1Iwf_4KCFjvrY; path=/; HttpOnly"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"included\": [\n {\n \"type\": \"user\",\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"2\"\n }\n }\n },\n \"id\": \"1\",\n \"attributes\": {\n \"otp-enabled\": false,\n \"workspaces-flag-enabled\": false,\n \"job-title\": \"User at ProDeal360\",\n \"is-org-admin\": true,\n \"is-certified\": true,\n \"full-name\": \"John Doe\",\n \"emails\": [\n \"user@prodeal360.com\"\n ],\n \"contact-details\": null\n }\n },\n {\n \"type\": \"organization\",\n \"id\": \"2\",\n \"attributes\": {\n \"name\": \"RandomCoolName Company (OH)\",\n \"default\": false\n }\n }\n ],\n \"data\": {\n \"type\": \"session\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"1\"\n }\n }\n },\n \"id\": \"\",\n \"attributes\": {\n \"state\": \"success\",\n \"email\": \"user@prodeal360.com\"\n }\n }\n}"}],"_postman_id":"76a80279-f12d-46b9-8b74-2fb0ff93a7e6"},{"name":"Update user password","id":"609d354d-6765-4623-a30d-6d4fa9970ccb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"user-password\",\n \"attributes\":{ \n \"current-password\":\"Passw0rd!\",\n \"password\":\"weak password!\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/me/password","description":"Change the user password for the currently signed-in user.
\nOn error, status code 422 is returned. In addition, the error code parameter is used to differentiate the following scenarios:
INVALID_FIELD_FORMAT - indicates that the password validation rules were not satisfied (e.g. \"new password does not contain a number\")INVALID_FIELD_INVALID_CURRENT_PASSWORD - indicates that the current password is incorrectIf the user is logged in, the password can be changed using Update user password endpoint. Otherwise, the reset flow is used, which contains 2 steps: request reset link and confirm password reset.
ProDeal uses \"cookie-based\" authentication. Every successful authentication request produces a cookie that can be used to authorize the following requests to the API.
\n","event":[{"listen":"prerequest","script":{"id":"c549f452-7cf3-4592-b3f5-b942da88ebb3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"04fb59a9-d031-4284-81de-8253aface5d2","type":"text/javascript","exec":[""]}}],"_postman_id":"94532189-742c-43dc-9c53-ee785a22c4f9"},{"name":"Users","item":[{"name":"Get organization users","id":"322a92a6-2a25-4d7d-86a4-fc65aaee4f51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/organization/users?page[number]=1&page[size]=25","description":"Get all users from an organization.
\nThe following user attributes will be returned: active, email, full-name, is-guest-approver, is-org-admin, job-title, last-seen, mfa-type, and role.
It's important to note that only organization admins, due to their elevated permissions, can see the list of all users in the organization.
\n","urlObject":{"path":["api","v2","organization","users"],"host":["http://localhost:4000/"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"25"}],"variable":[]}},"response":[{"id":"70b9f976-0000-4d8d-8ea1-abce4796db44","name":"Get organization users success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"url":{"raw":"http://localhost:4000//api/v2/organization/users?page[number]=1&page[size]=25","host":["http://localhost:4000/"],"path":["api","v2","organization","users"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 04 Feb 2020 13:45:21 GMT"},{"key":"content-length","value":"454"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2no3duq1e1ps1p55j4001ks1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": {\n \"self\": \"/api/v2/organization/users?page[number]=1&page[size]=25\"\n },\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"user\",\n \"id\": \"3\",\n \"attributes\": {\n \"active\": true,\n \"email\": \"user1org2@prodeal360.com\",\n \"full-name\": \"Dominique Roberts\",\n \"is-guest-approver\": false,\n \"is-org-admin\": true,\n \"job-title\": \"Manager\",\n \"last-seen\": \"2021-03-01T19:31:12.703091\",\n \"mfa-type\": \"software\",\n \"role\": \"org_admin\"\n }\n }\n ]\n}"}],"_postman_id":"322a92a6-2a25-4d7d-86a4-fc65aaee4f51"},{"name":"Get a user","id":"7e4742ab-0aae-42b4-b6d5-0b9f7dc50863","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n","type":"text"}],"url":"http://localhost:4000//api/v2/users/:user_id","urlObject":{"path":["api","v2","users",":user_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"ff550770-da85-44d2-ae8e-d830b5e4791c","type":"string","value":"me","key":"user_id"}]}},"response":[{"id":"f44b8835-42d6-4c8c-937e-24aca12ac75b","name":"Get a user","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"url":{"raw":"http://localhost:4000//api/v2/users/:user_id","host":["http://localhost:4000/"],"path":["api","v2","users",":user_id"],"variable":[{"id":"ff550770-da85-44d2-ae8e-d830b5e4791c","key":"user_id","value":"me","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 May 2020 16:14:12 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"414"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=/XKiPqKCGJnYh3ynKDhUt/4WysJzIh4Kv9rEURrLXc+Pnnpkj37An+M97+PLlrx+0gWUTpnGqBalkX8wzStE6VTA0Bue9ckk1QWNjt4dt9Dihcc4cWtyET9enbr7; Expires=Thu, 21 May 2020 16:14:12 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=/XKiPqKCGJnYh3ynKDhUt/4WysJzIh4Kv9rEURrLXc+Pnnpkj37An+M97+PLlrx+0gWUTpnGqBalkX8wzStE6VTA0Bue9ckk1QWNjt4dt9Dihcc4cWtyET9enbr7; Expires=Thu, 21 May 2020 16:14:12 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"nginx"},{"key":"content-encoding","value":"gzip"},{"key":"set-cookie","value":"_prodeal360=session_kXnB4tmlksBh+wqbCNVSa/tT+e2soRMhdefRev7zlndde2E/1sthCJ0iJOz9i3GnMpuU6INw9sjq09fC+f1xHoYtGNZ9eZPwCT1Y2skwMtns1heQr3jDtvqBGnvy7EqI; path=/; domain=staging.prodeal.dev; HttpOnly"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2o7f28r7q5f8iod71o004rk1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, private, must-revalidate"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"organization\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Generic Org\",\n \"default\": true\n }\n }\n ],\n \"data\": {\n \"type\": \"user\",\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"1\"\n }\n }\n },\n \"id\": \"7\",\n \"attributes\": {\n \"otp-enabled\": false,\n \"workspaces-flag-enabled\": true,\n \"online\": true,\n \"location\": {\n \"state\": null,\n \"address\": null\n },\n \"last-seen-utc\": \"2020-05-14T16:14:12.879366\",\n \"last-name\": \"Doe\",\n \"job-title\": \"Developer\",\n \"is-org-admin\": false,\n \"is-certified\": true,\n \"ios-intercom-user-hash\": \"E4F6DE493DA1E926CF519F84F7469B63FD2AC753865BA9FC8C735646579F8AEF\",\n \"full-name\": \"John Doe\",\n \"first-name\": \"John\",\n \"emails\": [\n \"user@example.com\"\n ],\n \"contact-details\": []\n }\n }\n}"}],"_postman_id":"7e4742ab-0aae-42b4-b6d5-0b9f7dc50863"},{"name":"Get me (current user)","id":"f3b56e29-414e-4aaf-a8de-b45ae14aab86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n","type":"text"}],"url":"http://localhost:4000//api/v2/users/me","description":"By default, user's organization is included.
\n","urlObject":{"path":["api","v2","users","me"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"74e0fc20-9017-4f03-8256-46c176f98e19","name":"Get me","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"url":"http://localhost:4000//api/v2/users/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"414"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"organization\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Generic Org\",\n \"default\": true\n }\n }\n ],\n \"data\": {\n \"type\": \"user\",\n \"relationships\": {\n \"organization\": {\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"1\"\n }\n }\n },\n \"id\": \"7\",\n \"attributes\": {\n \"otp-enabled\": false,\n \"workspaces-flag-enabled\": true,\n \"online\": true,\n \"location\": {\n \"state\": null,\n \"address\": null\n },\n \"last-seen-utc\": \"2020-05-14T16:14:12.879366\",\n \"last-name\": \"Doe\",\n \"job-title\": \"Developer\",\n \"is-org-admin\": false,\n \"is-certified\": true,\n \"ios-intercom-user-hash\": \"E4F6DE493DA1E926CF519F84F7469B63FD2AC753865BA9FC8C735646579F8AEF\",\n \"full-name\": \"John Doe\",\n \"first-name\": \"John\",\n \"emails\": [\n \"user@example.com\"\n ],\n \"contact-details\": []\n }\n }\n}"}],"_postman_id":"f3b56e29-414e-4aaf-a8de-b45ae14aab86"},{"name":"Create user with invite","id":"ada4d466-ab5f-4b9a-aea4-fa3bb76983c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"job_title\": \"Developer\",\n \n \"token\": \"d7acd6a7fd38414dafb4aaa6e0e2a674\",\n \"terms_of_service_flag\": true,\n \"contact_details\": {\n \"0\": {\n \"label\": \"cell\",\n \"number\": \"1231211\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4000//api/v2/users","description":"Required fields:
\nNote: Phone numbers must contain at least 7 digits.
\n","urlObject":{"path":["api","v2","users"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"58236996-1943-48d2-bd03-bcd28460e871","name":"Create user with invite","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user\",\n \"attributes\": {\n \"first_name\": \"Amadeo\",\n \"last_name\": \"Buric\",\n \"job_title\": \"Developer\",\n \"email\": \"invited.user@prodeal360.com\",\n \"password\": \"P4ssword!\",\n \"password_confirmation\": \"P4ssword!\",\n \"token\": \"1cca6c562ccf498db3134ccff4891205\",\n \"terms_of_service_flag\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4000//api/v2/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Wed, 11 Mar 2020 11:10:53 GMT"},{"key":"content-length","value":"380"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2ntjmsdqnjusiq816s004deb"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"user\",\n \"id\": \"9\",\n \"attributes\": {\n \"workspaces-flag-enabled\": false,\n \"online\": false,\n \"location\": {\n \"state\": null,\n \"address\": null\n },\n \"last-seen-utc\": null,\n \"last-name\": \"Buric\",\n \"job-title\": \"Developer\",\n \"is-org-admin\": null,\n \"is-certified\": null,\n \"full-name\": \"Amadeo Buric\",\n \"first-name\": \"Amadeo\",\n \"emails\": [\n \"invited.user@prodeal360.com\"\n ],\n \"contact-details\": []\n }\n }\n}"}],"_postman_id":"ada4d466-ab5f-4b9a-aea4-fa3bb76983c5"},{"name":"Update a user","id":"9ea48402-02ce-4128-bb42-6e617e4cc008","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":"{ \n\t\"data\": { \n\t\t\"type\":\"user\",\n\t\t\"id\": \"3\",\n\t\t\"attributes\": {\n\t\t\t\"first-name\": \"John\",\n\t\t\t\"last-name\": \"Doe\",\n\t\t\t\"job-title\": \"Seller\",\n\t\t\t\"location\": {\n\t\t\t \"address\": \"234 Main St.\",\n\t\t\t \"state\": \"TX\"\n\t\t\t},\n\t\t\t\"contact-details\": [\n\t\t\t\t{\n \t \"number\": \"123456789\",\n \"label\": \"work\",\n \"id\": 12\n },\n {\n \"number\": \"123456789\",\n \"label\": \"cell\",\n \"id\": 9\n }\n\t\t\t]\n\t }\n }\n}"},"url":"http://localhost:4000//api/v2/users/:user_id","description":"Required fields:
\nNote: Phone numbers must contain at least 7 digits.
\n","urlObject":{"path":["api","v2","users",":user_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"d4011a9e-e1a8-4bd7-8d54-7ac73012856e","type":"string","value":"me","key":"user_id"}]}},"response":[{"id":"31ae0580-6e87-4a1c-bbe8-edd94b0f8a58","name":"Update current user","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{ \n\t\"data\": { \n\t\t\"type\":\"user\",\n\t\t\"id\": \"3\",\n\t\t\"attributes\": {\n\t\t\t\"first-name\": \"John2\",\n\t\t\t\"last-name\": \"Doe2\",\n\t\t\t\"job-title\": \"Tester at Example.com2\",\n\t\t\t\"location\": {\n\t\t\t \"address\": \"Fake Street 123\",\n\t\t\t \"state\": \"TX\"\n\t\t\t},\n\t\t\t\"contact-details\": [\n\t\t\t\t{\n \t \"number\": \"123456789\",\n \"label\": \"work\",\n \"id\": 12\n },\n {\n \"number\": \"123456789\",\n \"label\": \"cell\",\n \"id\": 9\n }\n\t\t\t]\n\t }\n }\n}"},"url":"http://localhost:4000//api/v2/users/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Mon, 03 Jun 2019 13:58:38 GMT"},{"key":"content-length","value":"407"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2mib9safq0fj975v7g0024m1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"data\": {\n \"type\": \"user\",\n \"id\": \"1\",\n \"attributes\": {\n \"otp-enabled\": false,\n \"workspaces-flag-enabled\": false,\n \"first-name\": \"John2\",\n \"last-name\": \"Doe2\",\n \"job-title\": \"Tester at Example.com2\",\n \"is-org-admin\": true,\n \"is-certified\": true,\n \"full-name\": \"John2 Doe2\",\n \"emails\": [\n \"test@example.com\"\n ],\n \"contact-details\": [\n {\n \"number\": \"9298081234\",\n \"label\": \"work\",\n \"id\": \"1\"\n }\n ],\n \"location\": {\n \"state\": \"TX\",\n \"address\": \"Fake Street 123\"\n }\n }\n }\n}"}],"_postman_id":"9ea48402-02ce-4128-bb42-6e617e4cc008"},{"name":"Activate / deactivate multiple users","id":"1c7e3f1a-9287-4020-b75a-7f53a8ae2ecd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"user\",\n \"id\": \"4\",\n \"attributes\": {\n \"active\": false\n }\n }\n ]\n}"},"url":"http://localhost:4000//api/v2/organization/users","description":"Only organization admins can activate/deactivate users.
\n","urlObject":{"path":["api","v2","organization","users"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"a3e5c0cd-aee2-413e-9a4b-1f12cc04ec65","name":"Activate and deactivate multiple usesr","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"user\",\n \"id\": \"4\",\n \"attributes\": {\n \"active\": false\n }\n },\n {\n \"type\": \"user\",\n \"id\": \"3\",\n \"attributes\": {\n \"active\": true\n }\n }\n ]\n}"},"url":"http://localhost:4000//api/v2/organization/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 04 Feb 2020 15:19:38 GMT"},{"key":"content-length","value":"380"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2no3o8222f9btgcbi8007ai1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"user\",\n \"id\": \"3\",\n \"attributes\": {\n \"last-seen\": \"2020-02-04T15:19:38.454595\",\n \"job-title\": \"Manager\",\n \"full-name\": \"Dominique Roberts\",\n \"email\": \"user1org2@prodeal360.com\",\n \"active\": true\n }\n },\n {\n \"type\": \"user\",\n \"id\": \"4\",\n \"attributes\": {\n \"last-seen\": null,\n \"job-title\": \"Assistent\",\n \"full-name\": \"John Simpson\",\n \"email\": \"user2org2@prodeal360.com\",\n \"active\": false\n }\n }\n ]\n}"}],"_postman_id":"1c7e3f1a-9287-4020-b75a-7f53a8ae2ecd"},{"name":"Get calendar","id":"82308878-17f7-4fa7-aa6d-4078039c8eff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:4000//api/v2/users/calendar/16b2288a4","description":"iCalendar feed of the user's due dates.
\n","urlObject":{"path":["api","v2","users","calendar","16b2288a4"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"26c9ddc9-5bed-4e61-b9d1-2bd367c5d298","name":"Get iCalendar feed","originalRequest":{"method":"GET","header":[],"url":"http://localhost:4000//api/v2/users/calendar/16b2288a4"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Thu, 10 Dec 2020 14:10:16 GMT"},{"key":"content-length","value":"464"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"Fk9gP03JnIi2-rsAAOQB"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"content-type","value":"text/calendar; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"BEGIN:VCALENDAR\nCALSCALE:GREGORIAN\nVERSION:2.0\nPRODID:-//Elixir ICalendar//Elixir ICalendar//EN\nBEGIN:VEVENT\nDESCRIPTION:The item lin on room Confidential Room is due. http://localhost:4000/dashboard/2?_target=f_3\nDTSTART:20201231\nSUMMARY:Confidential Room: lin\nEND:VEVENT\nBEGIN:VEVENT\nDESCRIPTION:The item fff on room Confidential Room is due. http://localhost:4000/dashboard/2?_target=f_4\nDTSTART:20210128\nSUMMARY:Confidential Room: fff\nEND:VEVENT\nEND:VCALENDAR\n"}],"_postman_id":"82308878-17f7-4fa7-aa6d-4078039c8eff"}],"id":"5572c7a0-2d81-45ab-9dd1-5f7ae52b533c","description":"Every person that can log in to the system is referred to as a \"User\".
\nUser contains the following attributes:
\nDetails:
\nid - ID (auto-generated, read-only)last-name - Last namefirst-name - First namefull-name - Full name (First name + Last name)job-title - Job titleemails - Array of emailscontact-details - An array of objects representing the phone number. Phone numbers must contain at least 7 digits.\"contact-details\": [\n {\n \"number\": \"12234556\",\n \"label\": \"cell\",\n \"id\": \"55\"\n },\n {\n \"number\": \"12222222\",\n \"label\": \"work\",\n \"id\": \"56\"\n }\n]\nFlags:
\notp-enabled - Whether the user has MFA enabled or notonline - Whether the user is currently online or notlast-seen-utc - When was the user last time onlineis-org-admin - Organization admin have more permissionsis-certified - Certified users can create new roomsworkspaces-flag-enabled - Workspace useractive - Inactive users cannot log inOnly accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/rooms?page[number]=1&page[size]=25&filter[state]=open","description":"Returns the list of all rooms the current user is invited to.
\ntrue or false.\"open\" for active deals\"closed\" for inactive deals\"real_estate_-_acquisition\" for Real Estate - Acquisition\"real_estate_-_refinance\" for Real Estate - Refinance\"real_estate_-_development\" for Real Estate - Development\"real_estate_-_asset_management\" for Real Estate - Asset Management.\"real_estate_-_leasing\" for Real Estate - Leasing\"real_estate_-_syndication\" for Real Estate - Syndication\"real_estate_-_leasehold\" for Real Estate - Leasehold\"real_estate_-_other\" for Real Estate - Other\"energy\" for Energy\"infrastructure\" for Infrastructure\"aviation\" for Aviation\"corporate\" for Corporate\"litigation\" for Litigation\"litigation_financing\" for Litigation Financing\"other\" for Other\"Hospitality\"\"Industrial\"\"Land\"\"Mixed-Use\"\"Multifamily\"\"Office\"\"Retail\"\"Self-Storage\"\"Single Family Home\"\"Specialty Use\"\"Student Housing\"external_id we can use filter[meta_external_id]=123456.Available \"include\" options:
\norganizationcreatorwhitelisted_organizationsparties (teams)workspaceBy default, if nothing is specified, teams are included. However, if the include parameter is added, then only the specified entities are included.
Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/organization/rooms?page[number]=1&page[size]=25","description":"The list of all rooms that belong to the user's organization together with all rooms organization members are invited to.
\ntrue or false.\"open\" for active deals\"closed\" for inactive dealsapi/v2/room-types\"Hospitality\"\"Industrial\"\"Land\"\"Mixed-Use\"\"Multifamily\"\"Office\"\"Retail\"\"Self-Storage\"\"Single Family Home\"\"Specialty Use\"\"Student Housing\"external_id we can use filter[meta_external_id]=123456.Available \"include\" options:
\norganizationcreatorwhitelisted_organizationsparties (teams)workspaceBy default, if nothing is specified, teams are included. However, if the include parameter is added, then only the specified entities are included.
Only Organization admins have permission to use this endpoint.
\n","urlObject":{"path":["api","v2","organization","rooms"],"host":["http://localhost:4000/"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"25"}],"variable":[]}},"response":[{"id":"148bb3fa-1576-450e-9ac4-f85cf6261442","name":"Get organization rooms success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"url":{"raw":"http://localhost:4000//api/v2/organization/rooms?page[number]=1&page[size]=25","host":["http://localhost:4000/"],"path":["api","v2","organization","rooms"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 04 Feb 2020 10:20:55 GMT"},{"key":"content-length","value":"355"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2no2nkquaa40gs4r74001be1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": {\n \"self\": \"/api/v2/organization/rooms?page[number]=1&page[size]=25\"\n },\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"room\",\n \"id\": \"2\",\n \"attributes\": {\n \"state\": \"open\",\n \"name\": \"Confidential Room\",\n \"inserted-at\": \"2020-01-30T10:17:30.250131\"\n }\n },\n {\n \"type\": \"room\",\n \"id\": \"1\",\n \"attributes\": {\n \"state\": \"open\",\n \"name\": \"Open Room\",\n \"inserted-at\": \"2020-01-30T10:17:30.242603\"\n }\n }\n ]\n}"}],"_postman_id":"69893a0f-b4ba-4942-8ded-f2240dd82a4d"},{"name":"Get all related organization rooms","id":"a9920e63-adbc-4ccc-b2eb-1ebc97374fa0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/organization/rooms?page[number]=1&page[size]=25","description":"The list of all rooms that belong to the user's organization together with all rooms organization members are invited to.
\ntrue or false.\"open\" for active deals\"closed\" for inactive dealsapi/v2/room-types\"Hospitality\"\"Industrial\"\"Land\"\"Mixed-Use\"\"Multifamily\"\"Office\"\"Retail\"\"Self-Storage\"\"Single Family Home\"\"Specialty Use\"\"Student Housing\"external_id we can use filter[meta_external_id]=123456.Available \"include\" options:
\norganizationcreatorwhitelisted_organizationsparties (teams)workspaceBy default, if nothing is specified, teams are included. However, if the include parameter is added, then only the specified entities are included.
Only Organization admins have permission to use this endpoint.
\n","urlObject":{"path":["api","v2","organization","rooms"],"host":["http://localhost:4000/"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"25"}],"variable":[]}},"response":[{"id":"963c4a7d-5539-41f0-9b4c-f7fefe84bcf4","name":"Get organization rooms success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"url":{"raw":"http://localhost:4000//api/v2/organization/rooms?page[number]=1&page[size]=25","host":["http://localhost:4000/"],"path":["api","v2","organization","rooms"],"query":[{"key":"page[number]","value":"1"},{"key":"page[size]","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 04 Feb 2020 10:20:55 GMT"},{"key":"content-length","value":"355"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2no2nkquaa40gs4r74001be1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": {\n \"self\": \"/api/v2/organization/rooms?page[number]=1&page[size]=25\"\n },\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"room\",\n \"id\": \"2\",\n \"attributes\": {\n \"state\": \"open\",\n \"name\": \"Confidential Room\",\n \"inserted-at\": \"2020-01-30T10:17:30.250131\"\n }\n },\n {\n \"type\": \"room\",\n \"id\": \"1\",\n \"attributes\": {\n \"state\": \"open\",\n \"name\": \"Open Room\",\n \"inserted-at\": \"2020-01-30T10:17:30.242603\"\n }\n }\n ]\n}"}],"_postman_id":"a9920e63-adbc-4ccc-b2eb-1ebc97374fa0"},{"name":"Get all organization rooms stats","id":"9d424c3b-9c1e-4e55-b611-4d10077248bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/organization/rooms/stats","description":"State statistics of all rooms that belong to the user's organization.
\n","urlObject":{"path":["api","v2","organization","rooms","stats"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d424c3b-9c1e-4e55-b611-4d10077248bc"},{"name":"Get all rooms stats","id":"ce2a7dae-6ff2-46c3-ad75-4df3893594a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/rooms/stats","description":"State statistics of all rooms where user is member of excluding those of his organization
\n","urlObject":{"path":["api","v2","rooms","stats"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce2a7dae-6ff2-46c3-ad75-4df3893594a0"},{"name":"Get room types","id":"33aa4da4-8b37-4027-97e5-f89f886386d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/room-types","urlObject":{"path":["api","v2","room-types"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"4f2ab7f0-620f-4b2c-85b6-340fdbda5f42","name":"Returns room types","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/room-types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"room-type\",\n \"id\": \"0\",\n \"attributes\": {\n \"value\": \"real_estate_-_acquisition\",\n \"label\": \"Real Estate - Acquisition\",\n \"id\": 0\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"1\",\n \"attributes\": {\n \"value\": \"real_estate_-_refinance\",\n \"label\": \"Real Estate - Refinance\",\n \"id\": 1\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"2\",\n \"attributes\": {\n \"value\": \"real_estate_-_development\",\n \"label\": \"Real Estate - Development\",\n \"id\": 2\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"3\",\n \"attributes\": {\n \"value\": \"real_estate_-_asset_management\",\n \"label\": \"Real Estate - Asset Management\",\n \"id\": 3\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"4\",\n \"attributes\": {\n \"value\": \"real_estate_-_leasing\",\n \"label\": \"Real Estate - Leasing\",\n \"id\": 4\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"5\",\n \"attributes\": {\n \"value\": \"real_estate_-_syndication\",\n \"label\": \"Real Estate - Syndication\",\n \"id\": 5\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"6\",\n \"attributes\": {\n \"value\": \"real_estate_-_leasehold\",\n \"label\": \"Real Estate - Leasehold\",\n \"id\": 6\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"7\",\n \"attributes\": {\n \"value\": \"real_estate_-_other\",\n \"label\": \"Real Estate - Other\",\n \"id\": 7\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"8\",\n \"attributes\": {\n \"value\": \"energy\",\n \"label\": \"Energy\",\n \"id\": 8\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"9\",\n \"attributes\": {\n \"value\": \"infrastructure\",\n \"label\": \"Infrastructure\",\n \"id\": 9\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"10\",\n \"attributes\": {\n \"value\": \"aviation\",\n \"label\": \"Aviation\",\n \"id\": 10\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"11\",\n \"attributes\": {\n \"value\": \"corporate\",\n \"label\": \"Corporate\",\n \"id\": 11\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"12\",\n \"attributes\": {\n \"value\": \"litigation\",\n \"label\": \"Litigation\",\n \"id\": 12\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"13\",\n \"attributes\": {\n \"value\": \"litigation_financing\",\n \"label\": \"Litigation Financing\",\n \"id\": 13\n }\n },\n {\n \"type\": \"room-type\",\n \"id\": \"14\",\n \"attributes\": {\n \"value\": \"other\",\n \"label\": \"Other\",\n \"id\": 14\n }\n }\n ]\n}"}],"_postman_id":"33aa4da4-8b37-4027-97e5-f89f886386d7"},{"name":"Get room templates (deprecated)","id":"6f39f5c8-9835-4897-b289-c29add9583b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/room-templates","description":"Returns names and IDs of all available room templates.
\n","urlObject":{"path":["api","v2","room-templates"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"8ae8999b-f6dc-4454-a683-8b2dad3d05be","name":"Returns room templates","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/room-templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"room-template\",\n \"id\": \"2\",\n \"attributes\": {\n \"name\": \"Example template 2\"\n }\n },\n {\n \"type\": \"room-template\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Example template 1\"\n }\n }\n ]\n}"}],"_postman_id":"6f39f5c8-9835-4897-b289-c29add9583b2"},{"name":"Get room","id":"0bb0d33e-80bd-4f82-87af-b97fd911c0c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/rooms/:room_id","description":"Available \"include\" options:
\norganizationcreatorwhitelisted_organizationsparties (teams)workspaceBy default, if nothing is specified, teams are included. However, if the include parameter is added, then only the specified entities are included.
Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"attributes\":{ \n \"name\":\"My new data room\",\n \"changelog-enabled\":true,\n \"notes-enabled\":true,\n \"custom-column-enabled\":true,\n \"custom-column-label\":\"Custom\",\n \"document-restrictions\":\"restricted_visible\",\n \"room-type\":\"real_estate_-_acquisition\",\n \"actual-close-date\": \"2019-10-10\",\n \"total-transaction-amount\": 100000,\n \"metadata\": {\n \"any_meta_field\": \"meta value\"\n },\n \"folders_inbox_enabled\": false\n }\n }\n}"},"url":"http://localhost:4000//api/v2/rooms","description":"name: The name of the room. (255 characters max)document-restrictions: Checklist access management. Can take the next values:no_restrictions for Open Roomrestricted_invisible for Confidential Room (default)In open rooms, everyone can see every document. In confidential rooms, team access can be set later. Checklist access management can be set only once, during the room creation, and cannot be changed later.
\nroom-type: The Room type. Can take the next values:real_estate_-_acquisition for Real Estate - Acquisitionreal_estate_-_refinance for Real Estate - Refinancereal_estate_-_development for Real Estate - Developmentreal_estate_-_asset_management for Real Estate - Asset Managementreal_estate_-_leasing for Real Estate - Leasingreal_estate_-_syndication for Real Estate - Syndicationreal_estate_-_refinance for Real Estate - Leasehold real_estate_-_syndication for Real Estate - Financing/Refinancing real_estate_-_disposition for Real Estate - Dispositionreal_estate_-_other for Real Estate - Otherenergy for Energyinfrastructure for Infrastructureaviation for Aviationcorporate for Corporatelitigation for Litigationlitigation_financing for Litigation Financingother for OtherAll other fields explained in the room definition can also be set while creating the room
\nNote: There are limitations on certain fields:
\nThe metadata attribute is an object that contains the fields in a key/value way.
\nKeys are custom and can be anything you want. But they must start with a letter, followed by letters, numbers, dashes and underscores.
\nValues cannot be null, all the keys with null values will be ignored.
\n\"data\": {\n \"type\": \"room\",\n \"attributes\": {\n \"name\": \"Room name\",\n \"room-type\": \"real_estate_-_acquisition\",\n \"document-restrictions\": \"restricted_visible\",\n \"metadata\": {\n \"custom_key\": \"custom_value\",\n \"custom_key2\": \"custom_value2\"\n }\n }\n}\nNote: In the response, do not confuse meta, with attributes > metadata.
To create a new room based on a checklist template you have to provide the checklist template relationship:
\n\"data\": {\n \"type\": \"room\",\n \"attributes\": {\n ...\n },\n \"relationships\": {\n \"checklist-template\": {\n \"data\": { \"id\": \"123\", \"type\": \"checklist-template\" }\n }\n }\n}\nactual-close-date: \"2019-10-10\").While creating a room, an initial host team is created for that room, too, and the current user is added to that team. The team is included in the response.
\nOnly Certified users can create rooms.
\n","urlObject":{"path":["api","v2","rooms"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"267e5046-7820-4d1b-b003-74de14841689","name":"Create room invalid date format","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"attributes\":{ \n \"name\":\"My new data room\",\n \"actual-close-date\": \"Oct 10, 2019\",\n \"document-restrictions\":\"restricted_visible\",\n \"room-type\":\"real_estate_-_acquisition\",\n }\n }\n}"},"url":"http://localhost:4000//api/v2/rooms"},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"203"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"errors\": [\n {\n \"title\": \"is invalid\",\n \"status\": \"422\",\n \"source\": {\n \"pointer\": \"data/attributes/actual-close-date\"\n },\n \"detail\": \"Actual close date is invalid\",\n \"code\": \"INVALID_FIELD_CAST\"\n }\n ]\n}"},{"id":"e42ec6f6-f2b7-4c47-97d2-d61dd7daa738","name":"Create room success","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"attributes\":{ \n \"name\":\"My new data room\",\n \"changelog-enabled\":true,\n \"notes-enabled\":true,\n \"custom-column-enabled\":true,\n \"custom-column-label\":\"Custom\",\n \"document-restrictions\":\"restricted_visible\",\n \"room-type\":\"real_estate_-_acquisition\",\n \"actual-close-date\": \"2019-10-10\",\n \"total-transaction-amount\": 1000000,\n \"metadata\": {\n \"any_meta_field\": \"meta value\"\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/rooms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Thu, 04 Apr 2019 13:40:16 GMT"},{"key":"content-length","value":"2448"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2m94i7jej9j1rd4eec0013v1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"included\": [\n {\n \"type\": \"team\",\n \"id\": \"4\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"name\": \"RandomCoolName Company (OH)\",\n \"abbreviation\": \"O\"\n }\n }\n ],\n \"data\": {\n \"type\": \"room\",\n \"relationships\": {\n \"parties\": {\n \"data\": [\n {\n \"type\": \"team\",\n \"id\": \"4\"\n }\n ]\n },\n \"creator\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"1\"\n }\n }\n },\n \"meta\": {\n \"link\": \"https://prodeal360.com/dashboard/5\"\n },\n \"id\": \"5\",\n \"attributes\": {\n \"construction-loan-amount\": null,\n \"lender\": null,\n \"agent-1031\": null,\n \"co-insurance-1-title-number\": null,\n \"mortgage-broker\": null,\n \"custom-column-label\": \"Custom\",\n \"co-insurance-percentage\": null,\n \"seller-counsel\": null,\n \"actual-close-date\": \"Oct 10, 2019\",\n \"additional-information\": null,\n \"co-insurance-1-percentage\": null,\n \"co-insurance-2-underwriter-name\": null,\n \"building-type\": null,\n \"advisor\": null,\n \"user-team-abbreviation\": null,\n \"document-restrictions\": \"restricted_visible\",\n \"co-insurance-1-underwriter-name\": null,\n \"metadata\": {\n \"any_meta_field\": \"meta value\"\n },\n \"notes-enabled\": true,\n \"lng\": null,\n \"lender-counsel\": null,\n \"co-insurance-3-title-company\": null,\n \"purchase-amount\": null,\n \"city\": null,\n \"room-details-flag-enabled\": false,\n \"name\": \"My new data room\",\n \"state\": \"open\",\n \"co-insurance-2-title-policy-number\": null,\n \"co-insurance-1-title-company\": null,\n \"purchaser\": null,\n \"completed-percentage\": 0,\n \"user-team-type\": null,\n \"co-insurance-1-title-policy-number\": null,\n \"custom-column-enabled\": true,\n \"loan-amount\": null,\n \"mezzanine-loan-amount\": null,\n \"property-and-casuality-insurance-provider\": null,\n \"surveyor\": null,\n \"co-insurance-2-percentage\": null,\n \"favorite\": false,\n \"lat\": null,\n \"total-transaction-amount\": \"$1,000,000\",\n \"changelog-enabled\": true,\n \"address-autocomplete\": null,\n \"unread-notes-count\": null,\n \"borrower\": null,\n \"address\": null,\n \"other-financing-amount\": null,\n \"second-mortgage-loan-amount\": null,\n \"property-manager\": null,\n \"lead-title-company\": null,\n \"room-type\": \"Real Estate - Acquisition\",\n \"borrower-counsel\": null,\n \"country\": null,\n \"role\": null,\n \"user-team-name\": null,\n \"unseen-changelog-entries-count\": null,\n \"co-insurance-3-title-number\": null,\n \"purchaser-counsel\": null,\n \"seller\": null,\n \"co-insurance-3-percentage\": null,\n \"nick-name\": null,\n \"co-insurance-2-title-number\": null,\n \"unread-docs-count\": null,\n \"estimated-close-date\": null,\n \"title-number\": null,\n \"prodeal-number\": \"D-000-0005\",\n \"underwriter-name\": null,\n \"title-policy-number\": null,\n \"investment-sales-broker\": null,\n \"notes\": null,\n \"engineer\": null,\n \"zip-code\": null,\n \"flood-insurance-provider\": null,\n \"appraiser\": null,\n \"co-insurance-2-title-company\": null,\n \"co-insurance-3-underwriter-name\": null,\n \"co-insurance-3-title-policy-number\": null,\n \"folders-inbox-enabled\": false\n }\n }\n}"},{"id":"ec7b7ec9-85a2-4934-b0c2-7ee1e79a42c7","name":"Create room from template success","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"attributes\":{ \n \"name\":\"My new data room\",\n \"changelog-enabled\":true,\n \"notes-enabled\":true,\n \"custom-column-enabled\":true,\n \"custom-column-label\":\"Custom\",\n \"document-restrictions\":\"restricted_visible\",\n \"room-type\":\"real_estate_-_acquisition\",\n \"metadata\": {\n \"any_meta_field\": \"meta value\"\n },\n \"folders_inbox_enabled\": false\n },\n \"relationships\": {\n \"checklist-template\": {\n \"data\": {\n \"id\": \"5\", \n \"type\": \"checklist-template\" \n }\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/rooms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"1180"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"team\",\n \"id\": \"1575\",\n \"attributes\": {\n \"type-name\": \"Purchaser\",\n \"role-id\": \"host_admin\",\n \"name\": \"ProDeal\",\n \"is-member\": true,\n \"abbreviation\": \"P\"\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"1576\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"role-id\": \"guest\",\n \"name\": \"Other\",\n \"is-member\": false,\n \"abbreviation\": \"O\"\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"1577\",\n \"attributes\": {\n \"type-name\": \"Title Company\",\n \"role-id\": \"guest\",\n \"name\": \"Title Company\",\n \"is-member\": false,\n \"abbreviation\": \"TC\"\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"1578\",\n \"attributes\": {\n \"type-name\": \"Surveyor\",\n \"role-id\": \"guest\",\n \"name\": \"Surveyor\",\n \"is-member\": false,\n \"abbreviation\": \"SU\"\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"1579\",\n \"attributes\": {\n \"type-name\": \"Borrower Counsel\",\n \"role-id\": \"guest\",\n \"name\": \"Borrower Counsel\",\n \"is-member\": false,\n \"abbreviation\": \"BC\"\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"1580\",\n \"attributes\": {\n \"type-name\": \"Seller\",\n \"role-id\": \"guest\",\n \"name\": \"Seller\",\n \"is-member\": false,\n \"abbreviation\": \"SE\"\n }\n }\n ],\n \"data\": {\n \"type\": \"room\",\n \"relationships\": {\n \"workspace\": {\n \"data\": null\n },\n \"whitelisted-organizations\": {},\n \"parties\": {\n \"data\": [\n {\n \"type\": \"team\",\n \"id\": \"1575\"\n },\n {\n \"type\": \"team\",\n \"id\": \"1579\"\n },\n {\n \"type\": \"team\",\n \"id\": \"1576\"\n },\n {\n \"type\": \"team\",\n \"id\": \"1580\"\n },\n {\n \"type\": \"team\",\n \"id\": \"1578\"\n },\n {\n \"type\": \"team\",\n \"id\": \"1577\"\n }\n ]\n },\n \"organization\": {\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"1\"\n }\n },\n \"creator\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"19\"\n }\n }\n },\n \"meta\": {\n \"link\": \"https://staging.prodeal.dev/dashboard/750\"\n },\n \"id\": \"750\",\n \"attributes\": {\n \"construction-loan-amount\": null,\n \"lender\": null,\n \"agent-1031\": null,\n \"co-insurance-1-title-number\": null,\n \"mortgage-broker\": null,\n \"custom-column-label\": \"Custom\",\n \"co-insurance-percentage\": null,\n \"documents-watermark-enabled\": false,\n \"seller-counsel\": null,\n \"actual-close-date\": null,\n \"additional-information\": null,\n \"co-insurance-1-percentage\": null,\n \"co-insurance-2-underwriter-name\": null,\n \"building-type\": null,\n \"advisor\": null,\n \"user-team-abbreviation\": \"P\",\n \"co-insurance-1-underwriter-name\": null,\n \"metadata\": {\n \"any_meta_field\": \"meta value\"\n },\n \"notes-enabled\": true,\n \"lng\": null,\n \"lender-counsel\": null,\n \"co-insurance-3-title-company\": null,\n \"purchase-amount\": null,\n \"city\": null,\n \"room-details-flag-enabled\": false,\n \"name\": \"My new data room\",\n \"state\": \"open\",\n \"co-insurance-2-title-policy-number\": null,\n \"co-insurance-1-title-company\": null,\n \"purchaser\": null,\n \"completed-percentage\": 0,\n \"role-id\": \"host_admin\",\n \"creator-party-id\": 1575,\n \"org-private\": false,\n \"user-team-type\": \"Purchaser\",\n \"co-insurance-1-title-policy-number\": null,\n \"custom-column-enabled\": true,\n \"loan-amount\": null,\n \"mezzanine-loan-amount\": null,\n \"property-and-casuality-insurance-provider\": null,\n \"surveyor\": null,\n \"co-insurance-2-percentage\": null,\n \"favorite\": false,\n \"lat\": null,\n \"total-transaction-amount\": null,\n \"changelog-enabled\": true,\n \"address-autocomplete\": null,\n \"unread-notes-count\": 0,\n \"borrower\": null,\n \"address\": null,\n \"other-financing-amount\": null,\n \"progress-detail\": {\n \"percentage\": 0,\n \"open\": 46,\n \"in_progress\": 0,\n \"closed\": 0\n },\n \"second-mortgage-loan-amount\": null,\n \"permission-type\": \"confidential\",\n \"property-manager\": null,\n \"lead-title-company\": null,\n \"room-type\": \"Real Estate - Acquisition\",\n \"borrower-counsel\": null,\n \"country\": null,\n \"user-team-name\": \"ProDeal\",\n \"unseen-changelog-entries-count\": 0,\n \"co-insurance-3-title-number\": null,\n \"purchaser-counsel\": null,\n \"seller\": null,\n \"co-insurance-3-percentage\": null,\n \"nick-name\": null,\n \"co-insurance-2-title-number\": null,\n \"unread-docs-count\": 0,\n \"estimated-close-date\": null,\n \"title-number\": null,\n \"folders-inbox-enabled\": false,\n \"prodeal-number\": \"D-000-0750\",\n \"underwriter-name\": null,\n \"title-policy-number\": null,\n \"documents-watermark-text\": null,\n \"investment-sales-broker\": null,\n \"created-at-utc\": \"2020-06-23T07:02:37.119260\",\n \"notes\": null,\n \"engineer\": null,\n \"zip-code\": null,\n \"flood-insurance-provider\": null,\n \"appraiser\": null,\n \"co-insurance-2-title-company\": null,\n \"co-insurance-3-underwriter-name\": null,\n \"co-insurance-3-title-policy-number\": null\n }\n }\n}"}],"_postman_id":"23136622-3f46-44ab-ae73-281a32065e31"},{"name":"Clone room","id":"100ca51f-6d0a-4752-adda-49a860c2e92f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\": { \n \"type\": \"room\",\n \"attributes\": {\n \"name\": \"New cloned room\"\n },\n \"relationships\": {\n \"source-room\": {\n \"data\": { \n \"id\": \"256\", \n \"type\": \"room\" \n }\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/rooms","description":"To create a new room based on the existing one you have to provide source room ID in the \"relationships\" section of the body.
All fields in \"attributes\" section except name are ignored when cloning a room.
Since room cloning for large rooms might take time, users are informed when cloning is finished via email and response with status code 201.
Only Certified users can clone rooms; and only the rooms in which they are hosts.
\n","urlObject":{"path":["api","v2","rooms"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"000d7a73-84cd-4779-aefb-7830f2c3c04f","name":"Clone room success","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\": { \n \"type\":\"room\",\n \"attributes\": {\n \"name\": \"New cloned room\"\n },\n \"relationships\": {\n \"source-room\": {\n \"data\": { \n \"id\": \"256\", \n \"type\": \"room\" \n }\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/rooms"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null},{"id":"97107247-86db-4eb5-949f-4a2880ef0f06","name":"Clone room wrong ID","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"relationships\": {\n \"source-room\": {\n \"data\": { \n \"id\": \"256\", \n \"type\": \"room\" \n }\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/rooms"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"errors\": [\n {\n \"title\": \"404 Not Found\",\n \"status\": 404,\n \"detail\": \"404 Not Found\"\n }\n ]\n}"}],"_postman_id":"100ca51f-6d0a-4752-adda-49a860c2e92f"},{"name":"Update room","id":"5cbbfc87-35ad-4758-b63c-c2aa223607fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"id\": \"4\",\n \"attributes\":{ \n \"name\":\"My new data room\",\n \"changelog-enabled\":true,\n \"notes-enabled\":true,\n \"custom-column-enabled\":true,\n \"custom-column-label\":\"Custom\",\n \"room-type\":\"real_estate_-_acquisition\",\n \"user-team-name\":null,\n \"unseen-changelog-entries-count\":null,\n \"co-insurance-3-title-number\":\"1234567\",\n \"purchaser-counsel\":\"purchaser\",\n \"seller\":\"seller\",\n \"co-insurance-3-percentage\":\"13%\",\n \"nick-name\":\"New Room\",\n \"co-insurance-2-title-number\":\"12345\",\n \"estimated-close-date\":\"2020-03-19\",\n \"metadata\": {\n \t \"external_id\": \"123456\"\n },\n \"folders-inbox-enabled\": false\n }\n }\n}"},"url":"http://localhost:4000//api/v2/rooms/:room_id","description":"You can update 1 or more room attributes in a single request. Only specify the attributes you wish to change.
\nNote: Checklist access management (permission-type) cannot be changed.
To add or update a metadata entry, send an object with the desired key/value.
\nTo delete an entry, send an object with the key assigned to null.
\nExample:
\nTo delete the metadata field external_id:
\"data\":{ \n \"type\": \"room\",\n \"id\": \"4\",\n \"attributes\": { \n \"metadata\": {\n \"external_id\": null\n }\n }\n}\n422 is returned and the error code is INVALID_FIELD_CAST409 is returned and the error code is TRANSITION_TO_PRIVATE_ROOM_NOT_ALLOWED.Only room Hosts can update the room.
\n","urlObject":{"path":["api","v2","rooms",":room_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"d1fc213f-1d57-41f0-98a9-248096b890fc","type":"string","value":"4","key":"room_id"}]}},"response":[{"id":"3b8d5ec6-e109-49e7-9b01-0415dfce17c6","name":"Update a room","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"id\": \"4\",\n \"attributes\":{ \n \"name\":\"My new data room\",\n \"changelog-enabled\":true,\n \"notes-enabled\":true,\n \"custom-column-enabled\":true,\n \"custom-column-label\":\"Custom\",\n \"document-restrictions\":\"restricted_visible\",\n \"room-type\":\"real_estate_-_acquisition\",\n \"user-team-name\":null,\n \"unseen-changelog-entries-count\":null,\n \"co-insurance-3-title-number\":\"1234567\",\n \"purchaser-counsel\":\"purchaser\",\n \"seller\":\"seller\",\n \"co-insurance-3-percentage\":\"13%\",\n \"nick-name\":\"New Room\",\n \"co-insurance-2-title-number\":\"12345\",\n \"estimated-close-date\":\"2020-03-19\",\n \"metadata\": {\n \t \"external_id\": \"123456\"\n }\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id"],"variable":[{"key":"room_id","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"2528"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"included\": [\n {\n \"type\": \"team\",\n \"id\": \"3\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"name\": \"RandomCoolName Company (OH)\",\n \"abbreviation\": \"O\"\n }\n }\n ],\n \"data\": {\n \"type\": \"room\",\n \"relationships\": {\n \"parties\": {\n \"data\": [\n {\n \"type\": \"team\",\n \"id\": \"3\"\n }\n ]\n },\n \"creator\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"1\"\n }\n }\n },\n \"meta\": {\n \"link\": \"https://prodeal360.com/dashboard/4\"\n },\n \"id\": \"4\",\n \"attributes\": {\n \"construction-loan-amount\": null,\n \"lender\": null,\n \"agent-1031\": null,\n \"co-insurance-1-title-number\": null,\n \"mortgage-broker\": null,\n \"custom-column-label\": \"Custom\",\n \"co-insurance-percentage\": null,\n \"seller-counsel\": null,\n \"actual-close-date\": \"Apr 15, 2019\",\n \"additional-information\": null,\n \"co-insurance-1-percentage\": null,\n \"co-insurance-2-underwriter-name\": null,\n \"building-type\": null,\n \"advisor\": null,\n \"user-team-abbreviation\": \"O\",\n \"document-restrictions\": \"restricted_visible\",\n \"co-insurance-1-underwriter-name\": null,\n \"metadata\": {\n \"external_id\": \"123456\"\n },\n \"notes-enabled\": true,\n \"lng\": null,\n \"lender-counsel\": null,\n \"co-insurance-3-title-company\": null,\n \"purchase-amount\": null,\n \"city\": null,\n \"room-details-flag-enabled\": false,\n \"name\": \"My new data room\",\n \"state\": \"open\",\n \"co-insurance-2-title-policy-number\": null,\n \"co-insurance-1-title-company\": null,\n \"purchaser\": null,\n \"completed-percentage\": 0,\n \"user-team-type\": \"Other\",\n \"co-insurance-1-title-policy-number\": null,\n \"custom-column-enabled\": true,\n \"loan-amount\": null,\n \"mezzanine-loan-amount\": null,\n \"property-and-casuality-insurance-provider\": null,\n \"surveyor\": null,\n \"co-insurance-2-percentage\": null,\n \"favorite\": false,\n \"lat\": null,\n \"total-transaction-amount\": \"$200,000,000\",\n \"changelog-enabled\": true,\n \"address-autocomplete\": null,\n \"unread-notes-count\": 0,\n \"borrower\": null,\n \"address\": null,\n \"other-financing-amount\": null,\n \"second-mortgage-loan-amount\": null,\n \"property-manager\": null,\n \"lead-title-company\": null,\n \"room-type\": \"Real Estate - Development\",\n \"borrower-counsel\": null,\n \"country\": null,\n \"role\": \"host_admin\",\n \"user-team-name\": \"RandomCoolName Company (OH)\",\n \"unseen-changelog-entries-count\": 0,\n \"co-insurance-3-title-number\": \"1234567\",\n \"purchaser-counsel\": \"purchaser\",\n \"seller\": \"seller\",\n \"co-insurance-3-percentage\": \"13%\",\n \"nick-name\": \"New Room\",\n \"co-insurance-2-title-number\": \"12345\",\n \"unread-docs-count\": 0,\n \"estimated-close-date\": \"Mar 19, 2020\",\n \"title-number\": null,\n \"prodeal-number\": \"D-000-0004\",\n \"underwriter-name\": null,\n \"title-policy-number\": null,\n \"investment-sales-broker\": null,\n \"notes\": null,\n \"engineer\": null,\n \"zip-code\": null,\n \"flood-insurance-provider\": null,\n \"appraiser\": null,\n \"co-insurance-2-title-company\": null,\n \"co-insurance-3-underwriter-name\": null,\n \"co-insurance-3-title-policy-number\": null,\n \"folders-inbox-enabled\": false\n }\n }\n}"},{"id":"88154923-bb1e-4f59-9577-0d9b0c14289d","name":"Cannot convert to private room","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"id\": \"311\",\n \"attributes\":{ \n \"org-private\":true\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id"],"variable":[{"key":"room_id","type":"string","value":"311"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"246"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"errors\": [\n {\n \"title\": \"409 Conflict\",\n \"status\": \"409\",\n \"source\": {\n \"pointer\": null\n },\n \"detail\": \"Can't make room org private when members do not belong to approved organizations\",\n \"code\": \"TRANSITION_TO_PRIVATE_ROOM_NOT_ALLOWED\"\n }\n ]\n}"},{"id":"b24b8b5b-b21d-4e2e-9930-ce6b93fe313b","name":"Invalid room field format","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"id\": \"256\",\n \"attributes\":{ \n \"estimated-close-date\":\"Oct 20, 2019\"\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id"],"variable":[{"key":"room_id","type":"string","value":"256"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"209"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"errors\": [\n {\n \"title\": \"is invalid\",\n \"status\": \"422\",\n \"source\": {\n \"pointer\": \"data/attributes/estimated-close-date\"\n },\n \"detail\": \"Estimated close date is invalid\",\n \"code\": \"INVALID_FIELD_CAST\"\n }\n ]\n}"},{"id":"cbdc6f4f-3d9c-4fad-b791-46cec94a3a93","name":"Update room metadata","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"id\": \"4\",\n \"attributes\":{ \n \"metadata\": {\n \t \"external_id\": \"665544\"\n }\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id"],"variable":[{"key":"room_id","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"2528"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"included\": [\n {\n \"type\": \"team\",\n \"id\": \"3\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"name\": \"RandomCoolName Company (OH)\",\n \"abbreviation\": \"O\"\n }\n }\n ],\n \"data\": {\n \"type\": \"room\",\n \"relationships\": {\n \"parties\": {\n \"data\": [\n {\n \"type\": \"team\",\n \"id\": \"3\"\n }\n ]\n },\n \"creator\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"1\"\n }\n }\n },\n \"meta\": {\n \"link\": \"https://prodeal360.com/dashboard/4\"\n },\n \"id\": \"4\",\n \"attributes\": {\n \"construction-loan-amount\": null,\n \"lender\": null,\n \"agent-1031\": null,\n \"co-insurance-1-title-number\": null,\n \"mortgage-broker\": null,\n \"custom-column-label\": \"Custom\",\n \"co-insurance-percentage\": null,\n \"seller-counsel\": null,\n \"actual-close-date\": \"Apr 15, 2019\",\n \"additional-information\": null,\n \"co-insurance-1-percentage\": null,\n \"co-insurance-2-underwriter-name\": null,\n \"building-type\": null,\n \"advisor\": null,\n \"user-team-abbreviation\": \"O\",\n \"document-restrictions\": \"restricted_visible\",\n \"co-insurance-1-underwriter-name\": null,\n \"metadata\": {\n \"external_id\": \"665544\"\n },\n \"notes-enabled\": true,\n \"lng\": null,\n \"lender-counsel\": null,\n \"co-insurance-3-title-company\": null,\n \"purchase-amount\": null,\n \"city\": null,\n \"room-details-flag-enabled\": false,\n \"name\": \"My new data room\",\n \"state\": \"open\",\n \"co-insurance-2-title-policy-number\": null,\n \"co-insurance-1-title-company\": null,\n \"purchaser\": null,\n \"completed-percentage\": 0,\n \"user-team-type\": \"Other\",\n \"co-insurance-1-title-policy-number\": null,\n \"custom-column-enabled\": true,\n \"loan-amount\": null,\n \"mezzanine-loan-amount\": null,\n \"property-and-casuality-insurance-provider\": null,\n \"surveyor\": null,\n \"co-insurance-2-percentage\": null,\n \"favorite\": false,\n \"lat\": null,\n \"total-transaction-amount\": \"$200,000,000\",\n \"changelog-enabled\": true,\n \"address-autocomplete\": null,\n \"unread-notes-count\": 0,\n \"borrower\": null,\n \"address\": null,\n \"other-financing-amount\": null,\n \"second-mortgage-loan-amount\": null,\n \"property-manager\": null,\n \"lead-title-company\": null,\n \"room-type\": \"Real Estate - Development\",\n \"borrower-counsel\": null,\n \"country\": null,\n \"role\": \"host_admin\",\n \"user-team-name\": \"RandomCoolName Company (OH)\",\n \"unseen-changelog-entries-count\": 0,\n \"co-insurance-3-title-number\": \"1234567\",\n \"purchaser-counsel\": \"purchaser\",\n \"seller\": \"seller\",\n \"co-insurance-3-percentage\": \"13%\",\n \"nick-name\": \"New Room\",\n \"co-insurance-2-title-number\": \"12345\",\n \"unread-docs-count\": 0,\n \"estimated-close-date\": \"Mar 19, 2020\",\n \"title-number\": null,\n \"prodeal-number\": \"D-000-0004\",\n \"underwriter-name\": null,\n \"title-policy-number\": null,\n \"investment-sales-broker\": null,\n \"notes\": null,\n \"engineer\": null,\n \"zip-code\": null,\n \"flood-insurance-provider\": null,\n \"appraiser\": null,\n \"co-insurance-2-title-company\": null,\n \"co-insurance-3-underwriter-name\": null,\n \"co-insurance-3-title-policy-number\": null,\n \"folders-inbox-enabled\": false\n }\n }\n}"}],"_postman_id":"5cbbfc87-35ad-4758-b63c-c2aa223607fd"},{"name":"Update room state as the organization admin","id":"0fee445d-f07c-4c5c-8d32-74ceb2648848","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"id\": \"1\",\n \"attributes\":{ \n \"state\":\"closed\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/organization/rooms/:room_id","description":"Update room state as the organization admin
\nRoom state can be updated only by the users that belong to the same organization as room itself
\n","urlObject":{"path":["api","v2","organization","rooms",":room_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"9bf82a99-7dc1-4b4e-95d4-ff38e42fc416","type":"string","value":"1","key":"room_id"}]}},"response":[{"id":"77bb1665-c6b7-4ba2-96ef-eb7424148abd","name":"Room state updated","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{ \n \"data\":{ \n \"type\":\"room\",\n \"id\": \"1\",\n \"attributes\":{ \n \"state\":\"closed\"\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/organization/rooms/:room_id","host":["http://localhost:4000/"],"path":["api","v2","organization","rooms",":room_id"],"variable":[{"key":"room_id","type":"string","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 04 Feb 2020 12:18:43 GMT"},{"key":"content-length","value":"155"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2no34g92q1edg7ns9c006mq5"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"room\",\n \"id\": \"1\",\n \"attributes\": {\n \"state\": \"closed\",\n \"name\": \"Open Room\",\n \"inserted-at\": \"2020-01-30T10:17:30.242603\"\n }\n }\n}"}],"_postman_id":"0fee445d-f07c-4c5c-8d32-74ceb2648848"},{"name":"Update room-workspace relationship","id":"013e941a-b99e-4e0e-8fde-5316ad1167d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\": \"workspace\",\n\t\t\"id\": \"1\"\n\t}\n}\n\n"},"url":"http://localhost:4000//api/v2/rooms/:room_id/relationships/workspace","description":"Organize Rooms by grouping them together in a workspace. Use this endpoint to move rooms from one workspace to another, or to remove rooms from the workspaces.
\nOn success, the response returns the workspace to which the room is now assigned.
\nOnly Hosts of the room that are Workspace users too can change the room's workspace.
\n","urlObject":{"path":["api","v2","rooms",":room_id","relationships","workspace"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"003d8e71-2b8b-49d7-baeb-f0bf3b761952","type":"string","value":"4","key":"room_id"}]}},"response":[{"id":"08509461-dc67-409a-b2cd-52e39b492e01","name":"Delete room workspace relationship","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n\t\"data\": null\n}\n\n"},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id/relationships/workspace","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id","relationships","workspace"],"variable":[{"key":"room_id","value":"4"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"0"},{"key":"content-type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":null},{"id":"a2300110-d577-407c-ae3f-9e693c24f14d","name":"Update room workspace relationship","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\": \"workspace\",\n\t\t\"id\": \"1\"\n\t}\n}\n\n"},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id/relationships/workspace","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id","relationships","workspace"],"variable":[{"key":"room_id","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"114"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"data\": {\n \"type\": \"workspace\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"workspace 1\",\n \"description\": \"workspace description 1\"\n }\n }\n}"}],"_postman_id":"013e941a-b99e-4e0e-8fde-5316ad1167d1"},{"name":"Add room to favorites","id":"70ea7ae9-357c-4948-b597-a13d4baea29d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"favorite-room\",\n \"relationships\": {\n \"room\": {\n \"data\": {\n \"type\": \"room\",\n \"id\": \"12\"\n }\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/me/favorite-rooms","description":"Error 422 is returned when user tries to add a room that is already in favorites.
Error 404 is returned when a user tries to remove a room that was already removed.
Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/organization/rooms/:room_id/join","urlObject":{"path":["api","v2","organization","rooms",":room_id","join"],"host":["http://localhost:4000/"],"query":[],"variable":[{"type":"string","value":"12","key":"room_id"}]}},"response":[{"id":"f38b2d79-8dc6-48aa-9c47-1d2c27fa775b","name":"Join to an room organization room as organization admin","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"url":{"raw":"http://localhost:4000//api/v2/organization/rooms/:room_id/join","host":["http://localhost:4000/"],"path":["api","v2","organization","rooms",":room_id","join"],"variable":[{"key":"room_id","value":"6"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 09 Jun 2020 18:52:40 GMT"},{"key":"content-length","value":"2989"},{"key":"set-cookie","value":"_prodeal360=SFMyNTY.g3QAAAAGbQAAAAxhY2Nlc3NfdG9rZW5kAANuaWxtAAAACmV4cGlyZXNfaW5kAANuaWxtAAAADHJlZGlyZWN0X3VybGQAA25pbG0AAAANcmVmcmVzaF90b2tlbmQAA25pbG0AAAASc2Vzc2lvbl90aW1lb3V0X2F0Yl7hK_ltAAAAB3VzZXJfaWRhAQ.JKYR6wVlAF2LnfrU7g5k5PG043X1NxCuc_h7aK6QgEg; path=/; HttpOnly"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2ob8m7kfdo8hk6rfs0014421"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"team\",\n \"id\": \"10\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"role-id\": \"host_admin\",\n \"name\": \"Stark Industries\",\n \"is-member\": true,\n \"abbreviation\": \"O\"\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"11\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"role-id\": \"admin\",\n \"name\": \"fawefw\",\n \"is-member\": false,\n \"abbreviation\": \"O\"\n }\n }\n ],\n \"data\": {\n \"type\": \"room\",\n \"relationships\": {\n \"workspace\": {\n \"data\": null\n },\n \"whitelisted-organizations\": {},\n \"parties\": {\n \"data\": [\n {\n \"type\": \"team\",\n \"id\": \"10\"\n },\n {\n \"type\": \"team\",\n \"id\": \"11\"\n }\n ]\n },\n \"organization\": {\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"1\"\n }\n },\n \"creator\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"7\"\n }\n }\n },\n \"meta\": {\n \"link\": \"http://prodeal360.com:4000/dashboard/6\"\n },\n \"id\": \"6\",\n \"attributes\": {\n \"construction-loan-amount\": null,\n \"lender\": null,\n \"agent-1031\": null,\n \"co-insurance-1-title-number\": null,\n \"mortgage-broker\": null,\n \"custom-column-label\": \"Custom\",\n \"co-insurance-percentage\": null,\n \"documents-watermark-enabled\": false,\n \"seller-counsel\": null,\n \"actual-close-date\": null,\n \"additional-information\": null,\n \"co-insurance-1-percentage\": null,\n \"co-insurance-2-underwriter-name\": null,\n \"building-type\": null,\n \"advisor\": null,\n \"user-team-abbreviation\": \"O\",\n \"co-insurance-1-underwriter-name\": null,\n \"metadata\": {},\n \"notes-enabled\": true,\n \"lng\": null,\n \"lender-counsel\": null,\n \"co-insurance-3-title-company\": null,\n \"purchase-amount\": null,\n \"city\": null,\n \"room-details-flag-enabled\": false,\n \"name\": \"A new Room\",\n \"state\": \"open\",\n \"is-member\": true,\n \"co-insurance-2-title-policy-number\": null,\n \"co-insurance-1-title-company\": null,\n \"purchaser\": null,\n \"completed-percentage\": 0,\n \"role-id\": \"host_admin\",\n \"creator-party-id\": 10,\n \"org-private\": false,\n \"user-team-type\": \"Other\",\n \"co-insurance-1-title-policy-number\": null,\n \"custom-column-enabled\": false,\n \"loan-amount\": null,\n \"mezzanine-loan-amount\": null,\n \"property-and-casuality-insurance-provider\": null,\n \"surveyor\": null,\n \"co-insurance-2-percentage\": null,\n \"favorite\": false,\n \"lat\": null,\n \"total-transaction-amount\": null,\n \"changelog-enabled\": true,\n \"address-autocomplete\": null,\n \"unread-notes-count\": 0,\n \"borrower\": null,\n \"address\": null,\n \"other-financing-amount\": null,\n \"progress-detail\": {\n \"percentage\": 0,\n \"open\": 1,\n \"in_progress\": 0,\n \"closed\": 0\n },\n \"second-mortgage-loan-amount\": null,\n \"permission-type\": \"confidential\",\n \"property-manager\": null,\n \"lead-title-company\": null,\n \"room-type\": \"Real Estate - Refinance\",\n \"borrower-counsel\": null,\n \"country\": null,\n \"user-team-name\": \"Stark Industries\",\n \"unseen-changelog-entries-count\": 6,\n \"co-insurance-3-title-number\": null,\n \"purchaser-counsel\": null,\n \"seller\": null,\n \"co-insurance-3-percentage\": null,\n \"nick-name\": null,\n \"co-insurance-2-title-number\": null,\n \"unread-docs-count\": 0,\n \"estimated-close-date\": null,\n \"title-number\": null,\n \"folders-inbox-enabled\": true,\n \"prodeal-number\": \"D-000-0006\",\n \"underwriter-name\": null,\n \"title-policy-number\": null,\n \"documents-watermark-text\": null,\n \"investment-sales-broker\": null,\n \"created-at-utc\": \"2020-06-09T18:10:59.805711\",\n \"notes\": null,\n \"engineer\": null,\n \"zip-code\": null,\n \"flood-insurance-provider\": null,\n \"appraiser\": null,\n \"co-insurance-2-title-company\": null,\n \"co-insurance-3-underwriter-name\": null,\n \"co-insurance-3-title-policy-number\": null\n }\n }\n}\n"}],"_postman_id":"1869adf1-8c80-47a7-b605-3da8117446a0"},{"name":"Returns room notifications settings","id":"182090fc-43f4-4f20-87d0-e1f1af450a46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/rooms/:room_id/notifications-settings","urlObject":{"path":["api","v2","rooms",":room_id","notifications-settings"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"03e43be6-e01d-44ae-a2ed-1368f25af899","type":"string","value":"1","key":"room_id"}]}},"response":[{"id":"99e2adbc-eff6-4cbf-bc1a-f086a44bfa66","name":"Returns room notifications settings","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id/notifications-settings","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id","notifications-settings"],"variable":[{"key":"room_id","type":"string","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 16 Jun 2020 07:58:30 GMT"},{"key":"content-length","value":"541"},{"key":"set-cookie","value":"_prodeal360=SFMyNTY.g3QAAAAGbQAAAAxhY2Nlc3NfdG9rZW5kAANuaWxtAAAACmV4cGlyZXNfaW5kAANuaWxtAAAADHJlZGlyZWN0X3VybGQAA25pbG0AAAANcmVmcmVzaF90b2tlbmQAA25pbG0AAAASc2Vzc2lvbl90aW1lb3V0X2F0Yl7pzSZtAAAAB3VzZXJfaWRhAQ.7EmyW_t9GEhGROjcT2_GLxmY4iW2k2obbiaezVpZ-o0; path=/; HttpOnly"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2ocfef8ndiq01ulaf40002e1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"room-notifications-settings\",\n \"id\": \"1\",\n \"attributes\": {\n \"new-line-item-note\": {\n \"realtime\": \"all\",\n \"daily-recap\": true\n },\n \"line-item-status-changed\": {\n \"realtime\": \"my_responsibility\",\n \"daily-recap\": false\n },\n \"file-version-upload\": {\n \"realtime\": \"all\",\n \"daily-recap\": true\n },\n \"document-approved\": {\n \"realtime\": \"none\",\n \"daily-recap\": true\n },\n \"custom-column-updated\": {\n \"realtime\": \"none\",\n \"daily-recap\": true\n },\n \"checklist-item-deletion\": {\n \"realtime\": \"none\",\n \"daily-recap\": true\n },\n \"access-changed\": {\n \"realtime\": \"none\",\n \"daily-recap\": true\n }\n }\n }\n}"},{"id":"da8ffad8-a16c-4306-a192-5b2897b2c729","name":"Returns a room","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id"],"variable":[{"key":"room_id","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Thu, 04 Apr 2019 13:41:21 GMT"},{"key":"content-length","value":"2528"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2m94ibdhtfqmc90et8001401"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"team\",\n \"id\": \"2\",\n \"attributes\": {\n \"type-name\": \"Buyer\",\n \"role-id\": \"host_admin\",\n \"name\": \"Capital Bancshares\",\n \"is-member\": true,\n \"abbreviation\": \"CBA\"\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"4\",\n \"attributes\": {\n \"type-name\": \"Seller\",\n \"role-id\": \"admin\",\n \"name\": \"Trustcorp Financial\",\n \"is-member\": false,\n \"abbreviation\": \"TFI\"\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"6\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"role-id\": \"guest\",\n \"name\": \"Azure Trust\",\n \"is-member\": false,\n \"abbreviation\": \"AZT\"\n }\n }\n ],\n \"data\": {\n \"type\": \"room\",\n \"relationships\": {\n \"workspace\": {\n \"data\": null\n },\n \"parties\": {\n \"data\": [\n {\n \"type\": \"team\",\n \"id\": \"2\"\n },\n {\n \"type\": \"team\",\n \"id\": \"4\"\n },\n {\n \"type\": \"team\",\n \"id\": \"6\"\n }\n ]\n },\n \"creator\": {\n \"data\": {\n \"type\": \"user\",\n \"id\": \"3\"\n }\n }\n },\n \"meta\": {\n \"link\": \"https://prodeal360.com/dashboard/2\"\n },\n \"id\": \"2\",\n \"attributes\": {\n \"construction-loan-amount\": null,\n \"lender\": null,\n \"agent-1031\": null,\n \"co-insurance-1-title-number\": null,\n \"mortgage-broker\": null,\n \"custom-column-label\": \"Custom\",\n \"co-insurance-percentage\": null,\n \"seller-counsel\": null,\n \"actual-close-date\": null,\n \"additional-information\": null,\n \"co-insurance-1-percentage\": null,\n \"co-insurance-2-underwriter-name\": null,\n \"building-type\": null,\n \"advisor\": null,\n \"user-team-abbreviation\": \"CBA\",\n \"co-insurance-1-underwriter-name\": null,\n \"metadata\": {},\n \"notes-enabled\": true,\n \"lng\": null,\n \"lender-counsel\": null,\n \"co-insurance-3-title-company\": null,\n \"purchase-amount\": null,\n \"city\": \"Manhattan\",\n \"room-details-flag-enabled\": false,\n \"name\": \"Confidential Room\",\n \"state\": \"open\",\n \"co-insurance-2-title-policy-number\": null,\n \"co-insurance-1-title-company\": null,\n \"purchaser\": null,\n \"completed-percentage\": 0.0,\n \"role-id\": \"host_admin\",\n \"creator-party-id\": null,\n \"user-team-type\": \"Buyer\",\n \"co-insurance-1-title-policy-number\": null,\n \"custom-column-enabled\": false,\n \"loan-amount\": null,\n \"mezzanine-loan-amount\": null,\n \"property-and-casuality-insurance-provider\": null,\n \"surveyor\": null,\n \"co-insurance-2-percentage\": null,\n \"favorite\": false,\n \"lat\": null,\n \"total-transaction-amount\": null,\n \"changelog-enabled\": true,\n \"address-autocomplete\": null,\n \"unread-notes-count\": 0,\n \"borrower\": null,\n \"address\": \"Broadway 1384\",\n \"other-financing-amount\": null,\n \"second-mortgage-loan-amount\": null,\n \"permission-type\": \"confidential\",\n \"property-manager\": null,\n \"lead-title-company\": null,\n \"room-type\": \"Real Estate - Acquisition\",\n \"borrower-counsel\": null,\n \"country\": null,\n \"user-team-name\": \"Capital Bancshares\",\n \"unseen-changelog-entries-count\": 1,\n \"co-insurance-3-title-number\": null,\n \"purchaser-counsel\": null,\n \"seller\": null,\n \"co-insurance-3-percentage\": null,\n \"nick-name\": null,\n \"co-insurance-2-title-number\": null,\n \"unread-docs-count\": 0,\n \"estimated-close-date\": \"Aug 15, 2017\",\n \"title-number\": null,\n \"prodeal-number\": \"D-000-0002\",\n \"underwriter-name\": null,\n \"title-policy-number\": null,\n \"investment-sales-broker\": null,\n \"notes\": \"Some notes over here.\",\n \"engineer\": null,\n \"zip-code\": null,\n \"flood-insurance-provider\": null,\n \"appraiser\": null,\n \"co-insurance-2-title-company\": null,\n \"co-insurance-3-underwriter-name\": null,\n \"co-insurance-3-title-policy-number\": null,\n \"folders-inbox-enabled\": false\n }\n }\n}"}],"_postman_id":"182090fc-43f4-4f20-87d0-e1f1af450a46"},{"name":"Update room notifications settings","id":"dde38f87-24dd-47ea-8acc-68e99a12f6a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user-notifications-settings\",\n \"attributes\": {\n \"new-line-item-note\": {\n \"realtime\": \"all\",\n \"daily_recap\": true\n },\n \"line-item-status-changed\": {\n \"realtime\": \"all\",\n \"daily_recap\": false\n },\n \"file-version-upload\": {\n \"realtime\": \"all\",\n \"daily_recap\": true\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/rooms/:room_id/notifications-settings","description":"The metadata attribute is an object that contains the fields in a key/value way.
\nValues cannot be null, all the keys with null values will be ignored.
\nTo add or update a metadata entry, send an object with the desired key/value.
\nTo delete an entry, send an object with the key assigned to null.
\nExample:
\nTo delete the metadata field external_id:
...\n \"metadata\": {\n \"external_id\": null\n },\n ...\nOnly accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/rooms/:room_id","description":"Endpoints for managing rooms.
\n","_postman_id":"aa405a2d-b878-4d2a-acfc-28777aee8aff"},{"name":"Custom Room Attributes","item":[{"name":"Custom Room Attribute Definitions","item":[{"name":"Get available custom attributes","id":"317dcd7c-5536-473a-bdd5-6f2402bad30f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/custom-room-attribute-templates","description":"Returns all custom attributes that are available in the current user's organization.
\nOnly Organization admins can see the available custom attributes.
\n","urlObject":{"path":["api","v2","custom-room-attribute-templates"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"4a12d4e1-96c3-409b-b505-3bfae3dbdf21","name":"Get custom attribute definitions success","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/custom-room-attribute-templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"247"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"1\",\n \"attributes\": {\n \"label\": \"Custom field 1\",\n \"hidden\": false\n }\n },\n {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"2\",\n \"attributes\": {\n \"label\": \"Custom field 2\",\n \"hidden\": false\n }\n }\n ]\n}"}],"_postman_id":"317dcd7c-5536-473a-bdd5-6f2402bad30f"},{"name":"Get available custom attributes for a room","id":"d5b550f2-c3f5-4751-9cf8-54fb4548b3ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/rooms/:room_id/relationships/custom-room-attribute-templates","description":"Returns all custom attributes that are available for the specified room.
\nOnly Organization admins that are invited to the room, can see the available custom attributes for that room.
\n","urlObject":{"path":["api","v2","rooms",":room_id","relationships","custom-room-attribute-templates"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"674160ba-b5cf-4f07-9c08-f3ab48a44249","type":"string","value":"2","key":"room_id"}]}},"response":[{"id":"a42177f5-039c-4073-a43e-8884c07676ea","name":"Get room attribute templates success","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id/relationships/custom-room-attribute-templates","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id","relationships","custom-room-attribute-templates"],"variable":[{"key":"room_id","value":"2","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"887"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"1\",\n \"attributes\": {\n \"label\": \"Agent\",\n \"hidden\": true\n }\n },\n {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"2\",\n \"attributes\": {\n \"label\": \"1st Mortgage Loan Amount\",\n \"hidden\": true\n }\n }\n ]\n}"}],"_postman_id":"d5b550f2-c3f5-4751-9cf8-54fb4548b3ca"},{"name":"Create custom room attribute","id":"68544f52-6eb5-4e0a-94ca-457e74afd22a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\": \"custom-room-attribute-template\",\n\t\t\"attributes\": {\n\t\t\t\"label\": \"label-1\"\n\t\t}\n\t}\n}\n"},"url":"http://localhost:4000//api/v2/custom-room-attribute-templates","description":"Only Organization admins can define custom attributes.
\n","urlObject":{"path":["api","v2","custom-room-attribute-templates"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"c141dcc2-013f-4c86-a070-51ae0d77a441","name":"Custom attribute template created","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\": \"custom-room-attribute-template\",\n\t\t\"attributes\": {\n\t\t\t\"label\": \"label-1\"\n\t\t}\n\t}\n}\n"},"url":"http://localhost:4000//api/v2/custom-room-attribute-templates"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"137"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"1\",\n \"attributes\": {\n \"label\": \"label-1\",\n \"hidden\": false\n }\n }\n}"}],"_postman_id":"68544f52-6eb5-4e0a-94ca-457e74afd22a"},{"name":"Update custom room attribute","id":"bda72b61-71db-43e4-8334-ef3b9e8d0273","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\": \"custom-room-attribute-template\",\n\t\t\"attributes\": {\n\t\t\t\"label\": \"label_a_updated\"\n\t\t}\n\t}\n}"},"url":"http://localhost:4000//api/v2/custom-room-attribute-templates/:id","description":"Only Organization admins can update custom attributes definitions.
\n","urlObject":{"path":["api","v2","custom-room-attribute-templates",":id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"b0b9d5eb-f94f-476d-afa3-775d3e8198a1","type":"string","value":"1","key":"id"}]}},"response":[{"id":"055dc0f9-8ce4-4849-91cc-5497d859f3d6","name":"Custom attribute template updated","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\": \"custom-room-attribute-template\",\n\t\t\"attributes\": {\n\t\t\t\"label\": \"label_a_updated\"\n\t\t}\n\t}\n}"},"url":{"raw":"http://localhost:4000//api/v2/custom-room-attribute-templates/:id","host":["http://localhost:4000/"],"path":["api","v2","custom-room-attribute-templates",":id"],"variable":[{"key":"id","value":"1","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"145"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"1\",\n \"attributes\": {\n \"label\": \"label_a_updated\",\n \"hidden\": false\n }\n }\n}"}],"_postman_id":"bda72b61-71db-43e4-8334-ef3b9e8d0273"},{"name":"Delete custom room attribute","id":"9bcac9a7-accc-499c-ada8-d5c902f006ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Return JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/custom-room-attribute-templates/:id","description":"Only Organization admins can delete custom attributes.
\n","urlObject":{"path":["api","v2","custom-room-attribute-templates",":id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"235c027c-c831-4c46-b2ef-b2137ce57a2a","type":"string","value":"1","key":"id"}]}},"response":[{"id":"1f63f625-c458-4b86-a2e3-7d354a50dac9","name":"Custom attribute template deleted","originalRequest":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:4000//api/v2/custom-room-attribute-templates/:id","host":["http://localhost:4000/"],"path":["api","v2","custom-room-attribute-templates",":id"],"variable":[{"key":"id","value":"1","type":"string"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9bcac9a7-accc-499c-ada8-d5c902f006ea"}],"id":"62add66c-c49f-4a70-9533-b27cd5013340","description":"The set of endpoints used to view and define available room custom attributes.
\n","_postman_id":"62add66c-c49f-4a70-9533-b27cd5013340"},{"name":"Custom Room Attribute Values","item":[{"name":"Get custom attributes and their values for a room","id":"629016ac-207c-41d6-9b54-3e89ec72c912","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/rooms/:room_id/custom-room-attributes ","description":"By default, custom attribute definitions (templates) are included.\nIf no attributes were set for that room, the response will return an empty array, and no includes.
\n","urlObject":{"path":["api","v2","rooms",":room_id","custom-room-attributes "],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"7e24f799-5a13-4e95-a67d-90d390df6ae5","type":"string","value":"2","key":"room_id"}]}},"response":[{"id":"0628ce45-19f5-4f5e-9046-b41526e39cc0","name":"Custom attribute values exist","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id/custom-room-attributes ","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id","custom-room-attributes "],"variable":[{"key":"room_id","type":"string","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"208"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"314\",\n \"attributes\": {\n \"label\": \"Custom attribute 1\",\n \"hidden\": false\n }\n },\n {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"315\",\n \"attributes\": {\n \"label\": \"Custom attribute 2\",\n \"hidden\": false\n }\n }\n ],\n \"data\": [\n {\n \"type\": \"custom-room-attribute\",\n \"relationships\": {\n \"custom-room-attribute-template\": {\n \"data\": {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"314\"\n }\n }\n },\n \"id\": \"55\",\n \"attributes\": {\n \"value\": \"value 1\"\n }\n },\n {\n \"type\": \"custom-room-attribute\",\n \"relationships\": {\n \"custom-room-attribute-template\": {\n \"data\": {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"315\"\n }\n }\n },\n \"id\": \"56\",\n \"attributes\": {\n \"value\": \"value 2\"\n }\n }\n ]\n}"},{"id":"68cec5c0-ac41-471c-b0f6-d4b8fc3355fd","name":"Custom attribute values not set","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id/custom-room-attributes ","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id","custom-room-attributes "],"variable":[{"key":"room_id","type":"string","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"39"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": []\n}"}],"_postman_id":"629016ac-207c-41d6-9b54-3e89ec72c912"},{"name":"Set value for custom attribute in a room","id":"fee7394a-6a26-4aad-a258-354ca36f9f70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\": \"custom-room-attribute\",\n\t\t\"attributes\": {\n\t\t\t\"deal-id\": 2,\n\t\t\t\"value\": \"value-2\"\n\t\t},\n\t\t\"relationships\": {\n\t\t\t\"custom-room-attribute-template\": {\n\t\t\t\t\"data\": {\n\t\t\t\t\t\"type\": \"custom-room-attribute-template\", \n\t\t\t\t\t\"id\": 314\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n"},"url":"http://localhost:4000//api/v2/rooms/:room_id/custom-room-attributes","description":"Use this endpoint to set the value for the custom attribute if it doesn't already exist in that room.
\nBy default, custom attribute definitions are included.
\nError 422 is returned if a value for the custom attribute has already been set.
Only room Hosts can update custom attribute values.
\n","urlObject":{"path":["api","v2","rooms",":room_id","custom-room-attributes"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"edd2d4a5-7680-4747-96e3-3d43a114517f","type":"string","value":"2","key":"room_id"}]}},"response":[{"id":"321dda5a-e7b1-4b0d-9984-a1aa1cf0de40","name":"Custom attribute value created","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\": \"custom-room-attribute\",\n\t\t\"attributes\": {\n\t\t\t\"deal-id\": 2,\n\t\t\t\"value\": \"value-1\"\n\t\t},\n\t\t\"relationships\": {\n\t\t\t\"custom-room-attribute-template\": {\n\t\t\t\t\"data\": {\n\t\t\t\t\t\"type\": \"custom-room-attribute-template\", \n\t\t\t\t\t\"id\": 314\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n"},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id/custom-room-attributes","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id","custom-room-attributes"],"variable":[{"key":"room_id","value":"2","type":"string"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"183"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"314\",\n \"attributes\": {\n \"label\": \"Custom attribute 1\",\n \"hidden\": false\n }\n }\n ],\n \"data\": {\n \"type\": \"custom-room-attribute\",\n \"relationships\": {\n \"custom-room-attribute-template\": {\n \"data\": {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"314\"\n }\n }\n },\n \"id\": \"57\",\n \"attributes\": {\n \"value\": \"value-1\"\n }\n }\n}"},{"id":"bdf445dc-a8c9-47c5-b3bb-f2e5bae514eb","name":"Custom attribute value already set","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\": \"custom-room-attribute\",\n\t\t\"attributes\": {\n\t\t\t\"deal-id\": 2,\n\t\t\t\"value\": \"value-2\"\n\t\t},\n\t\t\"relationships\": {\n\t\t\t\"custom-room-attribute-template\": {\n\t\t\t\t\"data\": {\n\t\t\t\t\t\"type\": \"custom-room-attribute-template\", \n\t\t\t\t\t\"id\": 314\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n"},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id/custom-room-attributes","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id","custom-room-attributes"],"variable":[{"key":"room_id","value":"2","type":"string"}]}},"status":"Unprocessable Entity","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"237"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"errors\": [\n {\n \"title\": \"has already been taken\",\n \"status\": \"422\",\n \"source\": {\n \"pointer\": \"data/attributes/custom-room-attribute-template\"\n },\n \"detail\": \"Custom room attribute template has already been taken\",\n \"code\": null\n }\n ]\n}"}],"_postman_id":"fee7394a-6a26-4aad-a258-354ca36f9f70"},{"name":"Update value for custom attribute in a room","id":"a0615d2d-48a2-442e-81c8-168ec92dae2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\": \"custom-room-attribute\",\n\t\t\"attributes\": {\n\t\t\t\"value\": \"2\"\n\t\t}\n }\n}"},"url":"http://localhost:4000//api/v2/rooms/:room_id/custom-room-attributes/:id","description":"Use this endpoint to change the existing value for the custom attribute in a room.
\nBy default, custom attribute definitions are included.
\nOnly room Hosts can update custom attribute values.
\n","urlObject":{"path":["api","v2","rooms",":room_id","custom-room-attributes",":id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"6b6c8676-ae73-4648-b58f-c3d07435ba6e","type":"string","value":"2","key":"room_id"},{"id":"cb2047aa-aac8-4e92-8659-94d5bcf39291","type":"string","value":"1","key":"id"}]}},"response":[{"id":"fbf2e598-d4e0-4012-884d-48530a23690e","name":"Custom attribute value updated","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n\t\"data\": {\n\t\t\"type\": \"custom-room-attribute\",\n\t\t\"attributes\": {\n\t\t\t\"value\": \"2\"\n\t\t}\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id/custom-room-attributes/:id","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id","custom-room-attributes",":id"],"variable":[{"key":"room_id","type":"string","value":"2"},{"key":"id","type":"string","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"180"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"314\",\n \"attributes\": {\n \"label\": \"Custom attribute 1\",\n \"hidden\": false\n }\n }\n ],\n \"data\": {\n \"type\": \"custom-room-attribute\",\n \"relationships\": {\n \"custom-room-attribute-template\": {\n \"data\": {\n \"type\": \"custom-room-attribute-template\",\n \"id\": \"314\"\n }\n }\n },\n \"id\": \"1\",\n \"attributes\": {\n \"value\": \"2\"\n }\n }\n}"}],"_postman_id":"a0615d2d-48a2-442e-81c8-168ec92dae2a"},{"name":"Remove value for custom attribute in a room","id":"22dd2997-b60d-42ea-af69-223863109d8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/rooms/:room_id/custom-room-attributes/:id","description":"Only room Hosts can update custom attribute values.
\n","urlObject":{"path":["api","v2","rooms",":room_id","custom-room-attributes",":id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"a57d60d4-4ba0-4bc3-85be-e559f6952be3","type":"string","value":"2","key":"room_id"},{"id":"06300216-4f0d-4424-bbfa-07be7e55602f","type":"string","value":"1","key":"id"}]}},"response":[{"id":"0c0e0d0e-210c-4197-8588-9f5ebac9bdae","name":"Custom room attribute removed","originalRequest":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:4000//api/v2/rooms/:room_id/custom-room-attributes/:id","host":["http://localhost:4000/"],"path":["api","v2","rooms",":room_id","custom-room-attributes",":id"],"variable":[{"key":"room_id","value":"755","type":"string"},{"key":"id","value":"55","type":"string"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"22dd2997-b60d-42ea-af69-223863109d8b"}],"id":"6750b3f7-7d75-43d0-a9c5-c66549f1e798","description":"The set of endpoints used to read and update values of custom attributes for each room.
\n","_postman_id":"6750b3f7-7d75-43d0-a9c5-c66549f1e798"}],"id":"8c0d3faa-e02f-4b93-8078-3df62d88caca","description":"Custom attributes contain additional information about a room. They can contain any value the user sets.
\n","event":[{"listen":"prerequest","script":{"id":"ff28bcff-31a7-4e5e-be95-49a64514df2a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5117303d-05a2-4c1a-ab9b-601def67a4e1","type":"text/javascript","exec":[""]}}],"_postman_id":"8c0d3faa-e02f-4b93-8078-3df62d88caca"},{"name":"Export","item":[{"name":"Export rooms to CSV","id":"59332762-bafd-460f-8c8e-e009a7ee0cb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/rooms/export-csv","description":"Returns .csv file with all rooms that belong to the organization.
\nOnly Organization admins can create this report.
\n","urlObject":{"path":["api","v2","rooms","export-csv"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"0ae66e11-833f-46a1-824b-9f843e1db6aa","name":"Export rooms to csv","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/rooms/export-csv"},"status":"OK","code":200,"_postman_previewlanguage":"raw","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Thu, 26 Dec 2019 09:22:18 GMT"},{"key":"content-length","value":"471"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2nhu2qe5dlah0ugg0o002ha1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"content-type","value":"application/csv; charset=utf-8"},{"key":"content-disposition","value":"attachment; filename=rooms.csv"}],"cookie":[],"responseTime":null,"body":"id,name,inserted_at,state,type,estimated_close_date,actual_close_date,total_transaction_amount,permission_type,additional_information,prodeal_number,completed_percentage,label-a,label-c,external_id,metatata\r\n1,Open Room,2019-12-20 15:11:01.545158,open,real_estate_-_acquisition,2017-08-15,,,open,,D-000-0001,0,value1,asasas,123456,\r\n2,Confidential Room,2019-12-20 15:11:01.550992,open,real_estate_-_acquisition,2017-08-15,,,confidential,,D-000-0002,0,value2,,666,ekstra\r\n"}],"_postman_id":"59332762-bafd-460f-8c8e-e009a7ee0cb8"},{"name":"Room PDF export","id":"88d07ada-7e05-485d-a6e4-8a3af8a600d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/rooms/:id/export","urlObject":{"path":["api","v2","rooms",":id","export"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"d8d6c472-c88f-46cd-ab35-53631b4c9c8d","type":"string","value":"2","key":"id"}]}},"response":[{"id":"02ff09da-f646-4d58-8300-ee7cf30d462f","name":"Room pdf export","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"url":{"raw":"http://localhost:4000//api/v2/rooms/:id/export","host":["http://localhost:4000/"],"path":["api","v2","rooms",":id","export"],"variable":[{"key":"id","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Wed, 22 Jan 2020 10:03:13 GMT"},{"key":"content-length","value":"946"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2nm2qk5qm6fr0e7phg003vu4"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":" %PDF-1.\n trailer<>]>>>>>>"}],"_postman_id":"88d07ada-7e05-485d-a6e4-8a3af8a600d3"},{"name":"Room XLSX export","id":"30ae21d1-d475-4ad7-ad70-b71ed856e2bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/rooms/:id/export/xlsx?type=checklist","urlObject":{"path":["api","v2","rooms",":id","export","xlsx"],"host":["http://localhost:4000/"],"query":[{"key":"type","value":"checklist"}],"variable":[{"id":"d8d6c472-c88f-46cd-ab35-53631b4c9c8d","type":"string","value":"2","key":"id"}]}},"response":[{"id":"1f3708fd-3d79-408e-be59-10d34db407d5","name":"Room pdf export","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"url":{"raw":"http://localhost:4000//api/v2/rooms/:id/export","host":["http://localhost:4000/"],"path":["api","v2","rooms",":id","export"],"variable":[{"key":"id","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Wed, 22 Jan 2020 10:03:13 GMT"},{"key":"content-length","value":"946"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2nm2qk5qm6fr0e7phg003vu4"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":" %PDF-1.\n trailer<>]>>>>>>"}],"_postman_id":"30ae21d1-d475-4ad7-ad70-b71ed856e2bb"},{"name":"Request a bulk a download","id":"11d72c77-aac6-4b41-b421-b319a3651742","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"room-bulk-download\",\n \"attributes\": {\n \"without-folders\": false,\n \"send-email\": false,\n \"download-compatible-mode\": true,\n \"selection\": [\n \"d_120613\",\n \"f_11786\",\n \"f_11785\"\n ],\n \"download-originals\": false,\n\t\t\"callback-url\": \"https://mydomain.com/download_callback\"\n },\n \"relationships\": {\n \"room\": {\n \"data\": {\n \"id\": 836,\n \"type\": \"room\"\n }\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/room-bulk-downloads","description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/room-bulk-downloads/:bulk_download_id","urlObject":{"path":["api","v2","room-bulk-downloads",":bulk_download_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"eaeba651-0d6b-4869-98e6-9006a2f7a008","type":"string","value":"4","key":"bulk_download_id"}]}},"response":[{"id":"5f11c000-83b1-463d-9d65-ee0f682f4755","name":"Get a bulk download request information","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"url":{"raw":"http://localhost:4000//api/v2/room-bulk-downloads/:bulk_download_id","host":["http://localhost:4000/"],"path":["api","v2","room-bulk-downloads",":bulk_download_id"],"variable":[{"key":"bulk_download_id","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 03 Nov 2020 02:53:03 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"284"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=birjgS5muhBZWfIuUQwIv50fcv5Fcay+rp3dHBIyFqqA9QYQi2X38oyYYMAR8APGScztx3bVpDNvKVt11ATeTExyTFvGWhNoooFSQuTfxYrPd2Wrzccgjg4sgfW4; Expires=Tue, 10 Nov 2020 02:53:03 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=birjgS5muhBZWfIuUQwIv50fcv5Fcay+rp3dHBIyFqqA9QYQi2X38oyYYMAR8APGScztx3bVpDNvKVt11ATeTExyTFvGWhNoooFSQuTfxYrPd2Wrzccgjg4sgfW4; Expires=Tue, 10 Nov 2020 02:53:03 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"nginx"},{"key":"content-encoding","value":"gzip"},{"key":"set-cookie","value":"_prodeal360=session_rEplJdKQ3xyKUGiICNT4CoTVdo/LjFTiQ+KxT3yDImDDd/P343oS1xtkd+0ReAwmsZp6ugTEmHXfpKDjMBYZkg86AKO1mqq11c5FLBEQxt5lKfzuMZ5RkSP+FbJdZc98; path=/; domain=sandbox.prodeal.dev; secure; HttpOnly"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"FkPf0ZIq3W1EKbYAAA7B"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"room-bulk-download\",\n \"id\": \"4\",\n \"attributes\": {\n \"without-folders\": false,\n \"updated-at\": \"2020-11-03T02:51:59.493517\",\n \"send-email\": false,\n \"selection\": [\n \"d_120613\",\n \"f_11786\",\n \"f_11785\"\n ],\n \"only-final\": null,\n \"inserted-at\": \"2020-11-03T02:51:59.214982\",\n \"download-url\": \"https://sandbox.prodeal.dev/s/rbLvxYx_LuE\",\n \"download-originals\": false,\n \"callback-url\": \"https://mydomain.com/download_callback\"\n }\n }\n}"}],"_postman_id":"a7e29bd0-3ba6-4f47-89ac-9252102eed35"}],"id":"4e0a781f-7f29-45eb-a9b5-a6c078c5ebf5","_postman_id":"4e0a781f-7f29-45eb-a9b5-a6c078c5ebf5","description":""},{"name":"Get room settings","id":"07b63305-26f6-48c3-a431-eb71fb53e482","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/rooms/:room_id","description":"Available \"include\" options:
\norganizationcreatorwhitelisted_organizationsparties (teams)workspaceBy default, if nothing is specified, teams are included. However, if the include parameter is added, then only the specified entities are included.
A room is a root level object of your deal's data structure. Rooms contain checklists that contain folders and files.
\nA room has 2 sets of properties: fixed (always exist in all rooms) and custom (user-defined, per organization).
\nid - ID (auto-generated, read-only)prodeal-number - ProDeal Number (auto-generated, read-only)created-at-utc - Room Created Date (auto-generated, read-only)name - Room Name (required; 50 characters max)room-type - Room Type (required)total-transaction-amount - Total Transaction Amountbuilding-type - Asset Typeestimated-close-date - Estimated Closing Dateactual-close-date - Closed Datestate - Room status: active or inactive. While a room is inactive, documents cannot be deleted and email notifications are no longer sent.org-private - Private room. When \"Private room\" is on, only members of the room's organization can get an invite to the room.custom-column-enabled - Custom column. When enabled, an additional column will appear in the checklist's column switcher.custom-column-label - Custom column label (20 characters max)changelog-enabled - Activity report. This tracks all activities happening in the room.folders-inbox-enabled - Email-to-folder. Allow sending emails with attachments directly to a folder.documents-watermark-enabled - Documents watermark. When enabled, all documents will be converted to PDF on upload and watermarked when viewed and downloaded.documents-watermark-text - Custom documents watermark text that will appear on PDFs. (50 characters max)notes-enabled - When turned off, users will not be able to communicate about checklist items via notes.permission-type - Checklist Access Management: \"open\" or \"confidential\" (read-only, set during the room creation. \"confidential\" by default.)To assign custom values to rooms, you can use either custom room attributes or metadata property.
Use custom room attributes to define a set of properties that can be used in all rooms within one organization. (preferred)
\nUse metadata to assign a specific key/value information to only one room.
\n","event":[{"listen":"prerequest","script":{"id":"fcc964fc-3dae-4f23-8655-1d6d42c1843d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"64d868cc-0d7c-4670-bbea-528185e95f19","type":"text/javascript","exec":[""]}}],"_postman_id":"c762a5c8-481c-4278-9bfc-00ae59bea284"},{"name":"Workspaces","item":[{"name":"Get all workspaces","id":"5cf55c35-c72c-44c9-8ed4-ba8dcc1be191","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/workspaces?filter[workspace]=room_only&include=rooms,rooms.parties&filter[state]=open","description":"workspace: view_type (member_only, room_only)
member_only returns only those workspaces where user is a member (default)room_only returns only those workspaces in which user has roomsbookmarked: Favorite deals.\nCan take values true or false.
search_term: A string containing terms to search
\nstate: Active/inactive deals.\nCan take values \"open\" or \"closed\".
room_type: The Room type. Can take the next values:
\nreal_estate_-_acquisition for Real Estate - Acquisitionreal_estate_-_refinance for Real Estate - Refinancereal_estate_-_development for Real Estate - Developmentreal_estate_-_asset_management for Real Estate - Asset Managementreal_estate_-_leasing for Real Estate - Leasingreal_estate_-_syndication for Real Estate - Syndicationreal_estate_-_leasehold for Real Estate - Leasehold real_estate_-_syndication for Real Estate - Financing/Refinancing real_estate_-_disposition for Real Estate - Dispositionreal_estate_-_other for Real Estate - Otherenergy for Energyinfrastructure for Infrastructureaviation for Aviationcorporate for Corporatelitigation for Litigationlitigation_financing for Litigation Financingother for Otherbuilding_type: A string accepting some of the next values:
\nHospitalityIndustrialLandMixed-UseMultifamilyOfficeRetailSelf-StorageSingle Family HomeSpecialty UseStudent HousingAvailable \"include\" options:
\nrooms)rooms.parties)Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/workspaces/:workspace_id?filter[workspace]=room_only&include=rooms,rooms.parties&filter[state]=open","description":"workspace: view_type (member_only, room_only)
member_only returns only those workspaces where user is a member (default)room_only returns only those workspaces in which user has roomsbookmarked: Favorite deals.\nCan take values true or false.
search_term: A string containing terms to search
\nstate: Active/inactive deals.\nCan take values \"open\" or \"closed\".
room_type: for rooms that have specific type. List of available labels can be fetched via api/v2/room-types
building_type: A string accepting some of the next values:
\nHospitalityIndustrialLandMixed-UseMultifamilyOfficeRetailSelf-StorageSingle Family HomeSpecialty UseStudent HousingAvailable \"include\" options:
\nrooms)rooms.parties)Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"workspace\",\n \"attributes\": {\n \"name\": \"name goes here\",\n \"description\": \"description goes here\",\n \"metadata\": {\n \"meta_field\": \"meta_value\"\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/workspaces","description":"The only required field is the name.
The metadata attribute is an object that contains the fields in a key/value way.
\nValues cannot be null, all keys with null values will be ignored.
\nOnly Workspace users can manage workspaces.
\n","urlObject":{"path":["api","v2","workspaces"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"df635f5c-622f-4496-8047-235eb5766a63","name":"Create Workspace success","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"workspace\",\n \"attributes\": {\n \"name\": \"this is the name\",\n \"description\": \"this is the description\",\n \"metadata\": {\n\t \"meta_field\": \"meta_value\"\n\t }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/workspaces"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Fri, 22 Mar 2019 17:14:36 GMT"},{"key":"content-length","value":"114"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"2m75ehbeqk6u8v2c70001jg1"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"data\": {\n \"type\": \"workspace\",\n \"id\": \"3\",\n \"attributes\": {\n \"name\": \"this is the name\",\n \"description\": \"this is the description\",\n \"metadata\": {\n\t\t\t\t\"meta_field\": \"meta_value\"\n\t\t\t}\n }\n }\n}"}],"_postman_id":"78398810-55d8-4379-8264-ab127571538d"},{"name":"Update workspace","id":"245203b3-7d3a-4ecf-881c-be30cec50c8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n\t\"id\": \"5\",\n \"type\": \"workspace\",\n \"attributes\": {\n \"name\": \"updated name\",\n \"description\": \"updated description\",\n \"metadata\": {\n \"meta_field\": \"meta_value\"\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/workspaces/:workspace_id","description":"Note: To update room-workspace relationship, use this endpoint.
\nThe metadata attribute is an object that contains the fields in a key/value way.
\nValues cannot be null, all keys with null values will be ignored.
\nTo add or update a metadata entry, send an object with desired key/value.
\nTo delete an entry, send an object with key assigned to null. Example:
\n{\n \"data\": {\n \"id\": \"5\",\n \"type\": \"workspace\",\n \"attributes\": {\n \"metadata\": {\n \"external_id\": null\n }\n }\n }\n}\nOnly Workspace users can manage workspaces.
\n","urlObject":{"path":["api","v2","workspaces",":workspace_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"3a119cd3-2bba-4c1e-82ae-40c098262632","type":"string","value":"5","key":"workspace_id"}]}},"response":[{"id":"f811d82d-893b-4f07-91f9-d2b510e92feb","name":"Update Workspace","originalRequest":{"method":"PUT","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n\t\"id\": \"5\",\n \"type\": \"workspace\",\n \"attributes\": {\n \"name\": \"updated name\",\n \"description\": \"updated description\",\n \"metadata\": {\n \"meta_field\": \"foo\"\n }\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/workspaces/:workspace_id","host":["http://localhost:4000/"],"path":["api","v2","workspaces",":workspace_id"],"variable":[{"key":"workspace_id","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Fri, 22 Mar 2019 18:43:05 GMT"},{"key":"content-length","value":"139"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"2m75o6a9l2fmold5n0001jq1"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"data\": {\n \"type\": \"workspace\",\n \"id\": \"5\",\n \"attributes\": {\n \"name\": \"updated name\",\n \"description\": \"updated description\",\n \"metadata\": {\n \"meta_field\": \"foo\"\n }\n }\n }\n}"}],"_postman_id":"245203b3-7d3a-4ecf-881c-be30cec50c8b"}],"id":"733ea57d-1161-4e93-9993-19911a140e1d","description":"Rooms can be organized in workspaces. Workspace is a named group of rooms.
\nWorkspaces have:
\nid - ID (auto-generated, read-only)inserted-at - Creation date (auto-generated, read-only)name - Name (required)description - Descriptionmetadata - MetadataOnly accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/checklists/:room_id","description":"Even though a checklist has a tree-like structure, in the response it is flattened - all items (headings, line items, folders and documents) appear in one array.
\nEvery item has an array of parents (all containing folders), as well as a parent property to indicate the direct parent. The deepness property shows the level of nesting in folders. The first-level items (headings) have a deepness of 0. Line items have deepness value 1.
The type property only shows whether an item is a folder or a document.
The folder-type property is used to indicate whether the folder is a heading, line_item, or just a regular folder.
By default, all notes and teams are included, as well as file-versions.
\nopen rooms, users can see all items in the checklist.confidential rooms, users can see only these items their team has access to.Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n { \"type\": \"folder\", \"id\": \"17\" },\n { \"type\": \"folder\", \"id\": \"19\" },\n { \"type\": \"document\", \"id\": \"23\" }\n ]\n}"},"url":"http://localhost:4000//api/v2/checklists/:room_id/items","description":"Using this endpoint, users can delete multiple checklist items at once, no matter the type.
\nIf any of the following errors happen, no items will be deleted.
\n403 error will return.409 with the error code ROOM_INACTIVE will return.403 with error code FINAL_DOCUMENT_DELETION will return.403 with error detail inaccessible_content will return.Every room has a checklist. A checklist is a tree-structure containing all folders and documents in the room.
\nFolders and documents are explained in detail in the sections below.
\n","_postman_id":"7f7782f5-4130-4004-8790-284d6280d558"},{"name":"Folders","item":[{"name":"Create single folder","id":"214d660f-754a-4b8c-bfc1-d6b963a40c3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"folders\",\n \"attributes\": {\n \"folder-type\": \"line_item\",\n \"name\": \"Line Item 1\",\n \"position\": \"heading\",\n \"position-ref\": \"3\"\n },\n \"relationships\": {\n \"responsible-groups\": {\n \"data\": []\n },\n \"parties\": {\n \"data\": [{\n \"id\": \"2\",\n \"type\": \"team\"\n }, {\n \"id\": \"4\",\n \"type\": \"team\"\n }, {\n \"id\": \"6\",\n \"type\": \"team\"\n }]\n },\n \"room\": {\n \"data\": {\n \"id\": 2,\n \"type\": \"room\"\n }\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/folders","description":"Required
\nname: Name (200 characters max)folder-type: Type of the folderOptional
\nposition: Position in the checklistposition-ref: Position referencedue-date: Due date (a date in ISO format)custom-value Value for custom column (255 characters max)headingline_itemfolderheading: at the top of a heading, where position-ref is the heading id (note: no matter the folder type, items added at the top of a heading will always become line items)on: inside (at the top) of a folder, where position-ref is the parent folder idbelow: after a folder (where position-ref is the reference folder id)Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"folders\",\n \"attributes\": {\n \"folder-paths\": [\"/XYZ/foo/bar\", \"/XYZ/dodo\", \"/ZZZ\"],\n \"position-ref\": 476\n },\n \"relationships\": {\n \"responsible-groups\": {\n \"data\": []\n },\n \"parties\": {\n \"data\": [\n \n ]\n },\n \"room\": {\n \"data\": {\n \"id\": 27,\n \"type\": \"room\"\n }\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/folders/via-paths","description":"Required
\nname: Name (200 characters max)folder-type: Type of the folderOptional
\nposition: Position in the checklistposition-ref: Position referencedue-date: Due date (a date in ISO format)custom-value Value for custom column (255 characters max)headingline_itemfolderheading: at the top of a heading, where position-ref is the heading id (note: no matter the folder type, items added at the top of a heading will always become line items)on: inside (at the top) of a folder, where position-ref is the parent folder idbelow: after a folder (where position-ref is the reference folder id)Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":"{\n \"data\": [{\n \"type\": \"folders\",\n \"attributes\": {\n \"folder-type\": \"line_item\",\n \"name\": \"Line Item 1\",\n \"position\": \"heading\",\n \"position-ref\": \"3\"\n },\n \"relationships\": {\n \"responsible-groups\": {\n \"data\": []\n },\n \"parties\": {\n \"data\": [{\n \"id\": \"2\",\n \"type\": \"team\"\n }, {\n \"id\": \"4\",\n \"type\": \"team\"\n }, {\n \"id\": \"6\",\n \"type\": \"team\"\n }]\n },\n \"room\": {\n \"data\": {\n \"id\": 2,\n \"type\": \"room\"\n }\n }\n }\n }, {\n \"type\": \"folders\",\n \"attributes\": {\n \"folder-type\": \"line_item\",\n \"name\": \"Line Item 2\",\n \"position\": \"heading\",\n \"position-ref\": \"3\"\n },\n \"relationships\": {\n \"responsible-groups\": {\n \"data\": []\n },\n \"parties\": {\n \"data\": [{\n \"id\": \"2\",\n \"type\": \"team\"\n }, {\n \"id\": \"4\",\n \"type\": \"team\"\n }, {\n \"id\": \"6\",\n \"type\": \"team\"\n }]\n },\n \"room\": {\n \"data\": {\n \"id\": 2,\n \"type\": \"room\"\n }\n }\n }\n }]\n}"},"url":"http://localhost:4000//api/v2/folders","description":"The same rules apply as in Create single folder endpoint, except folders are sent as an array.
\n","urlObject":{"path":["api","v2","folders"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"db512d29-6a70-4ec0-a12c-a2efc2294ae2","name":"Create multiple folders","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"body":{"mode":"raw","raw":"{\n \"data\": [{\n \"type\": \"folder\",\n \"attributes\": {\n \"name\": \"foo\",\n \"position\": \"on\",\n \"position-ref\": \"6\"\n },\n \"relationships\": {\n \"room\": {\n \"data\": {\n \"type\": \"room\",\n \"id\": \"1\"\n }\n }\n }\n },\n {\n \"type\": \"folder\",\n \"attributes\": {\n \"name\": \"bar\",\n \"position\": \"on\",\n \"position-ref\": \"7\"\n },\n \"relationships\": {\n \"room\": {\n \"data\": {\n \"type\": \"room\",\n \"id\": \"1\"\n }\n }\n }\n }]\n}"},"url":"http://localhost:4000//api/v2/folders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, private, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"name":"content-length","key":"content-length","value":"746","description":"The length of the response body in octets (8-bit bytes)"},{"name":"content-type","key":"content-type","value":"application/vnd.api+json; charset=utf-8","description":"The mime type of this content"},{"name":"date","key":"date","value":"Wed, 30 Jan 2019 19:30:16 GMT","description":"The date and time that the message was sent"},{"name":"server","key":"server","value":"Cowboy","description":"A name for the server"},{"name":"x-request-id","key":"x-request-id","value":"on39nq6am4hoi4rmv0v91vg96ta383q2","description":"Custom header"}],"cookie":[{"expires":"Mon Oct 21 2019 14:12:35 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"881b3cc0-0499-4fe4-acce-fd77dfa4db88","key":"intercom-id-d0rwjug4"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"gabriel%40prodeal360.com","key":"last_email_loggedin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"SFMyNTY.g3QAAAACbQAAAAtfY3NyZl90b2tlbm0AAAAYM1RDYWlNcGlpQ2NrZ2puZnptaks1dz09bQAAAAd1c2VyX2lkYQE.u2F_3ISC_d5_oxXK1SJiRvmgtIHpmWiArz9uMfI1X5Q","key":"_prodeal360_key"}],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"folder\",\n \"id\": \"18\",\n \"attributes\": {\n \"unread\": false,\n \"subscribed\": null,\n \"status\": \"open\",\n \"parents\": [],\n \"parent\": \"f_3\",\n \"new-notes-count\": 0,\n \"name\": \"Line Item 1\",\n \"last-child\": false,\n \"has-notes\": false,\n \"folder-type\": \"line_item\",\n \"first-child\": false,\n \"empty\": false,\n \"due-date\": {\n \"isOverDue\": false,\n \"date\": \"\"\n },\n \"deepness\": 0,\n \"custom-value\": null\n }\n },\n {\n \"type\": \"folder\",\n \"id\": \"17\",\n \"attributes\": {\n \"unread\": false,\n \"subscribed\": null,\n \"status\": \"open\",\n \"parents\": [],\n \"parent\": \"f_3\",\n \"new-notes-count\": 0,\n \"name\": \"Line Item 2\",\n \"last-child\": false,\n \"has-notes\": false,\n \"folder-type\": \"line_item\",\n \"first-child\": false,\n \"empty\": false,\n \"due-date\": {\n \"isOverDue\": false,\n \"date\": \"\"\n },\n \"deepness\": 0,\n \"custom-value\": null\n }\n }\n ]\n}"}],"_postman_id":"00db42cd-d609-48e6-b4f7-a7324314412b"},{"name":"Update single folder","id":"701cfaaf-f886-460d-9774-7b89666e1d73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"folder\",\n \"id\": \"44399\",\n \"attributes\": {\n \"name\": \"Line item\",\n \"status\": \"closed\",\n \"due-date\": \"2020-06-29\",\n \"custom-value\": \"12345\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/folders/:folder_id","description":"Use this endpoint to change the folder name, status, custom column value or due date, as well as to move one folder into another.
\nNote:
\nheadingline_itemfolderheading: at the top of a heading, where position-ref is the heading id (note: no matter the folder type, items added at the top of a heading will always become line items)on: inside (at the top) of a folder, where position-ref is the parent folder idbelow: after a folder (where position-ref is the reference folder id)Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"folder\",\n \"id\": \"44399\",\n \"attributes\": {\n \"status\": \"closed\"\n }\n },\n {\n \"type\": \"folder\",\n \"id\": \"44605\",\n \"attributes\": {\n \"position-ref\": 44409,\n \"position\": \"heading\"\n }\n }\n ]\n}"},"url":"http://localhost:4000//api/v2/folders","description":"The same rules apply as in Update single folder endpoint, except folders are sent as an array.
\n","urlObject":{"path":["api","v2","folders"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"359776e8-e696-431e-b329-6c6ea22ba5c7","name":"Multiple folders updated","originalRequest":{"method":"PATCH","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"folder\",\n \"id\": \"44399\",\n \"attributes\": {\n \"status\": \"closed\"\n }\n },\n {\n \"type\": \"folder\",\n \"id\": \"44605\",\n \"attributes\": {\n \"position-ref\": 44409,\n \"position\": \"heading\"\n }\n }\n ]\n}"},"url":"http://localhost:4000//api/v2/folders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"296"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"folder\",\n \"id\": \"44399\",\n \"attributes\": {\n \"unread\": false,\n \"subscribed\": false,\n \"status\": \"closed\",\n \"parents\": [],\n \"parent\": \"f_44396\",\n \"new-notes-count\": 0,\n \"name\": \"Line item 1\",\n \"last-child\": false,\n \"has-notes\": false,\n \"folder-type\": \"folder\",\n \"first-child\": false,\n \"empty\": true,\n \"due-date\": {\n \"isOverDue\": true,\n \"date\": \"6/29/2020\"\n },\n \"deepness\": 0,\n \"custom-value\": \"12345\"\n }\n },\n {\n \"type\": \"folder\",\n \"id\": \"44605\",\n \"attributes\": {\n \"unread\": false,\n \"subscribed\": false,\n \"status\": \"open\",\n \"parents\": [],\n \"parent\": \"f_44409\",\n \"new-notes-count\": 0,\n \"name\": \"Line item 2\",\n \"last-child\": false,\n \"has-notes\": false,\n \"folder-type\": \"line_item\",\n \"first-child\": false,\n \"empty\": true,\n \"due-date\": {\n \"isOverDue\": false,\n \"date\": \"\"\n },\n \"deepness\": 0,\n \"custom-value\": null\n }\n }\n ]\n}"}],"_postman_id":"8f92f472-8ed1-4648-84ee-581d07a12b63"},{"name":"Subscribe to folder","id":"82906ebc-8b92-4e66-a5c7-e4a980fef91e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"folder-subscriptions\",\n \"relationships\": {\n \"folder\": {\n \"data\": {\n \"id\": \"39\",\n \"type\": \"folder\"\n }\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/me/folders-subscriptions","description":"Users can subscribe to a folder to get notifications when something changes.
\n422 with error detail \"Folder has already been taken\" will return.The same access rules apply as when subscribing to a folder.
\n","urlObject":{"path":["api","v2","me","folders-subscriptions",":folder_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"a423eff0-00eb-4732-96ad-81b45f79f92d","type":"string","value":"18","key":"folder_id"}]}},"response":[{"id":"e95f97df-967c-4b83-8dd8-a5e9937637d8","name":"Unsubscribe to folder","originalRequest":{"method":"GET","header":[]},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, private, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"name":"content-length","key":"content-length","value":"0","description":"The length of the response body in octets (8-bit bytes)"},{"name":"content-type","key":"content-type","value":"application/vnd.api+json","description":"The mime type of this content"},{"name":"date","key":"date","value":"Wed, 31 Oct 2018 19:04:22 GMT","description":"The date and time that the message was sent"},{"name":"server","key":"server","value":"Cowboy","description":"A name for the server"},{"name":"x-request-id","key":"x-request-id","value":"f7fllb1ui8pk8c0agd725jelovqo1sbh","description":"Custom header"}],"cookie":[{"expires":"Thu Jun 04 2020 15:25:03 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"GA1.1.1691954976.1528210849","key":"_ga"},{"expires":"Sat Jul 20 2019 19:18:45 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"d0795498-c8e7-461f-ac9a-32cf2175ee13","key":"intercom-id-d0rwjug4"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"libraryContent%3Dbrowse%26advImgDetails%3Dhide%26hidetb%3D0","key":"wp-settings-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":true,"value":"WP+Cookie+check","key":"wordpress_test_cookie"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"1537052594","key":"wp-settings-time-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"258321d5693b72c21c1822711d7e611e","key":"phpMyAdmin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"%7B%22iv%22%3A%22oDZwYNwjWbHtCIMVF4HYWw%3D%3D%22%2C%22mac%22%3A%22f7dc03bdc2e058c862e8c4902bee107dcb492188%22%2C%22payload%22%3A%22F32XqdxcuphocRuxKdNhsl2Tx8cpSQQc15v2VNdlslg%3D%22%7D","key":"pmaAuth-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"gabriel%40prodeal360.com","key":"last_email_loggedin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"SFMyNTY.g3QAAAADbQAAAAtfY3NyZl90b2tlbm0AAAAYR3R4ditTL1Z0Y3NCNVZ4dHE5alZIdz09bQAAAA9maWx0ZXJzX2RlYWxfaWRhA20AAAAHdXNlcl9pZGEB.nCwK994N9iReC1nftq__C0SZyrSsBm4I_F4_u67bNMM","key":"_prodeal360_key"}],"responseTime":null,"body":""}],"_postman_id":"8e013114-5e5f-45f4-896b-418db8abf7db"},{"name":"Delete folder","id":"dcd30262-f2be-43ac-881e-477460ea1f3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/folders/:folder_id","description":"403 error will return.409 with the error code ROOM_INACTIVE will return.403 with error detail INACCESSIBLE_CONTENT will return.Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n { \"type\": \"folder\", \"id\": \"25\" },\n { \"type\": \"folder\", \"id\": \"26\" },\n { \"type\": \"folder\", \"id\": \"27\" }\n ]\n}"},"url":"http://localhost:4000//api/v2/folders","description":"The same rules apply as in Delete single folder endpoint, except the folder IDs are sent in the request body.
\n","urlObject":{"path":["api","v2","folders"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"10a3f3bb-1929-4806-933c-03643a995d47","name":"Delete multiple folders","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n { \"type\": \"folder\", \"id\": \"25\" },\n { \"type\": \"folder\", \"id\": \"26\" },\n { \"type\": \"folder\", \"id\": \"27\" }\n ]\n}"},"url":"http://localhost:4000//api/v2/folders","description":"The same rules apply as in [Delete single folder](https://prodeal.postman.co/collections/4189548-0ab03dab-d621-43a7-80f9-e67c178f0c9d?version=latest&workspace=bffd4be7-7e18-4e3e-8e2f-ce176abf8926#6c9803ed-c0a3-47e7-a344-0d52c687e343) endpoint, except the folder IDs are sent in the request body."},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, private, must-revalidate","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"name":"content-length","key":"content-length","value":"0","description":"The length of the response body in octets (8-bit bytes)"},{"name":"content-type","key":"content-type","value":"application/vnd.api+json","description":"The mime type of this content"},{"name":"date","key":"date","value":"Wed, 17 Oct 2018 16:31:48 GMT","description":"The date and time that the message was sent"},{"name":"server","key":"server","value":"Cowboy","description":"A name for the server"},{"name":"x-request-id","key":"x-request-id","value":"hb63barq7tfdiojp9m44tv997p8lngs1","description":"Custom header"}],"cookie":[{"expires":"Thu Jun 04 2020 15:25:03 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"GA1.1.1691954976.1528210849","key":"_ga"},{"expires":"Sun Jun 09 2019 19:30:09 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"d0795498-c8e7-461f-ac9a-32cf2175ee13","key":"intercom-id-d0rwjug4"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"libraryContent%3Dbrowse%26advImgDetails%3Dhide%26hidetb%3D0","key":"wp-settings-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"gabriel%40prodeal360.com","key":"last_email_loggedin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":true,"value":"WP+Cookie+check","key":"wordpress_test_cookie"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"1537052594","key":"wp-settings-time-1"},{"expires":"Tue Oct 23 2018 22:21:44 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":false,"value":"es","key":"pma_lang"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"258321d5693b72c21c1822711d7e611e","key":"phpMyAdmin"},{"expires":"Tue Oct 23 2018 22:47:00 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":false,"value":"%7B%22iv%22%3A%22vJDm%5C%2FWbbeiw9OwBZIAwRqQ%3D%3D%22%2C%22mac%22%3A%22fdfd47ebca09a61d176eab28211704e605f889ed%22%2C%22payload%22%3A%22dpuvhbnnBuU%5C%2FcWfeFHAJnA%3D%3D%22%7D","key":"pmaUser-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"%7B%22iv%22%3A%22oDZwYNwjWbHtCIMVF4HYWw%3D%3D%22%2C%22mac%22%3A%22f7dc03bdc2e058c862e8c4902bee107dcb492188%22%2C%22payload%22%3A%22F32XqdxcuphocRuxKdNhsl2Tx8cpSQQc15v2VNdlslg%3D%22%7D","key":"pmaAuth-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"SFMyNTY.g3QAAAAGbQAAAAtfY3NyZl90b2tlbm0AAAAYZ2VJcFpFa3lwUFJiNC9BZ1hXanhzZz09bQAAAA9maWx0ZXJzX2RlYWxfaWRhA20AAAANZmlsdGVyc19wYXJ0eWQAA25pbG0AAAATZmlsdGVyc19zZWFyY2hfdGVybWQAA25pbG0AAAAOZmlsdGVyc19zdGF0dXNkAANuaWxtAAAAB3VzZXJfaWRhAQ.LmUDm0-lRj1-19E2Nphdu1P-oUXTEPbSLUO140ACBtY","key":"_prodeal360_key"}],"responseTime":null,"body":""}],"_postman_id":"7c258adc-fd0f-4560-8d9f-8cb515968878"},{"name":"Get folder email address","id":"6d66d094-58ac-4597-b754-36d8ff38fcbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/folders/136844","description":"Generate a unique email address for each folder.
\nNote:
\nThe checklist is organized into folders.
\nA folder contains:
\nid: ID (read-only, auto-generated)name: Name (175 characters max)parents: An array of all parents formatted as \"f_\" + parent_idparent: Direct parent, formatted as \"f_\" + parent_idfirst-child: Position in the parentlast-child: Position in the parentdeepness: The deepness in the hierarchy. 0 for headingsfolder-type:heading: Headings are folders with deepness 0line_item: Line items are folders with deepness 1folder: All other folders with deepness > 1status: Status of the folder (note: does not work for headings)open: Open (note: empty folders can be open and closed, but never in progress)in_progress: (note: folders containing documents can be in progress or closed, but never open)closeddue-date: Due date, with isOverDue indicatorcustom-value: Value for the custom column, if enabled for a roomempty: Indicator whether the folder is empty or notunread: Indicator if the folder contains notes or documents that the current user did not readhas-notes: Indicator if the folder has notes.new-notes-count: Count of notes unread by the current usersubscribed: Indicator if the current user is subscribed to a folder (note: works for headings only)A folder has the following relationships:
\nparties: In confidential rooms, parties are teams that have access to folder.responsible-groups: Teams responsible for the current foldernotes: Notesroom: Room to which the entire checklist belongsOnly accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/documents/:document_id","description":"Available \"include\" options:
\nparties (teams)roomfile_versionscurrent_file_versionfolderBy default, if nothing specified, current file version is included. However, if the include parameter is added, then only the specified entities are included.
Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/documents/:document_id/file","description":"Use this endpoint to get the currently available (latest) document version. It returns a link for file download and the suggested filename and extension.
\n","urlObject":{"path":["api","v2","documents",":document_id","file"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"f87e6aef-da88-4bfc-9e1d-74fdd8326c1c","type":"string","value":"18","key":"document_id"}]}},"response":[{"id":"6734aadb-60ae-426d-91dd-4d5aab8439ac","name":"Get document file","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"url":"http://localhost:4000//api/v2/documents/1/file"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"247"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"data\": {\n \"type\": \"document-file\",\n \"id\": \"1\",\n \"attributes\": {\n \"link\": \"https://api.prodeal360.com/api/v2/file-versions/46423/download\",\n \"expiration\": -1,\n \"created-at\": \"2019-02-19T21:14:35.375566\"\n }\n }\n}"}],"_postman_id":"2eafb2b4-8fa6-4e1c-a57d-9581b96ff2f9"},{"name":"View document version","id":"382ff260-b492-4a02-897e-737c9a54d81a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/file-versions/:file_version_id/view","description":"404 will be returned.Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/file-versions/:file_version_id/download","description":"Use this endpoint to download the document.
\nAll roles can download documents. However, there is a restriction for rooms with watermarking enabled. In these rooms, only successfully converted documents will be available to download, in PDF format, for all roles.
\nDocuments that don't have conversion-state: \"converted\" will be possible to download only by Hosts, in their original form.
This endpoint allows users to upload a document to a specific folder within a checklist room. The document can be associated with specific teams for access control.
\nUnlike other endpoints, the Accept header must be omitted for this request.
When a document is uploaded to the open folder, its status automatically changes to in_progress.
Document name can have 200 characters max.
\nBy default, file versions are included in the response.
\nOnly accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\":\"document\",\n \"id\":\"18\",\n \"attributes\":{\n \"name\":\"foo\",\n \"final\":true\n },\n \"relationships\":{\n \"folder\":{\n \"data\":{\n \"type\":\"folder\",\n \"id\":\"195\"\n }\n },\n \"parties\":{\n \"data\":[\n {\n \"type\":\"party\",\n \"id\":\"3\"\n }\n ]\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/documents/:document_id","description":"Use this endpoint to rename or move a document, change which teams have access to it, or change status.
\nNote: Document name can have 200 characters max.
\nBy default, file versions are included in the response.
\n403 error will return and nothing will be changed. E.g. If a Guest tries to change the document name and status in the same request, nothing will be changed.Only accept JSON-API documents
\n","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\":[\n {\n \"type\":\"document\",\n \"id\":\"441\",\n \"attributes\":{\n \"name\":\"foo\",\n \"final\":true\n },\n \"relationships\":{\n \"folder\":{\n \"data\":{\n \"type\":\"folder\",\n \"id\":\"8\"\n }\n },\n \"parties\":{\n \"data\":[\n \n ]\n }\n }\n },\n {\n \"type\":\"document\",\n \"id\":\"1\",\n \"attributes\":{\n \"name\":\"bar\",\n \"final\":false\n },\n \"relationships\":{\n \"folder\":{\n \"data\":{\n \"type\":\"folder\",\n \"id\":\"195\"\n }\n },\n \"parties\":{\n \"data\":[\n {\n \"type\":\"party\",\n \"id\":\"3\"\n }\n ]\n }\n }\n }\n ]\n}"},"url":"http://localhost:4000//api/v2/documents","description":"The same rules apply as in Update single document endpoint, except the documents are sent as an array in the request body.
\n","urlObject":{"path":["api","v2","documents"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"2c7525d9-c0c0-425f-93cd-c0875d9fdade","name":"Multiple documents updated","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","type":"text","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","type":"text","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\":[\n {\n \"type\":\"document\",\n \"id\":\"46436\",\n \"attributes\":{\n \"name\":\"Doc 1\",\n \"final\":true\n }\n },\n {\n \"type\":\"document\",\n \"id\":\"46437\",\n \"attributes\":{\n \"name\":\"Doc 2\",\n \"final\":false\n }\n }\n ]\n}"},"url":"http://localhost:4000//api/v2/documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"497"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"file-version\",\n \"id\": \"46422\",\n \"attributes\": {\n \"inserted-at\": \"2020-06-30T09:38:43.748938\",\n \"file-hash\": \"3468CAEA9E34E04228B1746B397CEF7A7014C4FE4AC368FF60B05B09D42B1880\"\n }\n },\n {\n \"type\": \"file-version\",\n \"id\": \"46423\",\n \"attributes\": {\n \"inserted-at\": \"2020-06-30T09:38:43.752273\",\n \"file-hash\": \"3468CAEA9E34E04228B1746B397CEF7A7014C4FE4AC368FF60B05B09D42B1880\"\n }\n }\n ],\n \"data\": [\n {\n \"type\": \"document\",\n \"relationships\": {\n \"current-file-version\": {\n \"data\": {\n \"type\": \"file-version\",\n \"id\": \"46423\"\n }\n }\n },\n \"id\": \"46437\",\n \"attributes\": {\n \"url\": \"/documents/46437\",\n \"unread\": false,\n \"parents\": [\n \"f_44391\",\n \"f_44392\"\n ],\n \"parent\": \"f_44392\",\n \"name\": \"Doc 2\",\n \"most-recent-upload-unix-time\": 1593509923,\n \"most-recent-upload-author-id\": null,\n \"most-recent-upload\": \"June 30 at 5:38AM by John Doe (O)\",\n \"most-recent-author-id\": 499,\n \"last-child\": false,\n \"has-access\": true,\n \"first-child\": false,\n \"final\": false,\n \"deepness\": 0,\n \"deal-creator-party-id\": 1589,\n \"conversion-state\": \"converted\",\n \"can-delete\": true\n }\n },\n {\n \"type\": \"document\",\n \"relationships\": {\n \"current-file-version\": {\n \"data\": {\n \"type\": \"file-version\",\n \"id\": \"46422\"\n }\n }\n },\n \"id\": \"46436\",\n \"attributes\": {\n \"url\": \"/documents/46436\",\n \"unread\": false,\n \"parents\": [\n \"f_44391\",\n \"f_44609\"\n ],\n \"parent\": \"f_44609\",\n \"name\": \"Doc 1\",\n \"most-recent-upload-unix-time\": 1593509923,\n \"most-recent-upload-author-id\": null,\n \"most-recent-upload\": \"June 30 at 5:38AM by John Doe (O)\",\n \"most-recent-author-id\": 499,\n \"last-child\": false,\n \"has-access\": true,\n \"first-child\": false,\n \"final\": true,\n \"deepness\": 0,\n \"deal-creator-party-id\": 1589,\n \"conversion-state\": \"converted\",\n \"can-delete\": true\n }\n }\n ]\n}"}],"_postman_id":"9023aa63-617f-4998-8884-30f447e121c9"},{"name":"Mark as unread","id":"0b6b7363-c737-4eb5-a4d5-31e821418c8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\":[\n {\n \"type\":\"unread-documents\",\n \"id\":\"46436\"\n }\n ]\n}\n"},"url":"http://localhost:4000//api/v2/unread_documents","urlObject":{"path":["api","v2","unread_documents"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"2be18159-3cdc-4aeb-98b4-3f6d602b3db3","name":"Mark as unread","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\":[\n {\n \"type\":\"unread-documents\",\n \"id\":\"46436\"\n }\n ]\n}\n"},"url":"http://localhost:4000//api/v2/unread_documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"104"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"unread-document\",\n \"id\": \"46436\",\n \"attributes\": {\n \"id\": 46436\n }\n }\n ]\n}"}],"_postman_id":"0b6b7363-c737-4eb5-a4d5-31e821418c8a"},{"name":"Mark as read","id":"3e4343a1-e925-44f7-b535-b65862725c4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\":[\n {\n \"type\":\"unread-documents\",\n \"id\":\"46436\"\n }\n ]\n}\n"},"url":"http://localhost:4000//api/v2/unread_documents","urlObject":{"path":["api","v2","unread_documents"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"686b3e98-2d69-4ae3-ac76-adb037a2771f","name":"Mark multiple as read","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\":[\n {\n \"type\":\"unread-documents\",\n \"id\":\"46437\"\n },\n {\n \"type\":\"unread-documents\",\n \"id\":\"46439\"\n }\n ]\n}\n"},"url":"http://localhost:4000//api/v2/unread_documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"170"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"unread-document\",\n \"id\": \"46437\",\n \"attributes\": {\n \"id\": 46437\n }\n },\n {\n \"type\": \"unread-document\",\n \"id\": \"46439\",\n \"attributes\": {\n \"id\": 46439\n }\n }\n ]\n}"},{"id":"e843884f-7687-434c-b69e-27357fb1593e","name":"Mark as read","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\":[\n {\n \"type\":\"unread-documents\",\n \"id\":\"46436\"\n }\n ]\n}\n"},"url":"http://localhost:4000//api/v2/unread_documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"104"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"unread-document\",\n \"id\": \"46436\",\n \"attributes\": {\n \"id\": 46436\n }\n }\n ]\n}"}],"_postman_id":"3e4343a1-e925-44f7-b535-b65862725c4e"},{"name":"Delete single document","id":"6d9041b1-2535-40aa-9da1-c60b1ce899f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/documents/:document_id","description":"403 error will return.400 with the error detail Invalid deal state will return.403 with error code FINAL_DOCUMENT_DELETION will return.Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n { \"type\": \"document\", \"id\": \"19\" },\n { \"type\": \"document\", \"id\": \"20\" },\n { \"type\": \"document\", \"id\": \"21\" }\n ]\n}"},"url":"http://localhost:4000//api/v2/documents","description":"The same rules apply as in Delete single document endpoint, except the document IDs are sent in the request body.
\n","urlObject":{"path":["api","v2","documents"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"36c1aea5-09bc-4296-baac-438f980ea63c","name":"Delete multiple documents","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n\t{ \"type\": \"document\", \"id\": \"19\" },\n\t{ \"type\": \"document\", \"id\": \"20\" },\n\t{ \"type\": \"document\", \"id\": \"21\" }\n ]\n}"},"url":"http://localhost:4000//api/v2/documents"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"name":"content-length","key":"content-length","value":"0","description":""},{"name":"content-type","key":"content-type","value":"application/vnd.api+json","description":""}],"cookie":[{"expires":"Thu Jun 04 2020 15:25:03 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"GA1.1.1691954976.1528210849","key":"_ga"},{"expires":"Mon Aug 12 2019 14:10:57 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"d0795498-c8e7-461f-ac9a-32cf2175ee13","key":"intercom-id-d0rwjug4"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"libraryContent%3Dbrowse%26advImgDetails%3Dhide%26hidetb%3D0","key":"wp-settings-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":true,"value":"WP+Cookie+check","key":"wordpress_test_cookie"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"1537052594","key":"wp-settings-time-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"258321d5693b72c21c1822711d7e611e","key":"phpMyAdmin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"%7B%22iv%22%3A%22oDZwYNwjWbHtCIMVF4HYWw%3D%3D%22%2C%22mac%22%3A%22f7dc03bdc2e058c862e8c4902bee107dcb492188%22%2C%22payload%22%3A%22F32XqdxcuphocRuxKdNhsl2Tx8cpSQQc15v2VNdlslg%3D%22%7D","key":"pmaAuth-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"vinny%40prodeal360.com","key":"last_email_loggedin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"SFMyNTY.g3QAAAACbQAAAAtfY3NyZl90b2tlbm0AAAAYV2FJVU9yYXNqMkd3emkzS2tVNTlWZz09bQAAAAd1c2VyX2lkYQM.Tdp0Tr5sCrz9v0iHHCJJ7bi42mXT49ilQt7ZwVPnFuE","key":"_prodeal360_key"}],"responseTime":null,"body":""}],"_postman_id":"893dea95-a5ec-470d-b647-b1dc0dc5dddb"}],"id":"7e8b72a3-50ac-4a88-bc07-daaa2264d702","description":"All files uploaded to the system are referred to as \"documents\".
\nA document contains:
\nid: ID (auto-generated, read-only)name: Name of the document in the checklist. Can be different than filename. Does not need to contain the information about the document extension.url: Relative path in the system, e.g. \"/documents/46438\"parents: Array of parent foldersparent: Direct parent folderdeepness: Deepness in the checklist treelast-child: Position in the parentfirst-child: Position in the parentfinal: Whether the document is finalconversion-state: Whether the document can be watermarked and converted to PDF or not. This conversion check happens on every document upload.\"error\" - Document cannot be watermarked and converted to PDF.\"converted\" - Document can be converted\"converting\" - Document conversion check is in progress\"corrupted\" - Document did not pass the virus-check. Note that these documents might not actually be corrupted.unread: Whether the current user opened the document or nothas-access: Whether the current user can access the document or notcan-delete: Whether the current user can delete the document or notmost-recent-upload-unix-time: Timestamp of the most recent upload time. If the document has multiple versions, it will be the timestamp of the latest version upload.most-recent-upload-author-id: ID of the user who uploaded the latest version of the document.most-recent-author-id: ID of the user who made the latest changes to the document.deal-creator-party-id: ID of the team to whom belongs the person who created (first uploaded) the documentmost-recent-upload: Nicely formatted summary of the latest upload. E.g. \"June 30 at 5:38AM by John Doe (O)\",A document has the following relationships:
\nroom: Room to which the checklist belongsparties: Teams that have access to the documentfolder: Folder that contains the document (direct parent)file-versions: File versionscurrent-file-version: Current file versionOnly accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/notes?filter[folderId]=110&page[number]=1&page[size]=10","description":"folderId: Folder ID (required).
Hosts, Admins and Guests can view the notes on the folders they have access to - but only if the room has the notes enabled.
\n","urlObject":{"path":["api","v2","notes"],"host":["http://localhost:4000/"],"query":[{"key":"filter[folderId]","value":"110"},{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}],"variable":[]}},"response":[{"id":"50e704bf-b1a9-437c-a079-ce63226c955f","name":"All notes for a folder","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"url":{"raw":"http://localhost:4000//api/v2/notes?filter[folderId]=110&page[number]=1&page[size]=10","host":["http://localhost:4000/"],"path":["api","v2","notes"],"query":[{"key":"filter[folderId]","value":"110"},{"key":"page[number]","value":"1"},{"key":"page[size]","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 26 Jun 2020 16:45:03 GMT"},{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"374"},{"key":"Connection","value":"keep-alive"},{"key":"Set-Cookie","value":"AWSALB=wk3k9di6TrF04rgeIVSnfyBurvl0+rs10fduAuvbV5zJ7MrmVBIy501CVa+rJsCk7FvBBnooSG545tgNO5z1J+3rbVf6eWbWIEdaP/bzUXuXoS8fUG4+hvrp3zcc; Expires=Fri, 03 Jul 2020 16:45:03 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=wk3k9di6TrF04rgeIVSnfyBurvl0+rs10fduAuvbV5zJ7MrmVBIy501CVa+rJsCk7FvBBnooSG545tgNO5z1J+3rbVf6eWbWIEdaP/bzUXuXoS8fUG4+hvrp3zcc; Expires=Fri, 03 Jul 2020 16:45:03 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"nginx"},{"key":"content-encoding","value":"gzip"},{"key":"set-cookie","value":"_prodeal360=session_zLViTAKIP9tnDE1QDmGPnC8KQVggUCyVYufcp1dPfgCF83QHYqRf8sKIni9R+bg8ytF5IfvwgjT/YsnZxfgZD13UfTEkKf9unz6YJeJm1wNqyZ3wnRo1NlV7gZkax7Uh; path=/; domain=staging.prodeal.dev; secure; HttpOnly"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2oe2bhkrpq71f288v80023a1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, private, must-revalidate"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": {\n \"self\": \"/api/v2/notes?filter[folderId]=110&page[number]=1&page[size]=10\"\n },\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"note\",\n \"id\": \"1\",\n \"attributes\": {\n \"user\": {\n \"teams\": [\n {\n \"name\": \"ProDeal\",\n \"abbreviation\": \"O\"\n }\n ],\n \"team\": {\n \"name\": \"ProDeal\",\n \"abbreviation\": \"O\"\n },\n \"name\": \"John Doe\",\n \"id\": 499\n },\n \"updated-at\": \"2020-06-26T12:44:06.754116\",\n \"message\": \"Another note
\",\n \"is-read\": true,\n \"inserted-at\": \"2020-06-26T12:44:06.753979\",\n \"edited\": false,\n \"deleted-at\": null,\n \"created\": \"Fri, Jun 26 at 12:44PM\"\n }\n },\n {\n \"type\": \"note\",\n \"id\": \"2\",\n \"attributes\": {\n \"user\": {\n \"teams\": [\n {\n \"name\": \"ProDeal\",\n \"abbreviation\": \"O\"\n }\n ],\n \"team\": {\n \"name\": \"ProDeal\",\n \"abbreviation\": \"O\"\n },\n \"name\": \"Jane Doe\",\n \"id\": 500\n },\n \"updated-at\": \"2020-06-26T12:43:59.487959\",\n \"message\": \"Some note
\",\n \"is-read\": true,\n \"inserted-at\": \"2020-06-26T12:43:59.487949\",\n \"edited\": false,\n \"deleted-at\": null,\n \"created\": \"Fri, Jun 26 at 12:43PM\"\n }\n }\n ]\n}"}],"_postman_id":"d7cb187e-f522-4eb2-8364-4f0f93b3c557"},{"name":"Create note","id":"dc79a196-3b1d-4c86-a333-48a67fcdc695","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\":\"notes\",\n \"attributes\":{\n \"folder-id\":\"110\",\n \"message\":\"hello world\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/notes","description":"To create a note, you need to provide only a folder ID and the note message.
\nHosts, Admins and Guests can create notes on folders they have access to.
\n","urlObject":{"path":["api","v2","notes"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"3cdc80d8-3ff6-4e3d-b875-4ebd163de8ae","name":"Note created","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\":\"notes\",\n \"attributes\":{\n \"folder-id\":\"44388\",\n \"message\":\"hello world\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"258"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"note\",\n \"id\": \"668\",\n \"attributes\": {\n \"user\": {\n \"teams\": [\n {\n \"name\": \"ProDeal\",\n \"abbreviation\": \"O\"\n }\n ],\n \"team\": {\n \"name\": \"ProDeal\",\n \"abbreviation\": \"O\"\n },\n \"name\": \"John Doe\",\n \"id\": 499\n },\n \"updated-at\": \"2020-06-26T13:03:45.348814\",\n \"message\": \"hello world\",\n \"is-read\": true,\n \"inserted-at\": \"2020-06-26T13:03:45.348803\",\n \"edited\": false,\n \"deleted-at\": null,\n \"created\": \"Fri, Jun 26 at 1:03PM\"\n }\n }\n}"}],"_postman_id":"dc79a196-3b1d-4c86-a333-48a67fcdc695"},{"name":"Update note","id":"40fe9433-aa4b-44a1-bff6-b8e6047a1369","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\":\"notes\",\n \"id\": \"670\",\n \"attributes\":{\n \"message\":\"updated message\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/notes/:note_id","description":"Users can update note's message for their own notes.
\n","urlObject":{"path":["api","v2","notes",":note_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"ae825fb0-856b-4a2e-879c-4916842e72de","type":"string","value":"670","key":"note_id"}]}},"response":[{"id":"a50b8cb7-7342-409c-9cab-0d55f3802e0a","name":"Updated single note","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\":\"notes\",\n \"id\": \"670\",\n \"attributes\":{\n \"message\":\"updated message\"\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/notes/:note_id","host":["http://localhost:4000/"],"path":["api","v2","notes",":note_id"],"variable":[{"key":"note_id","value":"670"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json; charset=utf-8"},{"key":"Content-Length","value":"258"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"note\",\n \"id\": \"670\",\n \"attributes\": {\n \"user\": {\n \"teams\": [\n {\n \"name\": \"ProDeal\",\n \"abbreviation\": \"O\"\n }\n ],\n \"team\": {\n \"name\": \"ProDeal\",\n \"abbreviation\": \"O\"\n },\n \"name\": \"John Doe\",\n \"id\": 499\n },\n \"updated-at\": \"2020-06-26T13:10:14.702829\",\n \"message\": \"updated message\",\n \"is-read\": true,\n \"inserted-at\": \"2020-06-26T13:06:15.767259\",\n \"edited\": true,\n \"deleted-at\": null,\n \"created\": \"Fri, Jun 26 at 1:06PM\"\n }\n }\n}"}],"_postman_id":"40fe9433-aa4b-44a1-bff6-b8e6047a1369"},{"name":"Delete note","id":"f0348cca-e2ad-4b62-acca-6f90f568234a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/notes/:note_id","description":"Users can delete their own notes.
\n","urlObject":{"path":["api","v2","notes",":note_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"580973ed-de02-49c3-893f-98e9b2c64c7c","type":"string","value":"670","key":"note_id"}]}},"response":[{"id":"47dd487b-fc13-4469-aa72-43af78e77d35","name":"Note deleted","originalRequest":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"url":{"raw":"http://localhost:4000//api/v2/notes/:note_id","host":["http://localhost:4000/"],"path":["api","v2","notes",":note_id"],"variable":[{"key":"note_id","value":"670","type":"string"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f0348cca-e2ad-4b62-acca-6f90f568234a"}],"id":"b741213c-482a-4826-89a1-ac749c70c465","description":"Notes are a way to keep up with all the changes in a room and communicate with colleagues and partners. If notes are enabled on the room, every heading, line item and folder gets its own notes thread (similar to chat).
\nA note has the following parameters:
\nid: ID (read-only, auto-generated)user: Information about the user who created a note and his team(s)created: A nicely formated date indicating when was the note created (auto-generated)inserted-at: A date in ISO format indicating when was the note created (auto-generated)updated-at: A date in ISO format indicating when was the note last updated (auto-generated)deleted-at: A date in ISO format indicating when was the note last updated (auto-generated)is-read: Is the note already read by the current user (notes are automatically marked as read on GET request)edited: Whether the note was edited after creation or notmessage: Note content with basic HTML formatting (bold, italic, underline, lists).If a note gets deleted, its message automatically becomes \"This note was deleted by the author.\"
\n","_postman_id":"b741213c-482a-4826-89a1-ac749c70c465"},{"name":"Item Statuses","item":[{"name":"Get all item statuses","id":"49b6b752-ad53-4198-8065-629c5334ea6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://localhost:4000//api/v2/rooms/:room_id/item-statuses/","urlObject":{"path":["api","v2","rooms",":room_id","item-statuses",""],"host":["http://localhost:4000/"],"query":[],"variable":[{"type":"any","value":"2","key":"room_id"}]}},"response":[],"_postman_id":"49b6b752-ad53-4198-8065-629c5334ea6f"},{"name":"Create item status","id":"94bd37e3-a481-43ee-89fa-91460e2dedb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"item-status\",\n \"attributes\": {\n \"name\": \"ready\",\n \"label\": \"Ready\",\n \"class\": \"closed\",\n \"default\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4000//api/v2/rooms/:room_id/item-statuses","urlObject":{"path":["api","v2","rooms",":room_id","item-statuses"],"host":["http://localhost:4000/"],"query":[],"variable":[{"type":"any","value":"2","key":"room_id"}]}},"response":[],"_postman_id":"94bd37e3-a481-43ee-89fa-91460e2dedb8"},{"name":"Update item status","id":"2b6e9a0e-f888-4134-8a90-70dd28afbd2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n","type":"text"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"item-status\",\n \"attributes\": {\n \"default\": false\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4000//api/v2/rooms/:room_id/item-statuses/:id","urlObject":{"path":["api","v2","rooms",":room_id","item-statuses",":id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"type":"any","value":"2","key":"room_id"},{"type":"any","value":"4","key":"id"}]}},"response":[],"_postman_id":"2b6e9a0e-f888-4134-8a90-70dd28afbd2c"},{"name":"Delete item status","id":"3f5a4323-d9d7-46f8-ad71-de9d283a5945","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"http://localhost:4000//api/v2/rooms/:room_id/item-statuses/:id","urlObject":{"path":["api","v2","rooms",":room_id","item-statuses",":id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"type":"any","value":"2","key":"room_id"},{"type":"any","value":"3","key":"id"}]}},"response":[],"_postman_id":"3f5a4323-d9d7-46f8-ad71-de9d283a5945"}],"id":"efe6e67a-6a36-4432-97f3-36873fb54cb1","_postman_id":"efe6e67a-6a36-4432-97f3-36873fb54cb1","description":""},{"name":"Teams","item":[{"name":"Get all teams","id":"288f8809-f118-4d19-a479-53fe9f565c9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/teams","description":"room: Room ID (get all teams in one room)room-id: Room ID (get all teams in one room)type-name: Team type namesearch-term: Search by nameAvailable \"include\" options:
\nusers: Team usersinvites: Pending invites in a teamroom: Teams roomAvailable \"filter\" options:
\nOnly Hosts, Admins and Guests that are invited to a room can see the teams in the room.
\n","urlObject":{"path":["api","v2","teams"],"host":["http://localhost:4000/"],"query":[{"disabled":true,"key":"filter[room]","value":"2"}],"variable":[]}},"response":[{"id":"26813adf-daff-43b5-82b3-08f1f8870869","name":"Get all teams","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"url":"http://localhost:4000//api/v2/teams"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Mon, 11 Feb 2019 13:35:00 GMT"},{"key":"content-length","value":"425"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"rkqf6kp3h7gft930cqn0als7q1hd8qlb"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": {\n \"self\": \"/api/v2/teams?page[number]=1&page[size]=50\"\n },\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"team\",\n \"id\": \"2\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"role-id\": \"host_admin\",\n \"name\": \"Capital Bancshares\",\n \"is-member\": true,\n \"abbreviation\": \"CBA\",\n \"invites-count\": 0,\n \"users-count\": 10\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"1\",\n \"attributes\": {\n \"type-name\": \"Buyer\",\n \"role-id\": \"host_admin\",\n \"name\": \"Capital Bancshares\",\n \"is-member\": true,\n \"abbreviation\": \"CBA\",\n \"invites-count\": 0,\n \"users-count\": 4\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"7\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"role-id\": \"host_admin\",\n \"name\": \"Capital Bancshares 1\",\n \"is-member\": true,\n \"abbreviation\": \"O\",\n \"invites-count\": 0,\n \"users-count\": 2\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"4\",\n \"attributes\": {\n \"type-name\": \"Seller\",\n \"role-id\": \"admin\",\n \"name\": \"Trustcorp Financial\",\n \"is-member\": false,\n \"abbreviation\": \"TFI\",\n \"invites-count\": 0,\n \"users-count\": 1\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"3\",\n \"attributes\": {\n \"type-name\": \"Seller\",\n \"role-id\": \"admin\",\n \"name\": \"Trustcorp Financial\",\n \"is-member\": false,\n \"abbreviation\": \"TFI\",\n \"invites-count\": 0,\n \"users-count\": 4\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"5\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"role-id\": \"guest\",\n \"name\": \"Azure Trust\",\n \"is-member\": false,\n \"abbreviation\": \"AZT\",\n \"invites-count\": 0,\n \"users-count\": 3\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"6\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"role-id\": \"guest\",\n \"name\": \"Azure Trust\",\n \"is-member\": false,\n \"abbreviation\": \"AZT\",\n \"invites-count\": 0,\n \"users-count\": 12\n }\n }\n ]\n}"},{"id":"73053314-eff9-474a-93ed-df1052f0e445","name":"Get all teams by room","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"url":{"raw":"http://localhost:4000//api/v2/teams?filter[room]=1","host":["http://localhost:4000/"],"path":["api","v2","teams"],"query":[{"key":"filter[room]","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Mon, 11 Feb 2019 13:35:59 GMT"},{"key":"content-length","value":"284"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"eghueii20e2u1v1dj3pupto5ojb467tr"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": {\n \"self\": \"/api/v2/teams?filter[room]=1&page[number]=1&page[size]=50\"\n },\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"team\",\n \"id\": \"1\",\n \"attributes\": {\n \"type-name\": \"Buyer\",\n \"role-id\": \"host_admin\",\n \"name\": \"Capital Bancshares\",\n \"is-member\": true,\n \"abbreviation\": \"CBA\",\n \"invites-count\": 0,\n \"users-count\": 12\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"3\",\n \"attributes\": {\n \"type-name\": \"Seller\",\n \"role-id\": \"admin\",\n \"name\": \"Trustcorp Financial\",\n \"is-member\": false,\n \"abbreviation\": \"TFI\",\n \"invites-count\": 0,\n \"users-count\": 10\n }\n },\n {\n \"type\": \"team\",\n \"id\": \"5\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"role-id\": \"guest\",\n \"name\": \"Azure Trust\",\n \"is-member\": false,\n \"abbreviation\": \"AZT\",\n \"invites-count\": 0,\n \"users-count\": 16\n }\n }\n ]\n}"}],"_postman_id":"288f8809-f118-4d19-a479-53fe9f565c9d"},{"name":"Get a team","id":"317536d4-502c-490f-8043-ed42e8ca609f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents
\n"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document
\n"}],"url":"http://localhost:4000//api/v2/teams/:team_id","description":"Available \"include\" options:
\nusers: Team usersinvites: Pending invites in a teamOnly Hosts, Admins and Guests that are invited to a room can see the teams in the room.
\n","urlObject":{"path":["api","v2","teams",":team_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"c4dd72cc-86a0-4cf1-aaf4-d60ec72fa1e8","type":"string","value":"18","key":"team_id"}]}},"response":[{"id":"35ce68c0-8d42-415e-859a-df1006fb5e1a","name":"Get a team (preload relationships)","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"url":{"raw":"http://localhost:4000//api/v2/teams/2?include=users,invites","host":["http://localhost:4000/"],"path":["api","v2","teams","2"],"query":[{"key":"include","value":"users,invites"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Mon, 11 Feb 2019 13:03:04 GMT"},{"key":"content-length","value":"650"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"32mpuvkti0l7ekehk20jrf9csjsftkim"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"included\": [\n {\n \"type\": \"user\",\n \"id\": \"1\",\n \"attributes\": {\n \"workspaces-flag-enabled\": false,\n \"online\": true,\n \"location\": null,\n \"last-seen-utc\": \"2019-10-04T00:17:27.032092\",\n \"last-name\": \"Merritt\",\n \"job-title\": \"Manager\",\n \"is-org-admin\": true,\n \"is-certified\": true,\n \"full-name\": \"Alvin Merritt\",\n \"first-name\": \"Alvin\",\n \"emails\": [\n \"user1org1@prodeal360.com\"\n ],\n \"contact-details\": [\n {\n \"number\": \"9298081234\",\n \"label\": \"work\",\n \"id\": \"1\"\n }\n ]\n }\n },\n {\n \"type\": \"invite\",\n \"id\": \"2\",\n \"attributes\": {\n \"last-sent-utc\": \"2019-10-04T00:17:23.810596\",\n \"inserted-at\": \"2019-10-03T20:17:23.787825\",\n \"email\": \"test@test.com\"\n }\n },\n {\n \"type\": \"user\",\n \"id\": \"2\",\n \"attributes\": {\n \"workspaces-flag-enabled\": false,\n \"online\": false,\n \"location\": null,\n \"last-seen-utc\": null,\n \"last-name\": \"Head\",\n \"job-title\": \"Assistent\",\n \"is-org-admin\": false,\n \"is-certified\": true,\n \"full-name\": \"Mateo Head\",\n \"first-name\": \"Mateo\",\n \"emails\": [\n \"user2org1@prodeal360.com\"\n ],\n \"contact-details\": [\n {\n \"number\": \"9298081234\",\n \"label\": \"work\",\n \"id\": \"2\"\n }\n ]\n }\n }\n ],\n \"data\": {\n \"type\": \"team\",\n \"relationships\": {\n \"users\": {\n \"data\": [\n {\n \"type\": \"user\",\n \"id\": \"1\"\n },\n {\n \"type\": \"user\",\n \"id\": \"2\"\n }\n ]\n },\n \"invites\": {\n \"data\": [\n {\n \"type\": \"invite\",\n \"id\": \"2\"\n }\n ]\n }\n },\n \"id\": \"2\",\n \"attributes\": {\n \"type-name\": \"Other\",\n \"role-id\": \"host_admin\",\n \"name\": \"Capital Bancshares\",\n \"is-member\": true,\n \"abbreviation\": \"CBA\",\n \"invites-count\": 1,\n \"users-count\": 2\n }\n }\n}"},{"id":"c23ff329-9e1f-4a94-be06-46bc07d95cee","name":"Get a team","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json","description":"Only accept JSON-API documents"},{"key":"Content-Type","value":"application/vnd.api+json","description":"Return JSON-API document"}],"url":"http://localhost:4000//api/v2/teams/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Mon, 11 Feb 2019 13:01:47 GMT"},{"key":"content-length","value":"163"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"vci9ca1pir7j56903cnbfei3bmmth8bc"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"team\",\n \"id\": \"2\",\n \"attributes\": {\n \"type-name\": \"Buyer\",\n \"role-id\": \"host_admin\",\n \"name\": \"Capital Bancshares\",\n \"is-member\": true,\n \"abbreviation\": \"CBA\",\n \"invites-count\": 0,\n \"users-count\": 10\n }\n }\n}"}],"_postman_id":"317536d4-502c-490f-8043-ed42e8ca609f"},{"name":"Create team","id":"6337035f-9703-41c8-8cc4-97c294505bcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"team\",\n \"attributes\": {\n \"name\": \"foo\",\n \"type-name\": \"seller\",\n \"abbreviation\": \"FOO\",\n \"members_emails\": [\n \t\"user@example.com\",\n \t\"user2@prodeal360.com\"\n ]\n },\n \"relationships\": {\n \"room\": {\n \"data\": {\n \"type\": \"room\",\n \"id\": \"1\"\n }\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/teams","description":"name: Team name (required; 255 characters max)abbreviation: Team name abbreviation (required; 5 characters max; default: first letters of each word of the team type) role-id: Team role (required; default: guest)\"guest\"\"admin\"\"host_admin\"\"restricted\"\"view_only\"type-name: Team type (required)\"appraiser\" for Appraiser.\"borrower\" for Borrower.\"borrower_counsel\" for Borrower Counsel.\"consultant\" for Consultant.\"engineer\" for Engineer.\"investor\" for Investor.\"leasing_broker\" for Leasing Broker.\"lender\" for `Lender.\"lender_counsel\" for Lender Counsel.\"mortgage_broker\" for Mortgage Broker.\"other\" for Other.\"owner\" for Owner.\"purchaser\" for Purchaser.\"purchaser_counsel\" for Purchaser Counsel.\"sales_broker\" for Sales Broker.\"seller\" for Seller.\"seller_counsel\" for Seller Counsel.\"surveyor\" for Surveyor.\"title_company\" for Title Company.members-emails: Comma-separated list of emails of users that should be invited to the team. This parameter is required. If you don't want to invite users during team creation, just send an empty array. Users that already have ProDeal account will automatically become Team users. Others will be invited to the system (receive an email invite).Note: It is required to add room relationship in the request body (check example).
\n403 error with error code ONLY_ORGANIZATION_MEMBERS_CAN_JOIN422 error with error code INVALID_FIELD_USER_IN_MULTIPLE_TEAMS_CONFLICTTo allow adding users in multiple teams, contact support.
\nAvailable \"include\" options:
\nusers: Team usersinvites: Pending invites in a teamOnly accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"team\",\n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"updated name\",\n \"type-name\": \"lender\",\n \"abbreviation\": \"UPD\",\n \"members-emails\": [\n \t\"user@example.com\"\n ]\n }\n }\n}"},"url":"http://localhost:4000//api/v2/teams/:team_id","description":"Note: There are limitations on certain fields:
\nTo add new users to a team, enter their emails in members-emails section.
{\n \"data\" : {\n \"type\": \"team\",\n \"id\": 1,\n \"attributes\": {\n \"members-emails\": [\n new_email1@example.com,\n new_email2@example.com\n ]\n }\n }\n}\nExisting ProDeal users will automatically become Team users. Others will be invited to the system (receive an email invite).
\nSetting members-emails to an empty array won't remove users from the team. Instead, use delete user from team and delete invite from team endpoints.
403 error with error code ONLY_ORGANIZATION_MEMBERS_CAN_JOIN422 error with error code INVALID_FIELD_USER_IN_MULTIPLE_TEAMS_CONFLICTTo allow adding users in multiple teams, contact support.
\nAvailable \"include\" options:
\nusers: Team usersinvites: Pending invites in a teamOnly accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/teams/:team_id","description":"Teams that are not empty (that contain users and invitations) cannot be deleted.
\n","urlObject":{"path":["api","v2","teams",":team_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"7c011236-3b7c-4766-9adc-dcc967204790","type":"string","value":"1","key":"team_id"}]}},"response":[{"id":"1bc09127-5de4-48b5-9712-72edd34e8d35","name":"Delete a team - not empty error","originalRequest":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"url":{"raw":"http://localhost:4000//api/v2/teams/:team_id","host":["http://localhost:4000/"],"path":["api","v2","teams",":team_id"],"variable":[{"key":"team_id","value":"1","type":"string"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"errors\": [\n {\n \"title\": \"403 Forbidden\",\n \"status\": \"403\",\n \"source\": {\n \"pointer\": null\n },\n \"detail\": \"You are not authorized to perform this action\",\n \"code\": \"FORBIDDEN\"\n }\n ]\n}"},{"id":"f1cc00cc-6490-465e-ab04-813f5c85c27f","name":"Team deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"http://localhost:4000//api/v2/teams/:team_id","host":["http://localhost:4000/"],"path":["api","v2","teams",":team_id"],"variable":[{"key":"team_id","value":"1"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"name":"cache-control","key":"cache-control","value":"max-age=0, private, must-revalidate","description":""},{"name":"content-length","key":"content-length","value":"0","description":""},{"name":"content-type","key":"content-type","value":"application/vnd.api+json","description":""},{"name":"date","key":"date","value":"Tue, 16 Oct 2018 19:49:09 GMT","description":""},{"name":"server","key":"server","value":"Cowboy","description":""},{"name":"x-request-id","key":"x-request-id","value":"refd626e2pq6q3rjjfpenof41mq0mm58","description":""}],"cookie":[{"expires":"Thu Jun 04 2020 15:25:03 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"GA1.1.1691954976.1528210849","key":"_ga"},{"expires":"Sun Jun 09 2019 19:30:09 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"d0795498-c8e7-461f-ac9a-32cf2175ee13","key":"intercom-id-d0rwjug4"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"libraryContent%3Dbrowse%26advImgDetails%3Dhide%26hidetb%3D0","key":"wp-settings-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"gabriel%40prodeal360.com","key":"last_email_loggedin"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":true,"value":"WP+Cookie+check","key":"wordpress_test_cookie"},{"expires":"Sun Sep 15 2019 23:12:23 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":false,"domain":"localhost","path":"/","secure":false,"session":false,"value":"1537052594","key":"wp-settings-time-1"},{"expires":"Tue Oct 23 2018 22:21:44 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":false,"value":"es","key":"pma_lang"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"258321d5693b72c21c1822711d7e611e","key":"phpMyAdmin"},{"expires":"Tue Oct 23 2018 22:47:00 GMT+0000 (Coordinated Universal Time)","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":false,"value":"%7B%22iv%22%3A%22vJDm%5C%2FWbbeiw9OwBZIAwRqQ%3D%3D%22%2C%22mac%22%3A%22fdfd47ebca09a61d176eab28211704e605f889ed%22%2C%22payload%22%3A%22dpuvhbnnBuU%5C%2FcWfeFHAJnA%3D%3D%22%7D","key":"pmaUser-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"%7B%22iv%22%3A%22oDZwYNwjWbHtCIMVF4HYWw%3D%3D%22%2C%22mac%22%3A%22f7dc03bdc2e058c862e8c4902bee107dcb492188%22%2C%22payload%22%3A%22F32XqdxcuphocRuxKdNhsl2Tx8cpSQQc15v2VNdlslg%3D%22%7D","key":"pmaAuth-1"},{"expires":"Invalid Date","hostOnly":true,"httpOnly":true,"domain":"localhost","path":"/","secure":false,"session":true,"value":"SFMyNTY.g3QAAAAGbQAAAAtfY3NyZl90b2tlbm0AAAAYZ2VJcFpFa3lwUFJiNC9BZ1hXanhzZz09bQAAAA9maWx0ZXJzX2RlYWxfaWRhA20AAAANZmlsdGVyc19wYXJ0eWQAA25pbG0AAAATZmlsdGVyc19zZWFyY2hfdGVybWQAA25pbG0AAAAOZmlsdGVyc19zdGF0dXNkAANuaWxtAAAAB3VzZXJfaWRhAQ.LmUDm0-lRj1-19E2Nphdu1P-oUXTEPbSLUO140ACBtY","key":"_prodeal360_key"}],"responseTime":null,"body":""}],"_postman_id":"1546036d-aaaa-4f87-8a27-80a455537dcc"},{"name":"Get team users","id":"cf3eb305-f1e0-4af0-9ee9-d01a826b4292","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/teams/:team_id/users","description":"The list of users that have accepted the invite and joined the team. User entity is explained in Users section.
\nHosts, Admins and Guests can see users in all teams in the room.
\n","urlObject":{"path":["api","v2","teams",":team_id","users"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"caade806-1699-473b-804b-e03c6ac65829","type":"string","value":"18","key":"team_id"}]}},"response":[{"id":"a71f2c38-6943-4318-8f21-a325261adaa6","name":"Get team users","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"url":{"raw":"http://localhost:4000//api/v2/teams/:team_id/users","host":["http://localhost:4000/"],"path":["api","v2","teams",":team_id","users"],"variable":[{"id":"4bb5e804-ddf2-4056-b9f7-1053b84ba049","key":"team_id","type":"string","value":"18"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 31 Mar 2020 12:57:13 GMT"},{"key":"content-length","value":"436"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2o0m9mld5vttfrcuj00021j1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": {\n \"self\": \"/api/v2/teams/18/users?page[size]=25\"\n },\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"user\",\n \"id\": \"4\",\n \"attributes\": {\n \"workspaces-flag-enabled\": false,\n \"online\": true,\n \"location\": null,\n \"last-seen-utc\": \"2020-03-31T12:57:14.186442\",\n \"last-name\": \"Doe\",\n \"job-title\": \"Developer\",\n \"is-org-admin\": false,\n \"is-certified\": true,\n \"full-name\": \"John Doe\",\n \"first-name\": \"John\",\n \"emails\": [\n \"user@example.com\"\n ],\n \"contact-details\": []\n }\n }\n ]\n}"}],"_postman_id":"cf3eb305-f1e0-4af0-9ee9-d01a826b4292"},{"name":"Delete user from team","id":"afbff004-b49c-4222-ae82-ac9f70a1d1dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [{\n \"type\": \"user\",\n \"id\": \"12\"\n }]\n}"},"url":"http://localhost:4000//api/v2/teams/:team_id/relationships/users","description":"Removing a user from the team will not remove that user from the system. Only the relationship between the user and the team will be deleted.
\n403 error with error code CANNOT_REMOVE_LAST_HOST will be returned.All users that are invited to a room are organized in teams. The Team role determines the actions its users can take within a room.
\nTeam has the following properties:
\nid: ID (read-only, auto-generated)name: Team name (required)type-name: Team type (required)role-id: Team role (required; default: guest)abbreviation: Team abbreviation (required; 5 characters max; default: first letters of each word of the team type)users-count: Number of users that accepted the invite and joined the teaminvites-count: Number of invited users, whose invite is pending (not yet accepted)is-member: Whether the current user is a member of the team or not.Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/teams/:team_id/invites","description":"Returns all the pending invitations for one team.
\nHosts, Admins and Guests can see pending invites in all teams in the room.
\n","urlObject":{"path":["api","v2","teams",":team_id","invites"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"b2c3dc4d-d73a-46a0-acd1-076083690c26","type":"string","value":"1","key":"team_id"}]}},"response":[{"id":"892e3857-4fa1-4e58-932e-232e2503ddc0","name":"Get team invites","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"url":{"raw":"http://localhost:4000//api/v2/teams/:team_id/invites","host":["http://localhost:4000/"],"path":["api","v2","teams",":team_id","invites"],"variable":[{"key":"team_id","type":"string","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 31 Mar 2020 13:00:42 GMT"},{"key":"content-length","value":"591"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2o0ma2q66jojfnnn5g0024b1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": {\n \"self\": \"/api/v2/teams/623/invites?page[size]=25\"\n },\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"invite\",\n \"id\": \"134\",\n \"attributes\": {\n \"last-sent-utc\": \"2019-10-31T18:39:53.003152\",\n \"inserted-at\": \"2019-09-27T07:50:40.57081\",\n \"email\": \"user1@example.com\"\n }\n },\n {\n \"type\": \"invite\",\n \"id\": \"137\",\n \"attributes\": {\n \"last-sent-utc\": \"2019-10-31T18:39:57.685457\",\n \"inserted-at\": \"2019-09-27T07:50:40.690043\",\n \"email\": \"user2@example.com\"\n }\n },\n {\n \"type\": \"invite\",\n \"id\": \"795\",\n \"attributes\": {\n \"last-sent-utc\": \"2019-11-26T09:24:27.144706\",\n \"inserted-at\": \"2019-11-26T04:24:27.1364\",\n \"email\": \"user3@example.com\"\n }\n }\n ]\n}"}],"_postman_id":"57cadff9-a547-4265-b792-34a07e36c752"},{"name":"Validate invitation","id":"5b97cb11-2303-45c0-b960-3e504c49c1fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"team-id\": \"2\",\n \"email\": \"test@example.com\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/invites/validate","urlObject":{"path":["api","v2","invites","validate"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"af15ed9a-37e3-4947-a7b0-a40089105e73","name":"[INVALID] When user is already member of a team in the room (Multiple teams OFF)","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"team-id\": \"4\",\n \"email\": \"user@example.com\"\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/teams/:team_id/invites/validate","host":["http://localhost:4000/"],"path":["api","v2","teams",":team_id","invites","validate"],"variable":[{"key":"team_id","type":"string","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Thu, 07 May 2020 17:11:02 GMT"},{"key":"content-length","value":"235"},{"key":"set-cookie","value":"_prodeal360=SFMyNTY.g3QAAAAGbQAAAAxhY2Nlc3NfdG9rZW5kAANuaWxtAAAACmV4cGlyZXNfaW5kAANuaWxtAAAADHJlZGlyZWN0X3VybGQAA25pbG0AAAANcmVmcmVzaF90b2tlbmQAA25pbG0AAAASc2Vzc2lvbl90aW1lb3V0X2F0Yl61kqZtAAAAB3VzZXJfaWRhAQ.CHYfdv4iiCaYP4BMM1ETpwWIknyYcVfEheWzNlDTS-E; path=/; HttpOnly"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2o6csbb4lkgimqscjk002491"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"invite-validation-result\",\n \"id\": \"team:4:user@example.com\",\n \"attributes\": {\n \"team\": {\n \"name\": \"Team X\",\n \"id\": 2,\n \"abbreviation\": \"TMX\"\n },\n \"is-valid\": false,\n \"error\": \"multiple_teams_member\"\n }\n }\n}"},{"id":"d7cd3c82-ac67-40f4-8d04-354d28f99b83","name":"[INVALID] When the email belongs to a user already in the team","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"team-id\": \"4\",\n \"email\": \"user@example.com\"\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/teams/:team_id/invites/validate","host":["http://localhost:4000/"],"path":["api","v2","teams",":team_id","invites","validate"],"variable":[{"key":"team_id","type":"string","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Thu, 07 May 2020 17:08:13 GMT"},{"key":"content-length","value":"163"},{"key":"set-cookie","value":"_prodeal360=SFMyNTY.g3QAAAAGbQAAAAxhY2Nlc3NfdG9rZW5kAANuaWxtAAAACmV4cGlyZXNfaW5kAANuaWxtAAAADHJlZGlyZWN0X3VybGQAA25pbG0AAAANcmVmcmVzaF90b2tlbmQAA25pbG0AAAASc2Vzc2lvbl90aW1lb3V0X2F0Yl61kf1tAAAAB3VzZXJfaWRhAQ.UXmK9LZ8g5fs73C_hKZB0Nqw9NoKE3msV4lR1cnAOMw; path=/; HttpOnly"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2o6cs1fur5gnk8mjsg002301"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"invite-validation-result\",\n \"id\": \"team:4:user@example.com\",\n \"attributes\": {\n \"is-valid\": false,\n \"error\": \"already_member\"\n }\n }\n}"},{"id":"d15e1b6c-39bc-4290-b759-857ff30c87ff","name":"[INVALID] Bad email format","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"team-id\": \"4\",\n \"email\": \"user#example.com\"\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/teams/:team_id/invites/validate","host":["http://localhost:4000/"],"path":["api","v2","teams",":team_id","invites","validate"],"variable":[{"key":"team_id","type":"string","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Thu, 07 May 2020 17:07:08 GMT"},{"key":"content-length","value":"155"},{"key":"set-cookie","value":"_prodeal360=SFMyNTY.g3QAAAAGbQAAAAxhY2Nlc3NfdG9rZW5kAANuaWxtAAAACmV4cGlyZXNfaW5kAANuaWxtAAAADHJlZGlyZWN0X3VybGQAA25pbG0AAAANcmVmcmVzaF90b2tlbmQAA25pbG0AAAASc2Vzc2lvbl90aW1lb3V0X2F0Yl61kbxtAAAAB3VzZXJfaWRhAQ.x3UIqY3vqzuz0B_qeyTVGHbXraDw54_fUaaKX9ttPkM; path=/; HttpOnly"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2o6crtmkhp6tp5prck0022v1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"invite-validation-result\",\n \"id\": \"team:4:user#example.com\",\n \"attributes\": {\n \"is-valid\": false,\n \"error\": \"invalid_format\"\n }\n }\n}"},{"id":"11a1ebb7-de26-47c0-acd9-28a08b05801f","name":"[VALID] Using Room Id","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"room-id\": \"2\",\n \"email\": \"user@example.com\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/invites/validate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Fri, 08 May 2020 21:25:13 GMT"},{"key":"content-length","value":"134"},{"key":"set-cookie","value":"_prodeal360=SFMyNTY.g3QAAAAGbQAAAAxhY2Nlc3NfdG9rZW5kAANuaWxtAAAACmV4cGlyZXNfaW5kAANuaWxtAAAADHJlZGlyZWN0X3VybGQAA25pbG0AAAANcmVmcmVzaF90b2tlbmQAA25pbG0AAAASc2Vzc2lvbl90aW1lb3V0X2F0Yl63H7ptAAAAB3VzZXJfaWRhAQ.-JQHheMarvh87F7xyjFhZZhv2a--8boG0OQTk9xqj1A; path=/; HttpOnly"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2o6il87r51viujhhq8002vt1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"invite-validation-result\",\n \"id\": \"room:2:user@example.com\",\n \"attributes\": {\n \"is-valid\": true\n }\n }\n}"},{"id":"a47ef4c6-e55b-42d1-9052-4cd93ad516a5","name":"[VALID] When email isn't in the system","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"team-id\": \"4\",\n \"email\": \"user@example.com\"\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/teams/:team_id/invites/validate","host":["http://localhost:4000/"],"path":["api","v2","teams",":team_id","invites","validate"],"variable":[{"key":"team_id","type":"string","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Thu, 07 May 2020 17:00:52 GMT"},{"key":"content-length","value":"131"},{"key":"set-cookie","value":"_prodeal360=SFMyNTY.g3QAAAAGbQAAAAxhY2Nlc3NfdG9rZW5kAANuaWxtAAAACmV4cGlyZXNfaW5kAANuaWxtAAAADHJlZGlyZWN0X3VybGQAA25pbG0AAAANcmVmcmVzaF90b2tlbmQAA25pbG0AAAASc2Vzc2lvbl90aW1lb3V0X2F0Yl61kERtAAAAB3VzZXJfaWRhAQ.533iKgFyuOljyf9lU0U-3xso8CMLzbB_rkSnddvJxqI; path=/; HttpOnly"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2o6cr7q1qeu8nr72n8001lg3"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"invite-validation-result\",\n \"id\": \"team:4:user@example.com\",\n \"attributes\": {\n \"is-valid\": true\n }\n }\n}"},{"id":"7bc137fa-26cc-45d1-9a23-54f128ce4fb2","name":"[VALID] When the email is already in the system","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"team-id\": \"4\",\n \"email\": \"user@example.com\"\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/teams/:team_id/invites/validate","host":["http://localhost:4000/"],"path":["api","v2","teams",":team_id","invites","validate"],"variable":[{"key":"team_id","type":"string","value":"4"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Thu, 07 May 2020 17:02:26 GMT"},{"key":"content-length","value":"181"},{"key":"set-cookie","value":"_prodeal360=SFMyNTY.g3QAAAAGbQAAAAxhY2Nlc3NfdG9rZW5kAANuaWxtAAAACmV4cGlyZXNfaW5kAANuaWxtAAAADHJlZGlyZWN0X3VybGQAA25pbG0AAAANcmVmcmVzaF90b2tlbmQAA25pbG0AAAASc2Vzc2lvbl90aW1lb3V0X2F0Yl61kKJtAAAAB3VzZXJfaWRhAQ.9HbFA4TNwAL72cCPJgP5rTl_Fd3JQDxf1vMbBwwaGcg; path=/; HttpOnly"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2o6crd9jts65c84htc0022t1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"invite-validation-result\",\n \"id\": \"team:4:user@example.com\",\n \"attributes\": {\n \"user\": {\n \"id\": 1,\n \"full_name\": \"John Doe\"\n },\n \"is-valid\": true\n }\n }\n}"}],"_postman_id":"5b97cb11-2303-45c0-b960-3e504c49c1fc"},{"name":"Validate multiple validations","id":"4e090904-f9d8-455a-b5c8-6c17bd72a7e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"team-id\": \"2\",\n \"email\": \"test1@example.com\"\n }\n },\n {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"team-id\": \"2\",\n \"email\": \"test2@example.com\"\n }\n }\n ]\n}"},"url":"http://localhost:4000//api/v2/invites/validate","urlObject":{"path":["api","v2","invites","validate"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e090904-f9d8-455a-b5c8-6c17bd72a7e3"},{"name":"Validate multiple validations Copy","id":"d03cc706-ef3c-4547-b713-f4433130ac84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"team-id\": \"2\",\n \"email\": \"test1@example.com\"\n }\n },\n {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"team-id\": \"2\",\n \"email\": \"test2@example.com\"\n }\n }\n ]\n}"},"url":"http://localhost:4000//api/v2/invites/validate","urlObject":{"path":["api","v2","invites","validate"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[],"_postman_id":"d03cc706-ef3c-4547-b713-f4433130ac84"},{"name":"Resend invitation","id":"37ff9144-228c-42cb-a8ea-7261a0b30225","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/invites/:invite_id/resend","description":"Send invitation email again.
\nThe same rules apply as when adding users to a team (editing team).
\n","urlObject":{"path":["api","v2","invites",":invite_id","resend"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"415c976b-7dd5-4407-913a-3b029e718901","type":"string","value":"5","key":"invite_id"}]}},"response":[{"id":"db9948a4-e3c7-4274-9b5c-6b6437245529","name":"Resend invite","originalRequest":{"method":"POST","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"url":{"raw":"http://localhost:4000//api/v2/invites/:invite_id/resend","host":["http://localhost:4000/"],"path":["api","v2","invites",":invite_id","resend"],"variable":[{"key":"invite_id","value":"5"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Thu, 02 May 2019 19:35:35 GMT"},{"key":"content-length","value":"0"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2mdf9giosrh4p4rtvo001rq1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"content-type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"37ff9144-228c-42cb-a8ea-7261a0b30225"},{"name":"Validate invitation","id":"e5a88d2d-9085-43a2-b062-f0717f57d348","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"room-id\": \"2\",\n \"email\": \"user1org1@prodeal360.com\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/invites/validate","description":"An endpoint used to check if an invitation can be correctly sent. There are several return types for both invalid and valid invitations. All of them return status code 200.
invalid_format - Wrong email address format.already_member - When the email address belongs to the user already in the team.multiple_teams_member - When the email address belongs to the user who is already a member of a team in the same room.private_room_unknown_user - When the email address does not belong to the domain associated with the organization.private_room_user_organization - When the email address belongs to a user in the system that is a member of another organization (not whitelisted for the room).You can test an invitation validity against a team or a room:
\n{\n \"data\": {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"room-id\": \"2\",\n \"email\": \"user@example.com\"\n }\n }\n}\n{\n \"data\": {\n \"type\": \"invite-validation-request\",\n \"attributes\": {\n \"team-id\": \"4\",\n \"email\": \"user@example.com\"\n }\n }\n}\nOnly accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [{\n \"type\": \"invite\",\n \"id\": \"4\"\n }]\n}"},"url":"http://localhost:4000//api/v2/teams/:team_id/relationships/invites","description":"When the invite is deleted, the user with the invitation email can no longer create an account in ProDeal.
\nThe same rules apply as when adding users to a team (editing team).
\n","urlObject":{"path":["api","v2","teams",":team_id","relationships","invites"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"49caebc3-989a-411e-bd67-9f6cedfa3c2d","type":"string","value":"6","key":"team_id"}]}},"response":[{"id":"7f9e372e-f309-4245-aa7b-057a205e6cb8","name":"Delete invite from team","originalRequest":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [{\n \"type\": \"invite\",\n \"id\": \"4\"\n }]\n}"},"url":{"raw":"http://localhost:4000//api/v2/teams/:team_id/relationships/invites","host":["http://localhost:4000/"],"path":["api","v2","teams",":team_id","relationships","invites"],"variable":[{"key":"team_id","value":"6"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Thu, 02 May 2019 19:32:42 GMT"},{"key":"content-length","value":"0"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2mdf96f48hg3g7r4ko001qr1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"content-type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0c45a667-c97a-4756-9adb-5cfc5830fdc9"}],"id":"366299d4-4a7b-4692-bdb7-9e5e0858a0a6","description":"Invites represent people added to a team, who have not yet created a ProDeal account.
\nAn invite contains the following parameters:
\nid: ID (read-only, auto-generated)last-sent-utc: A date in ISO format indicating when was the invitation last sent (since invitations can be sent multiple times). (read-only, auto-generated)inserted-a: A date in ISO format indicating when was the invitation created. (read-only, auto-generated)email: Email of the invited user (read-only)Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/changelogs?page[size]=25&page[offset]=80000","description":"roomsearch_termroom_typebuilding_typebookmarkeddate_startdate_enduserteamactionFilters user, team and action allow filtering by multiple elements (Use a comma-separated list of values).\nThe date_start and date_end filters allow to filter the entries by date range. The supported format for the date is ISO8601 (YYYY-MM-DD).
To filter by a metadata key you can use the key name with the meta_ prefix:
?filter[meta_{meta_key}]={meta_value}
Available \"include\" options:
\nroom: The entry roomFor optimization purposes, different pagination rules can be applied to this endpoint.
\npage[size] Number of records to retrievepage[offset] ID of the previous record (activity log entry) to use as the starting point of the pagination. It's in descending orderThe activity of every room (creation, deletion, editing, status update, download, upload, permission update, invite, etc.) is recorded automatically and it's accessible to users when the room option Activity Report (changelog-enabled) is turned ON. Users can see activity logs for all rooms they are a part of, and these logs can be filtered.
One activity log entry contains the following attributes:
\nis-read: true when the entry is returned the first timeinserted-at: Creation timechanges: An array of strings for each detected change on the action (Could be empty)author: Who performs the action (could not exist anymore, this is historical data)author-teams: The team(s) author belonged to when he made the change (could not exist anymore, this is historical data)action: The type of changelog actionaccess_change_documentaccess_change_headingaccess_change_line_itemadd_member_partyclose_folderclose_headingclose_line_itemdelete_documentdelete_folderdelete_headingdelete_line_itemdelete_notedelete_partydownload_bulk_selectdownload_documentinactivate_dealmark_final_documentnew_custom_valuenew_dealnew_documentnew_due_datenew_foldernew_headingnew_invitenew_line_itemnew_notenew_partyopen_folderopen_headingopen_line_itemreactivate_dealremove_member_partyrename_documentrename_folderrename_headingrename_line_itemunmark_final_documentupdate_dealupdate_inviteupdate_partyview_documentNote: \"party\" refers to teams.
\n","event":[{"listen":"prerequest","script":{"id":"efea509e-1e8b-41d6-9822-a38ef7841b7a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a7a6b738-e5ff-4691-a944-070bc20d44b8","type":"text/javascript","exec":[""]}}],"_postman_id":"721696c3-ff9c-494d-9707-e76c474328f6"},{"name":"Notifications","item":[{"name":"Get default notifications settings","id":"0e0bb8dc-b8f5-496a-99f5-aa96deeb4282","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/me/notifications","description":"Default notification settings are applied for all future rooms you create or into which you are added.\nThese can be overridden for each room.
\n","urlObject":{"path":["api","v2","me","notifications"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"65462c76-52e8-4eee-b12e-fbbbb031639e","name":"Get default notifications settings","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/me/notifications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Wed, 05 Jun 2019 12:46:13 GMT"},{"key":"content-length","value":"485"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2miks9lp69h1nhpjmk004uq8"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"2.0\"\n },\n \"data\": {\n \"type\": \"user-notifications-settings\",\n \"id\": \"1\",\n \"attributes\": {\n \"new-line-item-note\": {\n \"realtime\": \"all\",\n \"daily_recap\": true\n },\n \"line-item-status-changed\": {\n \"realtime\": \"none\",\n \"daily_recap\": true\n },\n \"file-version-upload\": {\n \"realtime\": \"my_responsibility\",\n \"daily_recap\": true\n },\n \"document-approved\": {\n \"realtime\": \"none\",\n \"daily_recap\": true\n },\n \"custom-column-updated\": {\n \"realtime\": \"none\",\n \"daily_recap\": true\n },\n \"checklist-item-deletion\": {\n \"realtime\": \"none\",\n \"daily_recap\": true\n },\n \"access-changed\": {\n \"realtime\": \"none\",\n \"daily-recap\": true\n }\n }\n }\n}"}],"_postman_id":"0e0bb8dc-b8f5-496a-99f5-aa96deeb4282"},{"name":"Update default notification settings","id":"363ca082-391c-4e0c-a68b-c3fdfd2e6e2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","name":"Content-Type","value":"application/vnd.api+json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"user-notifications-settings\",\n \"attributes\": {\n \"new-line-item-note\": {\n \"realtime\": \"all\",\n \"daily_recap\": true\n },\n \"line-item-status-changed\": {\n \"realtime\": \"all\",\n \"daily_recap\": true\n },\n \"file-version-upload\": {\n \"realtime\": \"my_responsibility\",\n \"daily_recap\": true\n }\n }\n }\n}"},"url":"http://localhost:4000//api/v2/me/notifications","urlObject":{"path":["api","v2","me","notifications"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[],"_postman_id":"363ca082-391c-4e0c-a68b-c3fdfd2e6e2b"}],"id":"ae175d5b-2330-4781-a36a-aac65ab390b5","description":"Keep track on your deal by setting up various email notifications.
\nchecklist-item-deletion: Deletion Updates. When a heading, line item or document has been deleted.custom-column-updated: Custom Column Updates. When the custom column value has been updated on a heading, line item or folder.document-approved: Document Status Updates. When a document has been marked as final.file-version-upload: Document Updates. When a document has been uploaded, or a new version of an existing document has been updated.line-item-status-changed: Line Item Status Updates. When a line item has been closed or reopened.new-line-item-note: Notes Updates. When a note has been posted, edited or deleted on a heading, line item or folder.access-changed: Access Updates\nWhen a heading, line item, folder or document access permissions have been updated.realtime: Send notifications for the event on real time for:
all: For all the event occurrencesmy_responsibility: For events on items below responsibilitynone: Disable real time notifications for that eventdaily_recap: (true or false) Display the event in the daily recap emails
Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/sfdc/opportunities/:opportunity_id","description":"Use this endpoint to check if there are any rooms in ProDeal associated with the given Salesforce opportunity ID.
\nThere are 3 scenarios:
\nYou can connect your Salesforce opportunity with the matching room(s) in ProDeal.
\nTo achieve that, you need to get the opportunity ID from Salesforce and assign it to the room's metadata > sfdc_opportunity_id property.
Example (the following room matches the Salesforce opportunity with ID 12345)
\n{\n\"data\": {\n \"type\": \"room\", \n \"id\": \"1\",\n \"attributes\": {\n \"name\": \"Salesforce Room\",\n ...\n \"metadata\": {\n \"sfdc_opportunity_id\": \"12345\"\n } \n}\nOnly accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/resthooks/subscriptions","urlObject":{"path":["api","v2","resthooks","subscriptions"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"100a5572-8fff-4352-92d9-f0e7ec28b86e","name":"Get all subscriptions","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/resthooks/subscriptions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 26 Nov 2019 20:55:50 GMT"},{"key":"content-length","value":"554"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2ndd3m97c407a1obgg0026p1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": [\n {\n \"type\": \"resthooks-subscription\",\n \"id\": \"1\",\n \"attributes\": {\n \"target-url\": \"https://example.com\",\n \"filter\": \"entityIds=3\",\n \"event\": \"folder_updated\",\n \"active\": true\n }\n },\n {\n \"type\": \"resthooks-subscription\",\n \"id\": \"2\",\n \"attributes\": {\n \"target-url\": \"https://example.com\",\n \"filter\": \"roomIds=3,4,5&attributes=name,status\",\n \"event\": \"folder_updated\",\n \"active\": true\n }\n },\n {\n \"type\": \"resthooks-subscription\",\n \"id\": \"3\",\n \"attributes\": {\n \"target-url\": \"https://example.com\",\n \"filter\": \"roomIds=12,13&attributes=custom-value\",\n \"event\": \"folder_updated\",\n \"active\": true\n }\n }\n ]\n}"}],"_postman_id":"77e21fb8-0efb-4d78-8b7c-71f6107f0f9c"},{"name":"Get subscription","id":"39efe2a7-5979-4f44-add5-1efed607614c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"}],"url":"http://localhost:4000//api/v2/resthooks/subscriptions/:subscription_id","urlObject":{"path":["api","v2","resthooks","subscriptions",":subscription_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"525233e0-c8d9-4ae3-9d52-a20ba1423c29","type":"string","value":"1","key":"subscription_id"}]}},"response":[{"id":"b0f3c0a9-05d3-4c4f-acb3-8c202aea9e9e","name":"Get subscription","originalRequest":{"method":"GET","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"}],"url":{"raw":"http://localhost:4000//api/v2/resthooks/subscriptions/:subscription_id","host":["http://localhost:4000/"],"path":["api","v2","resthooks","subscriptions",":subscription_id"],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 26 Nov 2019 20:48:58 GMT"},{"key":"content-length","value":"191"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2ndd2ubog0f0gnpkls0026j1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"resthooks-subscription\",\n \"id\": \"1\",\n \"attributes\": {\n \"target-url\": \"https://example.com\",\n \"filter\": \"entityIds=3\",\n \"event\": \"folder_updated\",\n \"active\": true\n }\n }\n}"}],"_postman_id":"39efe2a7-5979-4f44-add5-1efed607614c"},{"name":"Create subscription","id":"47d72662-7768-45f8-96e0-0ca3048e54ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/vnd.api+json","description":"JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"resthooks-subscription\",\n \"attributes\": {\n \"target-url\": \"https://example.com\",\n \"filter\": \"roomIds=3,4,5&attributes=name,status\",\n \"event\": \"folder_updated\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/resthooks/subscriptions","description":"Required parameters: target-url and event.
Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/vnd.api+json","description":"JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \t\"id\": \"3\",\n \"type\": \"resthooks-subscription\",\n \"attributes\": {\n \"target-url\": \"https://example.com\",\n \"filter\": \"roomIds=12,13&attributes=custom-value\",\n \"event\": \"folder_updated\"\n }\n }\n}"},"url":"http://localhost:4000//api/v2/resthooks/subscriptions/:subscription_id","urlObject":{"path":["api","v2","resthooks","subscriptions",":subscription_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"8dac347f-88e5-47a1-b736-af21e342f89d","type":"string","value":"3","key":"subscription_id"}]}},"response":[{"id":"a7dfe428-8d7e-4960-a740-bf93ddfd5622","name":"Edit subscription","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/vnd.api+json","description":"JSON-API document","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \t\"id\": \"3\",\n \"type\": \"resthooks-subscription\",\n \"attributes\": {\n \"target-url\": \"https://example.com\",\n \"filter\": \"roomIds=12,13&attributes=custom-value\",\n \"event\": \"folder_updated\"\n }\n }\n}"},"url":{"raw":"http://localhost:4000//api/v2/resthooks/subscriptions/:subscription_id","host":["http://localhost:4000/"],"path":["api","v2","resthooks","subscriptions",":subscription_id"],"variable":[{"key":"subscription_id","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 26 Nov 2019 20:58:11 GMT"},{"key":"content-length","value":"217"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2ndd3ugjgqhd5biqc40026s1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"resthooks-subscription\",\n \"id\": \"3\",\n \"attributes\": {\n \"target-url\": \"https://example.com\",\n \"filter\": \"roomIds=12,13&attributes=custom-value\",\n \"event\": \"folder_updated\",\n \"active\": true\n }\n }\n}"}],"_postman_id":"3f7e7416-40aa-4091-8916-f398b0352f11"},{"name":"Delete subscription","id":"19ca80de-9688-46d2-869f-f86ec383a45b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/vnd.api+json","description":"JSON-API document
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"http://localhost:4000//api/v2/resthooks/subscriptions/:subscription_id","urlObject":{"path":["api","v2","resthooks","subscriptions",":subscription_id"],"host":["http://localhost:4000/"],"query":[],"variable":[{"id":"c48c1451-83bb-4e12-a158-b19bb00115d3","type":"string","value":"1","key":"subscription_id"}]}},"response":[{"id":"bc13fdd7-d60d-4605-8ede-17ed45a84b2b","name":"Delete subscription","originalRequest":{"method":"DELETE","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"key":"Content-Type","value":"application/vnd.api+json","description":"JSON-API document","type":"text"}],"body":{"mode":"raw","raw":""},"url":{"raw":"http://localhost:4000//api/v2/resthooks/subscriptions/:subscription_id","host":["http://localhost:4000/"],"path":["api","v2","resthooks","subscriptions",":subscription_id"],"variable":[{"key":"subscription_id","value":"1"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 26 Nov 2019 20:56:59 GMT"},{"key":"content-length","value":"0"},{"key":"cache-control","value":"no-store, no-cache"},{"key":"x-request-id","value":"2ndd3qapsnfn50lo980026q1"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"0"},{"key":"content-type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"19ca80de-9688-46d2-869f-f86ec383a45b"}],"id":"29367b67-6dfd-4219-bf9f-87bd37ec149c","description":"REST hooks are automated messages sent from apps when something happens. They have a message (or payload) and are sent to a unique URL. They are typically used to connect two different applications. When an event happens on the trigger application, it serializes data about that event and sends it to a REST hook URL from the action application (the one you want to do something based on the data from the first application).
\nA subscription allows the users to observe events they want to.
\nProDeal supports subscriptions for the following events:
\nfolder_updated - Triggered when folder attributes changeroom_updated - Triggered when room attributes changeroom_progress_updated - Triggered when room progress changes (folders at line items level get opened/closed)The filter allows the user to limit the notifications to only those that are of interest. The filter string is in URL query format and the parameter names depend on the event.
\nentityIds - Only the events on the resources with that IDroomIds - Only the events in the rooms with those IDs (available only for folder_updated)attributes - Only when one of the attributes listed is changed (available for folder_updated and room_updated)If the parameter is an array, you can use the comma to add multiple values:\nentityIds=5,6,7,8,9&attributes=name,status
Filters are exclusive: The event needs to match all of them to be promoted as a notification.
\nTry to not be redundant. For a folder_update:\nentityIds=32412&roomIds=213
If you can identify the resource with the entity ID, the room Id is not necessary.
\nFilters don’t check the IDs when the subscription is created, you can indicate values that will never match, like a room and a folder from another room.\nHowever, if you try to use a parameter that is not defined for the event an exception will be returned.
\n","event":[{"listen":"prerequest","script":{"id":"5ec1e315-37b4-4460-b7e1-774971eeb41f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fa3a5e39-06cf-464d-b84e-8302b0dd342e","type":"text/javascript","exec":[""]}}],"_postman_id":"29367b67-6dfd-4219-bf9f-87bd37ec149c"}],"id":"3a5d0b6d-4e8d-48a7-b5c3-f567f77f206d","description":"ProDeal can easily integrate into your existing workflows. Check out our:
\nOnly accept JSON-API documents
\n","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document
\n","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"organization\",\n \"attributes\": {\n \"mfa-required\": false\n \n }\n }\n}"},"url":"http://localhost:4000//api/v2/organizations/me","urlObject":{"path":["api","v2","organizations","me"],"host":["http://localhost:4000/"],"query":[],"variable":[]}},"response":[{"id":"cca0d54a-e54d-4fdc-b630-b5dfbd6ecf23","name":"Update an organization","originalRequest":{"method":"PATCH","header":[{"description":"Only accept JSON-API documents","key":"Accept","value":"application/vnd.api+json"},{"description":"Return JSON-API document","key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"organization\",\n \"attributes\": {\n \"mfa-required\": false\n\n }\n }\n}"},"url":"http://localhost:4000//api/v2/organizations/me"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"263"},{"key":"content-type","value":"application/vnd.api+json; charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"jsonapi\": {\n \"version\": \"1.0\"\n },\n \"data\": {\n \"type\": \"organization\",\n \"id\": \"1\",\n \"attributes\": {\n \"status-merged-enabled\": false,\n \"name\": \"Capital Bancshares 11\",\n \"mfa-required\": false,\n \"file-counter-enabled\": true,\n \"esignature-annotations-enabled\": false,\n \"domains\": null,\n \"default\": true,\n \"sso-enabled\": false\n }\n }\n}"}],"_postman_id":"2643ef13-e9f2-438a-9a7d-8f643237aa91"}],"id":"b30c7158-2e4f-42b4-9dd1-bf083be861a4","_postman_id":"b30c7158-2e4f-42b4-9dd1-bf083be861a4","description":""}],"id":"cb276d46-5cd8-4c4e-86ad-3ad01daa378c","description":"This is the stable version of the ProDeal API.
\n","event":[{"listen":"prerequest","script":{"id":"e5b5ee2f-0a90-4935-af03-cde48a102497","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"55a4d9cd-7023-4aad-8976-8023632ad547","type":"text/javascript","exec":[""]}}],"_postman_id":"cb276d46-5cd8-4c4e-86ad-3ad01daa378c"}],"event":[{"listen":"prerequest","script":{"id":"f3627c41-8e79-4eca-96ae-1c46d211ca47","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b6c42dd5-7f97-4c1f-8a96-24514188e643","type":"text/javascript","exec":[""]}}],"variable":[{"key":"base_url","value":"http://localhost:4000/"}]}