{"info":{"_postman_id":"64a47b42-9dfb-414e-a86d-1d01709c2498","name":"SendSafely REST API","description":"

SendSafely REST API. For more information visit developer.sendsafely.com.

\n

Pagination. The SendSafely Rest API uses the \"pageSize\" and “rowIndex\" parameters for endpoints that support pagination.

\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19611653","collectionId":"64a47b42-9dfb-414e-a86d-1d01709c2498","publishedId":"2sBXcBmMsp","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-12T17:14:36.000Z"},"item":[{"name":"package","item":[{"name":"{package Id}","item":[{"name":"recipient","item":[{"name":"{recipient Id}","item":[{"name":"Get Recipient","id":"14fa5f74-a7d0-4b4f-a324-8c8a94427cf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/","description":"

This endpoint returns the details for a specific recipient on a package.

\n","urlObject":{"path":["package",":packageId","recipient",":recipientId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"75081fd7-c4ec-4fc6-b88b-f4f7c339a1d8","type":"any","value":"","key":"packageId"},{"id":"818b3feb-91aa-4c59-af04-71877db23675","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"67527efe-5bbf-4200-89b0-05ec06cecf34","name":"Get Recipient Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//recipient//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"approvalRequired\": \"\", \"checkForPublicKeys\": \"\", \"recipientId\": \"\", \"email\": \"\", \"phonenumbers\": [ { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" }, { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" } ], \"fullName\": \"\", \"smsAuth\": \"\", \"isPackageOwner\": \"\", \"roleName\": \"\", \"response\": \"\"}"}],"_postman_id":"14fa5f74-a7d0-4b4f-a324-8c8a94427cf8"},{"name":"Update Recipient","id":"b47189fb-0922-493c-bafc-99f6bdfbcc21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"countrycode\": \"\", \"phoneNumber\": \"\", \"roleName\": \"\", \"workspaceNotificationPreference\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/","description":"

This endpoint updates the details for a specific recipient on a package.

\n","urlObject":{"path":["package",":packageId","recipient",":recipientId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"bbc81a46-239d-4216-ba41-9659cf77c219","type":"any","value":"","key":"packageId"},{"id":"9895f631-3079-4380-955e-aaa3d3a875bb","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"c0824be6-c943-4ec9-a41f-7386ca805320","name":"Update Recipient Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"role\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//recipient//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"approvalRequired\": \"\", \"checkForPublicKeys\": \"\", \"recipientId\": \"\", \"email\": \"\", \"phonenumbers\": [ { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" }, { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" } ], \"fullName\": \"\", \"smsAuth\": \"\", \"isPackageOwner\": \"\", \"roleName\": \"\", \"response\": \"\"}"}],"_postman_id":"b47189fb-0922-493c-bafc-99f6bdfbcc21"},{"name":"Remove Recipient","id":"fb4dc742-c0d6-486a-8e14-ab48bc8acc51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/","description":"

This endpoint removes a specific recipient from a package. If the recipient has already downloaded files from the package, they may be disabled instead.

\n","urlObject":{"path":["package",":packageId","recipient",":recipientId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"1851a4a2-f028-4506-be1b-0b111fc88a36","type":"any","value":"","key":"packageId"},{"id":"a23f2eab-f9de-40f2-bb58-b19e6c2c732b","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"f6fb2b3e-1ac0-48ef-acd2-29b3bb0b2959","name":"Remove Recipient Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//recipient//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"fb4dc742-c0d6-486a-8e14-ab48bc8acc51"},{"name":"Get Recipient Public Keys","id":"5aaf03fc-422d-4d99-ba94-5372767d6fba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/:recipientId/public-keys/","description":"

This endpoint allows you to return the public keys related to a single recipient on the package.

\n","urlObject":{"path":["package",":packageId",":recipientId","public-keys",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"af1dab2b-f1cc-4588-85ac-9dc173cb18a5","type":"any","value":"","key":"packageId"},{"id":"cfffb98b-cfc5-47f2-8d0f-46dcd9b86e31","type":"any","value":"","key":"recipientId"}]}},"response":[{"id":"2a9dabe2-b792-447e-b933-77704d91b9e3","name":"Get Recipient Public Keys Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package///public-keys/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"publicKeys\": [ { \"id\": \"\", \"key\": \"\" }, { \"id\": \"\", \"key\": \"\" } ], \"response\": \"\"}"}],"_postman_id":"5aaf03fc-422d-4d99-ba94-5372767d6fba"},{"name":"Get Recipient Permissions","id":"9447dc4b-78f0-4083-b649-2f0790a520e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/permissions/","description":"

This endpoint returns the list of permissions that have been granted to a specific recipient in a workspace.

\n","urlObject":{"path":["package",":packageId","recipient",":recipientId","permissions",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"953daf4c-1c63-4814-881b-c92a58a9a893","type":"any","value":"","key":"packageId"},{"id":"d23de9eb-d11e-491b-9a9f-c312f0be562d","type":"any","value":"","key":"recipientId"}]}},"response":[],"_postman_id":"9447dc4b-78f0-4083-b649-2f0790a520e3"}],"id":"eac336c1-4deb-4a8c-b77f-b428081c3e51","description":"

The Recipient ID is a unique identifier specific to one recipient on a single package.

\n","_postman_id":"eac336c1-4deb-4a8c-b77f-b428081c3e51"},{"name":"Add Recipient","id":"3cc9d8e4-b6dc-4b5f-9980-9b1663af465b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"email\": \"\", \"phoneNumber\": \"\", \"countryCode\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/","description":"

This endpoint adds a new recipient to a package.

\n","urlObject":{"path":["package",":packageId","recipient",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"fabdc746-f214-4c05-a5c8-69c48be294d4","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"12d83c20-84fb-459b-acb8-bda0b2fbff9b","name":"Add Recipient Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"email\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//recipient/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"approvalRequired\": \"\", \"checkForPublicKeys\": \"\", \"recipientId\": \"\", \"email\": \"\", \"phonenumbers\": [ { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" }, { \"countryCode\": \"\", \"phonenumber\": \"\", \"wasUsedMostRecently\": \"\" } ], \"fullName\": \"\", \"smsAuth\": \"\", \"isPackageOwner\": \"\", \"roleName\": \"\", \"response\": \"\"}"}],"_postman_id":"3cc9d8e4-b6dc-4b5f-9980-9b1663af465b"},{"name":"Add Recipients","id":"2df2ac0d-a4ad-4ebc-b3c4-ae0a5bf5b19c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"emails\": [\"\", \"\"], \"autoEnableSMS\": \"false\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipients/","description":"

This endpoint allows you to add multiple recipients to a single package at once.

\n","urlObject":{"path":["package",":packageId","recipients",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"0867456e-957b-4653-9d7d-147b638055ff","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"b3f0711d-8609-4e85-8877-60e11828da13","name":"Add Recipients Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["package",":packageId","recipient",""],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"approvalRequired\": \"\", \"recipients\": [ { \"recipientId\": \"\", \"email\": \"\", \"fullName\": \"\", \"needsApproval\": \"\", \"recipientCode\": \"\", \"confirmations\": {\"ipAddress\": \"\",\"timestamp\": \"\",\"timeStampStr\": \"\",\"isMessage\": \"\" }, \"isPackageOwner\": \"\", \"checkForPublicKeys\": \"\", \"roleName\": \"\" }, { \"recipientId\": \"\", \"email\": \"\", \"fullName\": \"\", \"needsApproval\": \"\", \"recipientCode\": \"\", \"confirmations\": {\"ipAddress\": \"\",\"timestamp\": \"\",\"timeStampStr\": \"\",\"isMessage\": \"\" }, \"isPackageOwner\": \"\", \"checkForPublicKeys\": \"\", \"roleName\": \"\" } ], \"response\": \"\"}"}],"_postman_id":"2df2ac0d-a4ad-4ebc-b3c4-ae0a5bf5b19c"},{"name":"Delete Recipients","id":"6463bc5b-8f0a-49fd-bfee-dcd74af8fc5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipients/","description":"

This endpoint allows you to delete all recipients from a single package at once.

\n","urlObject":{"path":["package",":packageId","recipients",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"f4f00623-af1c-46a8-9ae7-4124bc252400","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"b03a7095-b644-432e-b2bd-76ad564d0365","name":"Delete Recipients Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipients/","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["package",":packageId","recipients",""],"variable":[{"key":"packageId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packageId\": \"\", \n \"response\":\"SUCCESS\", \n \"results\": \n {\n \"recipients\": [{\"email\": \"\"}], \n \"contactGroups\": [{\"groupName\": \"\", \"groupId\": \"\"}]\n }\n}"}],"_postman_id":"6463bc5b-8f0a-49fd-bfee-dcd74af8fc5e"}],"id":"99b07963-729f-4005-a46f-2887e3e14916","description":"

A recipient is an individual authorized by the package owner with permission to access a package.

\n","_postman_id":"99b07963-729f-4005-a46f-2887e3e14916"},{"name":"file","item":[{"name":"{file Id}","item":[{"name":"Get File Upload Urls","id":"a14fcc65-28a8-41ad-8d1c-4cd4d0ee70b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"part\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/upload-urls/","description":"

This endpoint returns the file part upload URLs for a file. Up to 25 file part URLs are returned at a time. To fetch the first set of URLs, either omit the \"offset\" parameter or set the offset value to 0.

\n","urlObject":{"path":["package",":packageId","file",":fileId","upload-urls",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"8b7d8f6e-a182-431e-8651-f8dcbdf1e5b7","type":"any","value":"","key":"packageId"},{"id":"7e89f2c1-f822-44b6-abe6-2e6181ec2caf","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"d6a4366d-4608-4d08-94e7-6c3d647824bc","name":"Get File Upload Urls Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"part\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//file//upload-urls/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"uploadUrls\": [ { \"part\": \"\", \"url\": \"\" }, { \"part\": \"\", \"url\": \"\" } ]}"}],"_postman_id":"a14fcc65-28a8-41ad-8d1c-4cd4d0ee70b4"},{"name":"Set File Upload Complete","id":"23723bb0-7137-4d03-97d7-a10682ea16e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"directoryId\": \"\", \"complete\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/upload-complete/","description":"

This endpoint is used to sets the file upload status as complete. The server will verify that all of the required file parts are present within S3.

\n","urlObject":{"path":["package",":packageId","file",":fileId","upload-complete",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"bed9bc46-cfe5-44ef-922e-5581069a71d3","type":"any","value":"","key":"packageId"},{"id":"0fff7b47-2997-4b06-b971-2be40f56cc98","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"d08c6c19-60a2-4989-b3b8-bbd40707d606","name":"Set File Upload Complete Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"complete\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//file//upload-complete/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"23723bb0-7137-4d03-97d7-a10682ea16e9"},{"name":"Get File Download Urls","id":"87d44a52-c15f-4e5c-b5ca-c648f1a23c52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"checksum\": \"\", \"startSegment\": \"\", \"endSegment\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/download-urls/","description":"

This endpoint returns the file part download URLs for a file. Up to 25 file part URLs are returned at a time. To fetch the first set of URLs, either omit the \"offset\" parameter or set the offset value to 0.

\n","urlObject":{"path":["package",":packageId","file",":fileId","download-urls",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"ac73c7d2-c666-4978-8e09-6068ae882e20","type":"any","value":"","key":"packageId"},{"id":"79e9a290-df58-42a0-ac6d-6c83c3ab89ac","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"959a67d2-bb6c-44fe-aa1a-0e9b31e45b03","name":"Get File Download Urls Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//file//download/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"87d44a52-c15f-4e5c-b5ca-c648f1a23c52"},{"name":"Copy File To Workspace","id":"1310d89a-c507-4d29-86db-a278b8269932","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"targetPackageId\": \"\",\"targetDirectoryId\": \"\",\"uploadType\": \"\",\"fileKey\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/copy/","description":"

This endpoint allows you to copy a file from a Transfer or Dropzone package into a SendSafely Workspace.

\n","urlObject":{"path":["package",":packageId","file",":fileId","copy",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"86adc797-c47b-4b51-b0e1-fbd40b625162","type":"any","value":"","key":"packageId"},{"id":"5b52f3cc-3dfd-4bab-9392-60bb7c457451","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"ec8eefdf-1fea-4b91-8f3c-9effe11b96c8","name":"Copy File To Workspace Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"targetPackageId\": \"\",\"targetDirectoryId\": \"\",\"uploadType\": \"\",\"fileKey\": \"\"}"},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/copy/","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["package",":packageId","file",":fileId","copy",""],"variable":[{"key":"packageId","value":""},{"key":"fileId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1310d89a-c507-4d29-86db-a278b8269932"},{"name":"Update File","id":"0bce3801-bb2b-4a7f-a4b1-21462aefd100","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"body":{"mode":"raw","raw":"{\"fileName\": \"\", \"fileState\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/","description":"

This endpoint lets you update details for a specific file.

\n","urlObject":{"path":["package",":packageId","file",":fileId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"64fa74e3-5d92-48de-af3a-fe7d28f81054","type":"any","value":"","key":"packageId"},{"id":"4a1b350b-b3b2-4faf-b9dc-a2331c07a044","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"a626c3da-5e72-444a-9b3b-8f68d7b9b47f","name":"Update File Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0//directory//file//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"0bce3801-bb2b-4a7f-a4b1-21462aefd100"},{"name":"Delete Package File","id":"484c85ed-d143-4d52-adc1-595a41a82af4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/","description":"

This endpoint deletes a file from a draft package or from a Workspace.

\n","urlObject":{"path":["package",":packageId","file",":fileId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"f3eb48b7-880e-4657-8e96-3ae406a82ba0","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"bb7a0729-1715-4af5-be25-257740c2dd09","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"92095871-de08-4b4d-bedc-981db549b6e4","name":"Delete Package File Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0//directory//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"484c85ed-d143-4d52-adc1-595a41a82af4"},{"name":"Get File Information","id":"b139b4ca-fa1a-4cdb-abc1-6f0f94164c79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/:fileId/","description":"

This endpoint gets information about a particular file in a package.

\n","urlObject":{"path":["package",":packageId","file",":fileId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"4829ff05-357c-494b-8a25-03d139fcc2a9","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"54508e98-eb99-4abe-98eb-1cfd2994fef9","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"bccdd042-ccff-474c-bed4-fad0ac46c501","name":"Get File Information Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//link//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"file\": {\n \"fileId\": \"\",\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"createdByEmail\": \"\",\n \"uploaded\": \"\",\n \"uploadedStr\": \"\",\n \"oldVersions\": [\n {\n \"fileId\": \"\",\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"createdByEmail\": \"\",\n \"uploaded\": \"\",\n \"uploadedStr\": \"\",\n \"fileVersion\": \"\",\n \"fileParts\": \"\"\n }\n ],\n \"fileParts\": \"\"\n },\n \"response\": \"\"\n}"}],"_postman_id":"b139b4ca-fa1a-4cdb-abc1-6f0f94164c79"}],"id":"3cdec99f-1f6c-4562-9453-d4914f1cd136","description":"

The File ID is a unique identifier for an individual file on a package. Each version of a file (for Workspace files) has its own unique File ID.

\n","_postman_id":"3cdec99f-1f6c-4562-9453-d4914f1cd136"},{"name":"Add File","id":"56b3d893-ed16-4a97-8746-f8027e0ce250","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"filename\": \"\",\"parts\": \"\",\"filesize\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/file/","description":"

This endpoint creates a new file within a package. You must specify the file name and file size along with the number of file parts that will be uploaded. A unique file id is returned.

\n","urlObject":{"path":["package",":packageId","file",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"1bd4955f-bc55-4240-841c-a5abf8dfc0e4","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"628b72fb-8d47-4d23-a4ad-1128731ed1fd","name":"Add File Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"filename\": \"\",\"parts\": \"\",\"filesize\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//file/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"56b3d893-ed16-4a97-8746-f8027e0ce250"}],"id":"43fda36f-21a1-4e42-b364-ce9e0a843708","description":"

A file stored in the root folder of the package. Subfolders are only available when using a Workspace (vdr) package.

\n","_postman_id":"43fda36f-21a1-4e42-b364-ce9e0a843708"},{"name":"link","item":[{"name":"{public key Id}","item":[{"name":"Get Keycode","id":"f5442970-b040-4ed4-a4d7-0cbc792130c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/link/:publicKeyId/","description":"

This endpoint returns the encrypted package keycode for a specific trusted device key.

\n","urlObject":{"path":["package",":packageId","link",":publicKeyId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"6b8a9702-3bee-49a7-b96b-a49450a8dedc","type":"any","value":"","key":"packageId"},{"id":"27ae25c5-93f3-4b52-b99e-e1cc431e02ac","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"3e14064c-19e6-492d-af52-879c40bc1d0a","name":"Get Keycode Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//link//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"message\": \"\", \"response\": \"\"}"}],"_postman_id":"f5442970-b040-4ed4-a4d7-0cbc792130c2"},{"name":"Add Keycode","id":"df7a3afc-37e3-467c-b0d2-d4eaaff9ed75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"body":{"mode":"raw","raw":"{\"keycode\": \"\", \"notifyRecipients\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/link/:publicKeyId/","description":"

This endpoint lets you upload an encrypted keycode for a specific trusted device key.

\n","urlObject":{"path":["package",":packageId","link",":publicKeyId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"67056bb0-49d6-4019-bdc6-b9e10f2da1f3","type":"any","value":"","key":"packageId"},{"id":"6e398552-5d8f-4d83-aa99-25a3a4698a82","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"be84e1a4-971b-4464-a6d5-da363fa5a2f7","name":"Add Keycode Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//link//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"df7a3afc-37e3-467c-b0d2-d4eaaff9ed75"}],"id":"5d3b56af-8f0c-4263-abe6-cd1196f8f1a3","description":"

The unique identifier for a specific trusted browser public key.

\n","_postman_id":"5d3b56af-8f0c-4263-abe6-cd1196f8f1a3"}],"id":"4c57a274-837c-4324-be83-96e84ad1d645","description":"

For accessing items using a Trusted Device Key, the encrypted client-secret (keycode) must be uploaded for each trusted browser public key. The encrypted keycode is used to generate a \"keyed link\" when accessing the package.

\n","_postman_id":"4c57a274-837c-4324-be83-96e84ad1d645"},{"name":"directory","item":[{"name":"{directory Id}","item":[{"name":"permissions","item":[{"name":"Delete Directory Permission","id":"1138ebab-72df-40fe-9276-cf9b72a65357","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/recipient/:recipientId/directory/:directoryId/permissions/","description":"

This endpoint allows you to revoke permissions from a workspace directory for a specific recipient.

\n","urlObject":{"path":["package",":packageId","recipient",":recipientId","directory",":directoryId","permissions",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"cc014df0-1a36-4bef-bf14-caef1fb4c40d","type":"any","value":"","key":"packageId"},{"id":"95ac8ba6-72ad-4b5e-8608-0c1cf99ad834","type":"any","value":"","key":"recipientId"},{"id":"9fc34fcf-bff6-4665-b7f7-877d0ae660cd","type":"any","value":"","key":"directoryId"}]}},"response":[],"_postman_id":"1138ebab-72df-40fe-9276-cf9b72a65357"},{"name":"Add Directory Permission","id":"07049553-f7f9-4dc7-aaa9-873711337afa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"}],"body":{"mode":"raw","raw":"{\"recipientId\":\"\",\"role\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/permissions/","description":"

This endpoint allows you to grant permissions to a Workspace directory for a specific recipient.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","permissions",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"882740d5-95aa-4c55-826b-8f834cfea97c","type":"any","value":"","key":"packageId"},{"id":"9b9fee33-7079-4fd9-8049-f869f10a4fe9","type":"any","value":"","key":"directoryId"}]}},"response":[],"_postman_id":"07049553-f7f9-4dc7-aaa9-873711337afa"},{"name":"Get Directory Permissions","id":"6fca8537-4d46-4ca4-ba08-220ab30a17b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/permissions/","description":"

This endpoint returns the list of permissions that have been granted to a workspace directory.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","permissions",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"51fe179c-0da7-48ae-91e4-46c13917e992","type":"any","value":"","key":"packageId"},{"id":"0bc52b97-1469-45f1-9ef0-323160f203b5","type":"any","value":"","key":"directoryId"}]}},"response":[],"_postman_id":"6fca8537-4d46-4ca4-ba08-220ab30a17b5"}],"id":"a34cf519-ef42-4e65-8a47-5168ccd17c68","description":"

Permissions are used to assign granular access to specific directories within a Workspace package.

\n","_postman_id":"a34cf519-ef42-4e65-8a47-5168ccd17c68"},{"name":"file","item":[{"name":"{file Id}","item":[{"name":"Get File Download Urls From Directory","id":"008c2e20-3cae-45c3-a3f3-230e9485d326","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"checksum\": \"\", \"password\": \"\", \"startSegment\": \"\", \"endSegment\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/file/:fileId/download-urls/","description":"

This endpoint returns the file part download URLs for a file that resides within a specific directory (required for files inside of a SendSafely Workspace). Up to 25 file part URLs are returned at a time. To fetch the first set of URLs, either omit the \"offset\" parameter or set the offset value to 0.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","file",":fileId","download-urls",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"fa3f684f-3789-4609-b9a2-9d7c31722e77","type":"any","value":"","key":"packageId"},{"id":"3a13fb11-b5b5-4060-bf93-ace812e1935e","type":"any","value":"","key":"directoryId"},{"id":"308dd215-2ad7-434d-a8fa-34df561ba3a3","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"012feb81-a9e4-4cbe-9168-06069623d17c","name":"Get File Download Urls from Directory Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//file//download/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"008c2e20-3cae-45c3-a3f3-230e9485d326"},{"name":"Delete File From Directory","id":"379a8c3a-4603-4b88-9817-61dc897bed48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/file/:fileId/","description":"

This endpoint lets you delete a file from a package directory. For Transfer and Dropzone packages, files can not be deleted once the package is finalized. For Workspace packages, files can be deleted at any time.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","file",":fileId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"6bc52aee-200e-43e5-8117-77111f669c42","type":"any","value":"","key":"packageId"},{"id":"4d519af1-3822-4439-9330-f064e6dcf79a","type":"any","value":"","key":"directoryId"},{"id":"b6aa8607-cb14-4916-88af-870c489325d4","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"5c875238-0c6e-434f-99ff-50d493dc59fa","name":"Delete File From Directory Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0//directory//file//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"379a8c3a-4603-4b88-9817-61dc897bed48"},{"name":"Get File From Directory","id":"3feb86f4-d224-4ab4-8921-49dbd487af6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/file/:fileId","description":"

This endpoint allows you to return the details for a specific file within a directory.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","file",":fileId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"2cd127a0-59a1-4786-b3e3-107299bdbb98","type":"any","value":"","key":"packageId"},{"id":"ea48e8cb-34ad-4574-80dd-bdd0c558b372","type":"any","value":"","key":"directoryId"},{"id":"4e03c594-8cc4-4fd0-9a3c-3ba04e83bfd8","type":"any","value":"","key":"fileId"}]}},"response":[{"id":"487c11b0-c1cf-409d-b1e4-411f7747eee0","name":"Get File From Directory Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//directory//file/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"file\": { \"file\": { \"fileId\": \"\", \"fileName\": \"\", \"fileSize\": \"\", \"createdByEmail\": \"\", \"uploaded\": \"\", \"uploadedStr\": \"\", \"oldVersions\": [{ \"fileId\": \"\", \"fileName\": \"\", \"fileSize\": \"\", \"createdByEmail\": \"\", \"uploaded\": \"\", \"uploadedStr\": \"\", \"fileParts\": \"\"},{ \"fileId\": \"\", \"fileName\": \"\", \"fileSize\": \"\", \"createdByEmail\": \"\", \"uploaded\": \"\", \"uploadedStr\": \"\", \"fileParts\": \"\"} ], \"fileParts\": \"\" } }, \"response\": \"\"}"}],"_postman_id":"3feb86f4-d224-4ab4-8921-49dbd487af6a"}],"id":"f7691f07-810f-4869-b71f-de69d1ea74ff","description":"

The File ID is a unique identifier for an individual file on a package. Each version of a file (for Workspace files) has its own unique File ID.

\n","_postman_id":"f7691f07-810f-4869-b71f-de69d1ea74ff"}],"id":"94695fe9-59d6-48d3-ad7f-ff954b2b1873","description":"

A file stored in the root folder of the package. Subfolders are only available when using a Workspace (vdr) package.

\n","_postman_id":"94695fe9-59d6-48d3-ad7f-ff954b2b1873"},{"name":"Delete Directory","id":"e73c740e-8629-4e5d-86ed-c44cbb95f865","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/","description":"

This endpoint lets you delete a specific directory and its contents. This endpoint can only be used with a Workspace package.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"96e38107-561a-4634-ad24-bc32bc408648","type":"any","value":"","key":"packageId"},{"id":"d402ed9c-c875-4bdd-83ad-9a4484e0756b","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"1c1dca25-3fa5-4179-bae4-9b7e3673046c","name":"Delete Directory Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0//directory//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"e73c740e-8629-4e5d-86ed-c44cbb95f865"},{"name":"Get Directory","id":"3fa8a384-a48b-49fb-9757-8c529e5018cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId","description":"

This endpoint returns the list of items stored within a specific package directory.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"26f74c67-9693-4bb4-8499-4f39401e646d","type":"any","value":"","key":"packageId"},{"id":"54e043d6-042a-4bb0-ad6d-7d147c4cab24","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"2c2c2866-a9f3-48c3-b03c-9f11e9cc8fb1","name":"Get Directory Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//directory/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"directoryName\": \"\", \"directoryId\": \"\", \"files\": [ \"\", \"\" ], \"subDirectories\": [ \"\", \"\" ], \"response\": \"\"}"}],"_postman_id":"3fa8a384-a48b-49fb-9757-8c529e5018cc"},{"name":"Rename Directory","id":"ae3cb3dc-955e-45c6-a947-9aebc3c09135","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"body":{"mode":"raw","raw":"{\"directoryName\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId","description":"

This endpoint allows you to re-name a directory.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"da64aadc-7e07-491e-a9d5-10d40d1cf164","type":"any","value":"","key":"packageId"},{"id":"8732d9e7-fc5b-4e26-8180-b98bf3e351bd","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"40b3d8ff-0b4b-4677-a376-c56c0d3d81d5","name":"Rename Directory Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//directory/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"ae3cb3dc-955e-45c6-a947-9aebc3c09135"},{"name":"Create Subdirectory","id":"66752003-d71c-44e8-a3b5-292b7ed1520b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"directoryName\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/subdirectory/","description":"

This endpoint allows you to create a subdirectory within an existing package directory. Only Workspace packages support the option to add subdirectories.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","subdirectory",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"c760814b-33aa-4d1f-a1c0-d25f358d184a","type":"any","value":"","key":"packageId"},{"id":"ff5bc887-dd4a-4bb7-97de-3fec5d8d95a8","type":"any","value":"","key":"directoryId"}]}},"response":[{"id":"49ceeaea-6b79-4d1c-bfd8-955daedb4bcd","name":"Create Subdirectory Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"directoryName\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//directory//subdirectory/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"66752003-d71c-44e8-a3b5-292b7ed1520b"},{"name":"Move Workspace File","id":"57c14918-e860-4243-b84c-b68c0fd1826a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/directory/:directoryId/file/:fileId/","description":"

This endpoint moves a file from its current directory in a Workspace to the directory specified.

\n","urlObject":{"path":["package",":packageId","directory",":directoryId","file",":fileId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"47936034-92f4-4518-8ec3-0687e3dc147d","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"cdfb9e0c-fc34-410b-aa47-f38a7a25e459","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"directoryId"},{"id":"b74855c6-aa39-4e35-837f-15aa9e6028bd","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"42046307-8091-4425-b44b-a1804395bd6b","name":"Move Workspace File Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//directory/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"57c14918-e860-4243-b84c-b68c0fd1826a"}],"id":"b69b38ac-7ec2-44b6-9196-d297e4457c3c","description":"

The unique identifier for a specific directory (a folder or subfolder) within a Workspace package.

\n","_postman_id":"b69b38ac-7ec2-44b6-9196-d297e4457c3c"}],"id":"121df180-f588-4579-8467-4d1c49beaedd","description":"

A Directory represents a folder or subfolder within a Workspace package.

\n","_postman_id":"121df180-f588-4579-8467-4d1c49beaedd"},{"name":"collaborator","item":[{"name":"Get Collaborators","id":"095f1fb2-7813-491b-9793-f543f33b892e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/collaborators","description":"

This endpoint returns the details for a specific recipient on a package.

\n","urlObject":{"path":["package",":packageId","collaborators"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"e6658ad1-2d45-4dc9-97c5-049689da92fc","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"668ed37b-9e42-4137-970e-ed3aa12b4504","name":"Get Collaborators Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//collaborators"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\"items\": [\n {\n \"type\": \"\",\n \"data\": {\n \"contactGroupId\": \"\",\n \"contactGroupName\": \"\",\n \"contactGroupOwnerId\": \"\",\n \"contactGroupIsOrganizationGroup\": \"\"\n }\n },\n {\n \"type\": \"\",\n \"data\": {\n \"recipientId\": \"\",\n \"fullName\": \"\",\n \"smsAuth\": \"\",\n \"email\": \"\",\n \"isGuest\": \"\",\n \"recipientAddFile\": \"\",\n \"recipientCanAddFileOnly\": \"\",\n \"recipientAddRecipient\": \"\",\n \"recipientRestricted\": \"\",\n \"recipientWorkspaceNotificationType\": \"\"\n }\n }\n ],\n \"pagination\": {\n \"rowIndex\": \"\",\n \"rowsReturned\": \"\"\n },\n \"response\": \"\"\n}\n"}],"_postman_id":"095f1fb2-7813-491b-9793-f543f33b892e"}],"id":"e300da72-26c6-402b-bccb-84541ab04137","_postman_id":"e300da72-26c6-402b-bccb-84541ab04137","description":""},{"name":"Get Package Information","id":"ce95845c-7201-4e30-b820-0ca65868e2c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/","description":"

This endpoint returns detailed information for a specific package.

\n","urlObject":{"path":["package",":packageId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"85d35e0d-25f3-4888-9eca-840ca9edde2c","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"ece307a4-b778-44fd-a58f-2eb52a9e4243","name":"Get Package Information Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"packageId\": \"\", \"packageCode\": \"\", \"serverSecret\": \"\", \"recipients\": [ { \"recipientId\": \"\", \"email\": \"\", \"fullName\": \"\", \"needsApproval\": \"\", \"recipientCode\": \"\", \"confirmations\": {\"ipAddress\": \"\",\"timestamp\": \"\",\"timeStampStr\": \"\",\"isMessage\": \"\" }, \"isPackageOwner\": \"\", \"checkForPublicKeys\": \"\", \"roleName\": \"\" }, { \"recipientId\": \"\", \"email\": \"\", \"fullName\": \"\", \"needsApproval\": \"\", \"recipientCode\": \"\", \"confirmations\": {\"ipAddress\": \"\",\"timestamp\": \"\",\"timeStampStr\": \"\",\"isMessage\": \"\" }, \"isPackageOwner\": \"\", \"checkForPublicKeys\": \"\", \"roleName\": \"\" } ], \"contactGroups\": [ { \"id\": \"\" }, { \"id\": \"\" } ], \"files\": [ { \"id\": \"\" }, { \"id\": \"\" } ], \"directories\": [ { \"id\": \"\" }, { \"id\": \"\" } ], \"approverList\": [ { \"null\": \"\" }, { \"null\": \"\" } ], \"needsApproval\": \"\", \"state\": \"\", \"passwordRequired\": \"\", \"life\": \"\", \"isVDR\": \"\", \"isArchived\": \"\", \"packageSender\": \"\", \"packageTimestamp\": \"\", \"rootDirectoryId\": \"\", \"response\": \"\"}"}],"_postman_id":"ce95845c-7201-4e30-b820-0ca65868e2c7"},{"name":"Update Package","id":"77b780f8-b979-4545-892f-f16a18d1f5e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"life\": \"\", //The number of days from a package's creation after which it is set to expire.\n \"label\": \"\", //The label for the package. For Workspace packages, this is the Workspace name.\n \"checksum\": \"\", //The checksum for the package keycode.\n \"addWatermark\": \"\", //Whether to watermark PDF and image files in the package.\n \"maxAccessLimit\": \"\", //The number of times a package can be picked up by a given recipient before their access is revoked.\n \"pdfViewOnly\": \"\", //Whether recipients are restricted from downloading and printing PDF, image, and video files.\n \"packageMessageState\": \"\" //The message state of the package for use by Actions: null, block, or hold.\n}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/","description":"

This endpoint allows you to update properties of a package.

\n","urlObject":{"path":["package",":packageId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"8264e79d-80ed-433b-8bd2-075c3eb427bc","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"c7c43df7-be69-47b4-ba9e-2b3b031b1111","name":"Update Package Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"label\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"77b780f8-b979-4545-892f-f16a18d1f5e2"},{"name":"Delete Package","id":"c162765d-8273-445c-8a6c-740d6eed24ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/","description":"

This endpoint allows you to delete a package and all of its contents.

\n","urlObject":{"path":["package",":packageId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"bc4652a7-5f92-4e00-990c-8e38d8ded53b","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"60dfa33c-e7fa-49ee-b081-63c3b440cba5","name":"Delete Package Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"c162765d-8273-445c-8a6c-740d6eed24ee"},{"name":"Finalize Package","id":"330e20d2-06b9-402e-b026-eab2d8e3c936","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"password\": \"\", \"checksum\": \"\", \"undisclosedRecipients\": \"\", \"recaptchaToken\": \"\", \"readOnlyPdf\": \"\", \"unconfirmedSender\": \"\", \"confirmedSenderToken\": \"\", \"notifyRecipients\": \"\", \"allowReplyAll\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/finalize/","description":"

This endpoint allows you to mark a package as finalized, meaning that it will be available to all recipients. Once finalized, the contents of the package (files and messages) cannot be modified. Only Transfer and Dropzone packages can be finalized.

\n

The message property of the response contains the secure link for accessing the encrypted message. When sharing the link with a recipient, the client-side generated secret should be passed as the value of a keyCode parameter appended as a URL Fragment Identifier. For example: https://companyabc.sendsafely.com:8443/receive/?thread=AAAA-BBBB&packageCode=XXXXXXX#keyCode=XXXXYYYYY

\n","urlObject":{"path":["package",":packageId","finalize",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"ac6790d8-7bf2-445a-aa0d-2fa15a50a150","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"01cd03bc-3923-4d47-b53a-786ece210c8c","name":"Finalize Package Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"checksum\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//finalize/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"approvers\": [ \"\", \"\" ], \"recipients\": [ \"\", \"\" ], \"needsLink\": \"\", \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"330e20d2-06b9-402e-b026-eab2d8e3c936"},{"name":"Add Encrypted Message","id":"e2aeb4f6-0302-43cd-a786-dd3619778134","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"message\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/message/","description":"

This endpoint adds or replaces the encrypted message for a package. Each package can only include a single encrypted message.

\n

To encrypt the message, you will need to use an encryption library that implements the OpenPGP message format. Specifically, the following is required when encrypting with OpenPGP: The Symmetric-Key Algorithm should be 9 (AES-256)The Compression Algorithm should be 0 (Uncompressed)The Hash Algorithm should be 8 (SHA-256)The 256-bit encryption key is the package server secret concatenated with a random 256-bit secret generated client-side, which will be included as the \"keyCode\" parameter in the secure link.

\n","urlObject":{"path":["package",":packageId","message",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"d0a9db17-1e84-4208-8895-fa6afe5c9e49","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"050aa10a-2221-44c3-9aeb-3ce9673626ae","name":"Add Encrypted Message Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"message\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//message/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"e2aeb4f6-0302-43cd-a786-dd3619778134"},{"name":"Get Package Public Keys","id":"769abdde-9d79-4fec-9ed1-126eb43dd466","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/public-keys/","description":"

This endpoint returns the list of public keys associated with a package. The keycode for the package should be encrypted with each public key and uploaded using the Add Keycode endpoint.

\n","urlObject":{"path":["package",":packageId","public-keys",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"6c99b8c8-be6c-4438-8ac4-efe66bc429de","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"83faef6c-9661-4e14-a91f-aacb68ea5950","name":"Get Package Public Keys Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//public-keys/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"publicKeys\": [ { \"id\": \"\", \"key\": \"\" }, { \"id\": \"\", \"key\": \"\" } ], \"response\": \"\"}"}],"_postman_id":"769abdde-9d79-4fec-9ed1-126eb43dd466"},{"name":"Get Workspace Activity Log","id":"3c297ba2-3b34-4786-8dbf-5b7f9bd7147f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"body":{"mode":"raw","raw":"{\"rowIndex\": \"\", \"targetId\": \"\", \"userId\": \"\", \"recipientId\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/activityLog/","description":"

This endpoint returns the activity log for a workspace package.

\n","urlObject":{"path":["package",":packageId","activityLog",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"1c08a1c2-7c5e-4626-82a6-689f80f8cdfb","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"13e60aab-b1ee-4ae6-b589-afd9d7eae253","name":"Get Workspace Activity Log Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//activityLog/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"activityLogEntries\": [ { \"activityLogId\": \"\", \"timestamp\": \"\", \"timestampStr\": \"\", \"ipAddress\": \"\", \"packageId\": \"\", \"targetId\": \"\", \"actionDescription\": \"\", \"action\": \"\", \"user\": {\"userEmail\": \"\",\"userId\": \"\" } }, { \"activityLogId\": \"\", \"timestamp\": \"\", \"timestampStr\": \"\", \"ipAddress\": \"\", \"packageId\": \"\", \"targetId\": \"\", \"actionDescription\": \"\", \"action\": \"\", \"user\": {\"userEmail\": \"\",\"userId\": \"\" } } ], \"response\": \"\"}"}],"_postman_id":"3c297ba2-3b34-4786-8dbf-5b7f9bd7147f"},{"name":"Move Directory","id":"e3a8573c-379c-4ce1-a958-b34d4c04f96e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/move/:sourcedirectoryId/:targetdirectoryId/","description":"

This endpoint allows you to move the location of a specific directory within a package.

\n","urlObject":{"path":["package",":packageId","move",":sourcedirectoryId",":targetdirectoryId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"088a5792-bb64-4dfe-9440-810d765d4433","type":"any","value":"","key":"packageId"},{"id":"a87349ea-9dd3-43b0-9a81-ad6588eeb4e4","type":"any","value":"","key":"sourcedirectoryId"},{"id":"836848b5-fc89-4c30-ae12-0aa856831cdc","type":"any","value":"","key":"targetdirectoryId"}]}},"response":[{"id":"708916e8-12b0-4db5-835e-f6809eea47dd","name":"Move Directory Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//move///"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"e3a8573c-379c-4ce1-a958-b34d4c04f96e"},{"name":"Get Package Permissions","id":"a4c91fca-095c-4d24-a502-49d17c76c05a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/permissions/","description":"

This endpoint returns a list of all permissions that have been granted to recipients in a workspace.

\n","urlObject":{"path":["package",":packageId","permissions",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"66e7ae63-6702-4a52-ba1e-7103cb3276f4","type":"any","value":"","key":"packageId"}]}},"response":[],"_postman_id":"a4c91fca-095c-4d24-a502-49d17c76c05a"},{"name":"Delete Contact Group from Package","id":"79ed01aa-9b4f-413f-9a83-20b2866a48db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/group/:groupId/","description":"

This endpoint removes a contact group as a recipient from a package.

\n","urlObject":{"path":["package",":packageId","group",":groupId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"8aa41ce7-4b96-4541-b181-269dc1b67f9e","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"687edc43-830b-4051-8000-883b883123c2","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"groupId"}]}},"response":[{"id":"eb0e6ab6-dd0d-4471-b397-b74b4c60604e","name":"Delete Contact Group from Package Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\"\n}"}],"_postman_id":"79ed01aa-9b4f-413f-9a83-20b2866a48db"},{"name":"Delete Temp Package","id":"d1a9ae80-53eb-40bf-97e8-bc183e2aa9c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/temp/","description":"

This endpoint deletes a temporary package.

\n","urlObject":{"path":["package",":packageId","temp",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"6075ec84-d82d-43b3-8508-d8f1bfd77e69","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"062bf88d-4365-47d0-bbff-c2687e3c92f5","name":"Delete Temp Package Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\"\n}"}],"_postman_id":"d1a9ae80-53eb-40bf-97e8-bc183e2aa9c9"},{"name":"Add Contact Group to Package","id":"a4d64acb-eef6-49d0-80be-3a1e93cf0183","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/group/:groupId/","description":"

This endpoint adds a contact group as a recipient to a package, so that the members of the contact group can access it.

\n","urlObject":{"path":["package",":packageId","group",":groupId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"11f82a4f-24c6-4ce5-b5fd-1573bcd3ab34","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"b5b7ac02-24a0-43fd-bfc5-96007e46afe7","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"groupId"}]}},"response":[{"id":"b93edc9b-55a5-42a0-a692-76f4eb9b902e","name":"Add Contact Group to Package Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/group//user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contactGroupId\": \"\",\n \"contactGroupName\": \"\",\n \"contactGroupUserEmails\": [\n \"\",\n \"\"\n ],\n \"response\": \"\"\n}"}],"_postman_id":"a4d64acb-eef6-49d0-80be-3a1e93cf0183"},{"name":"Get Package Message","id":"236e353e-acb4-46d9-a5de-187901a21735","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/:packageId/message/:checksum/","description":"

This endpoint returns a Base64-encoded version of the encrypted message, to decode and pass into PGP to decrypt.

\n","urlObject":{"path":["package",":packageId","message",":checksum",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"0c30ea3a-96a5-4f66-af24-6d774e3da4d3","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"packageId"},{"id":"4abb30fb-d333-4380-80c4-ae1accb2c435","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"checksum"}]}},"response":[{"id":"2455f186-3e8f-419b-a271-7e5694bb9fa3","name":"Get Package Message Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/package//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"236e353e-acb4-46d9-a5de-187901a21735"},{"name":"Bulk Package Transfer Ownership","id":"f100ad36-d2f1-46a3-a90b-37a775f369ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"packageIds\":[\"packageId\"],\"newOwner\":\"email\",\"packageType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/transfer-ownership/","urlObject":{"path":["package","transfer-ownership",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"93dd0ca7-db2c-44ec-a966-be089e428a9b","name":"Bulk Package Transfer Ownership","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"packageIds\":[\"packageId\"],\"newOwner\":\"email\",\"isCapped\":\"boolean\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/transfer-ownership/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f100ad36-d2f1-46a3-a90b-37a775f369ef"}],"id":"3474f486-05c3-4e2d-adf0-fa8905b197ce","description":"

The Package ID is a unique identifier for a specific SendSafely package.

\n","_postman_id":"3474f486-05c3-4e2d-adf0-fa8905b197ce"},{"name":"organization","item":[{"name":"Get Organization Packages [DEPRECATED]","id":"af6f50f8-d75d-48fb-ba4a-bcee9cdd79b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/","description":"

This endpoint is deprecated, please use Organization Package Search instead.

\n","urlObject":{"path":["package","organization",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"c1d4da5d-5c76-49eb-9739-a385a93f1989","name":"Get Organization Packages [DEPRECATED] Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"appplication/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"af6f50f8-d75d-48fb-ba4a-bcee9cdd79b7"},{"name":"Organization Package Search","id":"dc5887c5-6268-4315-b733-dfc19aa47ba4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\",\"rowIndex\": \"\", \"pageSize\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/search","description":"

This endpoint returns packages in the current user's organization based on provided search criteria. The calling user must be a SendSafely Enterprise Administrator.

\n

The search defaults to returning all packages up to the current date and time, if a specific value is not passed for each search criteria. A maximum of 100 records will be returned per method call.

\n

This endpoint supports pagination.

\n","urlObject":{"path":["package","organization","search"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"02a5e1b5-974c-4482-9127-e2800f839728","name":"Organization Package Search Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"appplication/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"dc5887c5-6268-4315-b733-dfc19aa47ba4"}],"id":"fe392a45-1054-4b6c-a697-64b7873395bc","description":"

The enterprise organization that manages a specific SendSafely portal and all registered users within it.

\n","_postman_id":"fe392a45-1054-4b6c-a697-64b7873395bc"},{"name":"Create Package","id":"254513ca-04e3-4fb1-b171-2abf2ab36eb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"vdr\": \"\", \"packageUserEmail\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/","description":"

This endpoint allows you to create a new package. Setting vdr to true makes the new package a Workspace.

\n

An enterprise admin can set packageUserEmail to create packages on behalf of another registered user in their portal.

\n","urlObject":{"path":["package",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"e5fdceb3-8d46-4fc0-9505-7f51d30dd3c3","name":"Create Package Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"SendSafely API Key (API_KEY)"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"vdr\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"packageId\": \"\", \"packageCode\": \"\", \"serverSecret\": \"\", \"response\": \"\"}"}],"_postman_id":"254513ca-04e3-4fb1-b171-2abf2ab36eb7"},{"name":"Get Received Packages","id":"ee82b67f-e54e-49a4-b0fa-41dcd18e34d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/received/","description":"

This endpoint returns a list of active packages that the user has received from other SendSafely users. The list will include expired (but not deleted) packages. Once a package is deleted by the owner it will not longer appear in the received package list for other users.

\n","urlObject":{"path":["package","received",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"12245158-760b-4201-9697-683af3b6a498","name":"Get Received Packages Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"appplication/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ee82b67f-e54e-49a4-b0fa-41dcd18e34d1"},{"name":"Get Archived Packages","id":"48ff3928-81ef-4949-9c20-6a1edc3ff228","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/archived/","description":"

This endpoint returns a list of archived (deleted) packages that are owned by the user.

\n","urlObject":{"path":["package","archived",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"e8806046-7b96-4b47-b5b8-67c6ccc71946","name":"Get Archived Packages Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"appplication/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"48ff3928-81ef-4949-9c20-6a1edc3ff228"},{"name":"Get Sent Packages","id":"294a2831-a410-40c0-beb0-926e97ce4c08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/","description":"

This endpoint returns all active and expired packages that were sent by the user.

\n","urlObject":{"path":["package",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"6c76c6f5-007c-4dbe-b8a5-bb1b5d491568","name":"Get Sent Packages Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"fromDate\": \"\",\"toDate\": \"\",\"filename\": \"\",\"sender\": \"\",\"recipient\": \"\",\"status\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/organization/"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"appplication/json"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"294a2831-a410-40c0-beb0-926e97ce4c08"},{"name":"Search Package","id":"422f4b78-0e8b-42cf-a05e-74329cbfe009","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"searchValue\": \"\",\n \"target\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/search/","urlObject":{"path":["package","search",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[],"_postman_id":"422f4b78-0e8b-42cf-a05e-74329cbfe009"},{"name":"Get Workspace Packages","id":"58a0d150-78b0-4ba4-88eb-9e9aaefe8097","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/package/workspaces/?rowIndex=0&pageSize=50&sortOrder=ASC&sortField=name","description":"

This endpoint returns a list of Workspace packages that the user is authorized to access.

\n","urlObject":{"path":["package","workspaces",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[{"key":"rowIndex","value":"0"},{"key":"pageSize","value":"50"},{"description":{"content":"

ASC, DESC

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

name, date, owner

\n","type":"text/plain"},"key":"sortField","value":"name"}],"variable":[]}},"response":[],"_postman_id":"58a0d150-78b0-4ba4-88eb-9e9aaefe8097"},{"name":"Bulk Add Recipient","id":"a0a0c1cc-5569-4e29-9fa9-6cfb2fe1caa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"email\": \"\", \"phoneNumber\": \"\", \"countryCode\":\"\", \"packageIds\": [\"\", \"\", \"\"]}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/bulk-add-recipient","urlObject":{"path":["package","bulk-add-recipient"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"c7aaed3e-76c4-49c8-a952-0d40dc54d6b8","name":"Bulk Add Recipient Example","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"email\": \"\", \"phoneNumber\": \"\", \"countryCode\":\"\", \"packageIds\": [\"\", \"\", \"\"]}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/bulk-add-recipient"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"packageId\": \"\",\n \"response\": \"\",\n \"recipient\": {\n \"recipientId\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"needsApproval\": \"\",\n \"isPackageOwner\": \"\",\n \"checkForPublicKeys\": \"\",\n \"smsAuth\": \"\",\n \"isGuest\": \"\",\n \"response\": \"\"\n }\n },\n {\n \"packageId\": \"\",\n \"response\": \"\",\n \"message\": \"\"\n },\n {\n \"packageId\": \"\",\n \"response\": \"\",\n \"recipient\": {\n \"recipientId\": \"\",\n \"email\": \"\",\n \"needsApproval\": \"\",\n \"isPackageOwner\": \"\",\n \"checkForPublicKeys\": \"\",\n \"smsAuth\": \"\",\n \"isGuest\": \"\",\n \"response\": \"\"\n }\n }\n ],\n \"response\": \"\"\n}"}],"_postman_id":"a0a0c1cc-5569-4e29-9fa9-6cfb2fe1caa8"},{"name":"Bulk Remove Recipient","id":"a2b2360e-33d0-434a-bec4-84eafdbabcfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\"email\": \"\", \"packageIds\": [\"\", \"\", \"\"]}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/bulk-remove-recipient","urlObject":{"path":["package","bulk-remove-recipient"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"0343ad49-c126-4867-bace-9d821178534c","name":"Bulk Remove Recipient","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\"email\": \"\", \"packageIds\": [\"\", \"\"]}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/package/bulk-remove-recipient"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"packageId\": \"\",\n \"response\": \"\"\n },\n {\n \"packageId\": \"\",\n \"response\": \"\",\n \"message\": \"\"\n }\n ],\n \"response\": \"\"\n}"}],"_postman_id":"a2b2360e-33d0-434a-bec4-84eafdbabcfc"}],"id":"afd6ac33-37a2-4e11-ae01-e3aa314ba9dc","description":"

A package represents a set of files and/or an encrypted message sent via SendSafely. Endpoints within this path are used to perform operations on individual SendSafely packages that the authenticated API User has access to.

\n","_postman_id":"afd6ac33-37a2-4e11-ae01-e3aa314ba9dc"},{"name":"user","item":[{"name":"dropzone-recipients","item":[{"name":"Get Dropzone Recipients","id":"eb920417-ca24-4d6d-a9ac-f52ec21ab1e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/","description":"

This endpoint returns the list of recipients configured on the Dropzone owned by the user.

\n","urlObject":{"path":["user","dropzone-recipients",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"af5ceb7c-a41b-4374-afdb-54967c601222","name":"Get Dropzone Recipients Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"recipientEmailAddresses\": [ \"\", \"\" ], \"response\": \"\"}"}],"_postman_id":"eb920417-ca24-4d6d-a9ac-f52ec21ab1e6"},{"name":"Add Dropzone Recipients","id":"ea0ecfb0-f953-4d2a-ae6a-8d38a08fc1d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\", \"emails\": [ \"\", \"\"]}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/","description":"

This endpoint can be used to add one or more recipients to the Dropzone owned by the user.

\n","urlObject":{"path":["user","dropzone-recipients",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"30ae9d7e-5a31-4de8-988b-a128989107c7","name":"Add Dropzone Recipients Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"emails\": [ \"\", \"\"], \"publicKey\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": { \"success\": \"\", \"successEmails\": [ \"\", \"\" ], \"warnEmails\": [ \"\", \"\" ], \"failEmails\": [ \"\", \"\" ] }}"}],"_postman_id":"ea0ecfb0-f953-4d2a-ae6a-8d38a08fc1d0"},{"name":"Remove Dropzone Recipient","id":"251dd4a4-f0c4-46d7-8456-2d907e3f2e66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\", \"publicKey\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/","description":"

This endpoint can be used to remove a recipient from the Dropzone owned by the user.

\n","urlObject":{"path":["user","dropzone-recipients",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"41f0074d-d040-4844-a92a-79f76cd8d008","name":"Remove Dropzone Recipients Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"251dd4a4-f0c4-46d7-8456-2d907e3f2e66"},{"name":"Get Dropzone Recipients By DropzoneId","id":"8c7c5ee9-81d1-46fa-b882-dc05a739ae15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/dropzone-recipients/:publicKey","urlObject":{"path":["user","dropzone-recipients",":publicKey"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"10753c82-677e-46fb-aaee-8dfb41f337db","type":"any","value":"dropzoneId","key":"publicKey"}]}},"response":[],"_postman_id":"8c7c5ee9-81d1-46fa-b882-dc05a739ae15"}],"id":"ee81bc98-0821-4758-b352-f9bbb9945a37","description":"

Every Dropzone has one or more recipients. Dropzone recipients are automatically able to access all packages that get uploaded to the Dropzone.

\n","_postman_id":"ee81bc98-0821-4758-b352-f9bbb9945a37"},{"name":"{user Id}","item":[{"name":"Update Dropzone Configuration","id":"08eb68a1-b9e5-449f-b75e-d9a9f2710d9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"dropzonePostUrl\": \"\",\"dropzoneTextLabel\": \"\",\"dropzoneNotificationType\": \"\",\"dropzoneEnableMessage\": \"\",\"dropzoneRequireAuthentication\": \"\",\"dropzoneEnable\": \"\", \"dropzoneWhiteList\": \"\", \"dropzoneLife\": \"\", \"dropzoneRestrictDownload\": \"\", \"publicKey\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user/:userId/dropzone/config/","description":"

This endpoint can be used to update the configuration settings for the Dropzone owned by the user.

\n","urlObject":{"path":["user",":userId","dropzone","config",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"81f96759-9415-4d80-816d-a986bc8c200f","type":"any","value":"","key":"userId"}]}},"response":[{"id":"c3005b1d-a657-4095-9eb8-19d026a7dc30","name":"Update Dropzone Configuration Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"dropzoneTextLabel\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/user//dropzone/config/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"dropzoneRecipients\": [ \"\", \"\" ], \"dropzoneLife\": \"\", \"dropzoneExternalPostUrl\": \"\", \"dropzoneTextLabel\": \"\", \"dropzoneEnableSecureMessage\": \"\", \"dropzoneRequireAuthentication\": \"\", \"dropzoneNotificationType\": \"\", \"dropzoneUrl\": \"\", \"publicKey\": \"\", \"publicSecret\": \"\", \"isDropzoneEnabled\": \"\", \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"08eb68a1-b9e5-449f-b75e-d9a9f2710d9e"}],"id":"fe64a397-48a8-4ee8-bcbd-ce599098203e","description":"

The unique identifier for one user registered within your SendSafely portal.

\n","_postman_id":"fe64a397-48a8-4ee8-bcbd-ce599098203e"},{"name":"Get User Information","id":"8cf205c3-b481-445d-8096-d9ccf7aede14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/","description":"

This endpoint returns the profile information for the current API user.

\n","urlObject":{"path":["user",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"0e719e2c-8681-48f9-b05a-5e79ac8cc889","name":"Get User Information Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"\", \"email\": \"\", \"clientKey\": \"\", \"firstName\": \"\", \"lastName\": \"\", \"betaUser\": \"\", \"adminUser\": \"\", \"publicKey\": \"\", \"packageLife\": \"\", \"response\": \"\"}"}],"_postman_id":"8cf205c3-b481-445d-8096-d9ccf7aede14"},{"name":"Get User Contact Groups","id":"737c997f-50ee-470f-b6b9-5bbb65353f7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/groups/","description":"

This endpoint returns a list of the user's personal contact groups along with the members.

\n","urlObject":{"path":["user","groups",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"f5ad31eb-47e3-4161-a630-13615428b2ce","name":"Get User Contact Groups","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"\", \"email\": \"\", \"clientKey\": \"\", \"firstName\": \"\", \"lastName\": \"\", \"betaUser\": \"\", \"adminUser\": \"\", \"publicKey\": \"\", \"packageLife\": \"\", \"response\": \"\"}"}],"_postman_id":"737c997f-50ee-470f-b6b9-5bbb65353f7f"}],"id":"62bb69c3-0e36-4ba8-9ca7-5b0fa33bdc5f","description":"

A user represents a licensed user account within your organization's SendSafely web portal. Endpoints within this path are used to perform operations related to user-level profile settings for the authenticated API user.

\n","_postman_id":"62bb69c3-0e36-4ba8-9ca7-5b0fa33bdc5f"},{"name":"group","item":[{"name":"{group Id}","item":[{"name":"Get Contact Group","id":"35d7a1e1-5e49-48af-9683-f654b127f790","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/group/:groupId/","description":"

This endpoint returns one of the user's personal contact groups or an enterprise contact group.

\n","urlObject":{"path":["group",":groupId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[{"disabled":true,"key":"rowIndex","value":"0"},{"disabled":true,"key":"pageSize","value":"100"}],"variable":[{"id":"8576310c-729a-4963-87a9-686ad2f30394","type":"any","value":"","key":"groupId"}]}},"response":[{"id":"6f075d0d-80cc-44ee-83b2-734f08543cca","name":"Get Contact Group Response","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/group//","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["group","",""],"query":[{"key":"rowIndex","value":"0","disabled":true},{"key":"pageSize","value":"100","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contactGroup\": {\n \"contactGroupId\": \"\",\n \"contactGroupName\": \"\",\n \"contactGroupIsOrganizationGroup\": \"\",\n \"users\": [\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n },\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n }\n ]\n },\n \"pagination\": {\n \"rowIndex\": \"\",\n \"rowsReturned\": \"\"\n },\n \"response\": \"\"\n}"}],"_postman_id":"35d7a1e1-5e49-48af-9683-f654b127f790"},{"name":"Delete Contact Group","id":"494b46f5-f23f-49fe-b841-78cd42c37b5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/group/:groupId/","description":"

This endpoint can be used to delete one of the user's personal contact groups or an enterprise contact group.

\n","urlObject":{"path":["group",":groupId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"3adde8ba-9420-4b03-a31f-c4ad090312cd","type":"any","value":"","key":"groupId"}]}},"response":[{"id":"67b597cc-efba-424e-a82b-f1ad4900fcfe","name":"Delete Contact Group Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/group//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\", \"message\": \"\"}"}],"_postman_id":"494b46f5-f23f-49fe-b841-78cd42c37b5a"},{"name":"Add Contact Group Member","id":"bad5d632-6cca-4d47-bfdd-76efac30b02b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/group/:groupId/user/","description":"

This endpoint can be used to add someone to one of the user's personal contact groups or an enterprise contact group.

\n","urlObject":{"path":["group",":groupId","user",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"3ce380ee-31f5-4c88-be35-b969d82df191","type":"any","value":"","key":"groupId"}]}},"response":[{"id":"00c6b92e-3a5d-497d-b71f-ffa804b786fe","name":"Add Contact Group Member Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/group//user/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"userId\": \"\", \"userEmail\": \"\", \"response\": \"\"}"}],"_postman_id":"bad5d632-6cca-4d47-bfdd-76efac30b02b"},{"name":"Remove Contact Group Member","id":"9e05e521-c2e2-4f7d-9793-fb90b11effe6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/group/:groupId/:userId/","description":"

This endpoint can be used to remove someone from one of the user's personal contact groups or an enterprise contact group.

\n","urlObject":{"path":["group",":groupId",":userId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"3de9f8ba-e4fd-40ba-9689-5a96358c8d92","type":"any","value":"","key":"groupId"},{"id":"a513f53f-578f-4f75-a9c4-ee1643f9bdcd","type":"any","value":"","key":"userId"}]}},"response":[{"id":"402abc9a-dab6-4cb6-8f8a-d3d0c1ef97d0","name":"Remove Contact Group Member Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""}],"url":"https://yourcompany.sendsafely.com/api/v2.0/group///"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"9e05e521-c2e2-4f7d-9793-fb90b11effe6"}],"id":"accb1569-08f9-4373-86e6-eaa7728ca562","description":"

The unique identifier for a specific contact group.

\n","_postman_id":"accb1569-08f9-4373-86e6-eaa7728ca562"},{"name":"Create Contact Group","id":"abd6083e-41ce-428c-901a-009968f7bf48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"groupName\": \"\",\"isEnterpriseGroup\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/group/","description":"

This endpoint can be used to create a new personal or enterprise contact group.

\n","urlObject":{"path":["group",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"169915e9-c445-4709-9a75-2b9d0b5ada80","name":"Create Contact Group Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"groupName\": \"\",\"isEnterpriseGroup\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/group/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"contactGroupId\": \"\", \"contactGroupName\": \"\", \"contactGroupUserEmails\": [ \"\", \"\" ], \"response\": \"\"}"}],"_postman_id":"abd6083e-41ce-428c-901a-009968f7bf48"}],"id":"c6f6989d-eb6b-42a7-ad5d-32391d4c4345","description":"

A SendSafely Contact group is a list of email addresses that can be re-used to add multiple recipients to a package. Contact groups can be defined at the user level (User Contact Groups) or at the organization level (Enterprise Contact Groups). Endpoints within this path are used to perform operations on groups that the authenticated API user has access to.

\n","_postman_id":"c6f6989d-eb6b-42a7-ad5d-32391d4c4345"},{"name":"public-key","item":[{"name":"{public Key Id}","item":[{"name":"Delete Public Key","id":"1a53fa29-5eeb-425a-aa98-cd536afdd8db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/public-key/:publicKeyId/","description":"

This endpoint allows a user to delete one of their trusted device keys.

\n","urlObject":{"path":["public-key",":publicKeyId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"76c216fa-7508-4a9a-b9ab-33c38ac241f1","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"3e8aee4b-b21d-497b-9952-407203023063","name":"Delete Public Key Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/public-key//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"response\": \"\"}"}],"_postman_id":"1a53fa29-5eeb-425a-aa98-cd536afdd8db"},{"name":"Get Public Key by ID","id":"c963fa4d-bcef-48bd-972a-bc2446874d5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://yourcompany.sendsafely.com/api/v2.0/public-key/:publicKeyId/","description":"

Gets the public key using its ID.

\n","urlObject":{"path":["public-key",":publicKeyId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"bd88a8eb-e53b-499c-8371-8cb566f38ee6","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"45a0d50f-f8f8-48da-8284-2a26a270418e","name":"Get Public Key by ID Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/sync//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"publicKey\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"c963fa4d-bcef-48bd-972a-bc2446874d5f"}],"id":"41e21ea0-f509-4d87-b752-d0fb19978b89","description":"

The unique identifier for a specific trusted browser public key.

\n","_postman_id":"41e21ea0-f509-4d87-b752-d0fb19978b89"},{"name":"Add Public Key","id":"be4c40a5-e06b-462f-8818-0f59edef4d12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"publicKey\": \"\",\"description\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/public-key/","description":"

This endpoint allows a user to add a new trusted device key.

\n","urlObject":{"path":["public-key",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"39989a28-c896-4337-971f-e549b4c51daa","name":"Add Public Key Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"publicKey\": \"\",\"description\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/public-key/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"id\": \"\", \"description\": \"\", \"dateStr\": \"\", \"response\": \"\"}"}],"_postman_id":"be4c40a5-e06b-462f-8818-0f59edef4d12"}],"id":"750ce6f7-25f9-40e3-a6a0-599e89a26993","description":"

The public key portion of an individual Trusted Device key. Endpoints within this path are used to perform operations on device keys that belong to the authenticated API user.

\n","_postman_id":"750ce6f7-25f9-40e3-a6a0-599e89a26993"},{"name":"enterprise","item":[{"name":"security-groups","item":[{"name":"Get Security Groups","id":"8d2da057-0b5b-48c3-b4b2-0d11301746ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups","description":"

Get enterprise information

\n","urlObject":{"path":["enterprise","security-groups"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"c91ca6e6-0b46-4dc3-b919-178b2cd25c79","name":"Get Security Groups Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"securityGroups\": [\n {\n \"securityGroupId\": \"\",\n \"securityGroupName\": \"\",\n \"securityGroupPermissions\": [\n {\n \"securityGroupPermission\": \"\"\n },\n {\n \"securityGroupPermission\": \"\"\n }\n ]\n }\n ],\n \"pagination\": {\n \"rowIndex\": \"\",\n \"rowsReturned\": \"\"\n },\n \"response\": \"\"\n}"}],"_postman_id":"8d2da057-0b5b-48c3-b4b2-0d11301746ac"},{"name":"Get Security Groups By Id","id":"5e5ad0c1-c8ee-4985-af15-f8ebd676c3bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}","description":"

Get enterprise information

\n","urlObject":{"path":["enterprise","security-groups","{securityGroupId}"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"f7a3e216-646e-4e49-b4c2-d185bf45611c","name":"Get Security Groups By Id Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"securityGroupMembers\": [],\n \"totalMembersCount\": \"\",\n \"rangeStart\": \"\",\n \"rangeEnd\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"5e5ad0c1-c8ee-4985-af15-f8ebd676c3bc"},{"name":"Add Security Groups Member","id":"f1d6388f-6c78-4ac5-b664-78cea39f802b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}","description":"

Get enterprise information

\n","urlObject":{"path":["enterprise","security-groups","{securityGroupId}"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"da7fac3c-b06c-4a69-88de-054a4b967f0d","name":"Add Security Groups Member Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"f1d6388f-6c78-4ac5-b664-78cea39f802b"},{"name":"Delete Security Groups Member","id":"73e84ff8-32c7-44ac-ad27-0943bf6b6b18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"userEmail\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}","description":"

Get enterprise information

\n","urlObject":{"path":["enterprise","security-groups","{securityGroupId}"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"4745f6b9-53f4-4aeb-a622-ab3deac00fe8","name":"Delete Security Groups Member Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/security-groups/{securityGroupId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"73e84ff8-32c7-44ac-ad27-0943bf6b6b18"}],"id":"5d6e3937-7e73-481b-a15b-2465add6e513","_postman_id":"5d6e3937-7e73-481b-a15b-2465add6e513","description":""},{"name":"slack-private-apps","item":[{"name":"Add Slack Private App","id":"bb63120d-0b62-4eb8-b182-af82634dfc99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"ss-api-key","value":"","type":"text"},{"key":"ss-request-signature","value":"","type":"text"},{"key":"ss-request-timestamp","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\"appId\":\"\",\"clientId\":\"\",\"clientSecret\":\"\",\"signingSecret\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/slack-private-app/","urlObject":{"path":["enterprise","slack-private-app",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb63120d-0b62-4eb8-b182-af82634dfc99"},{"name":"Delete Slack Private App","id":"f208f60f-10f0-4678-b8b3-351e04832088","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","type":"text"},{"key":"ss-request-timestamp","value":"","type":"text"},{"key":"ss-request-signature","value":"","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/slack-private-app/{appId}","urlObject":{"path":["enterprise","slack-private-app","{appId}"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[],"_postman_id":"f208f60f-10f0-4678-b8b3-351e04832088"}],"id":"eac00255-f41c-47fc-93ba-96e9138e9cea","_postman_id":"eac00255-f41c-47fc-93ba-96e9138e9cea","description":""},{"name":"Get Enterprise Information","id":"a9f7d735-a8e5-49ef-be32-618cc12599e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/","description":"

Get enterprise information

\n","urlObject":{"path":["enterprise",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"e9ed54e8-7944-497c-9830-98414b441c8f","name":"Get Enterprise Information Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"host\": \"\",\n \"systemName\": \"\",\n \"allowUndisclosedRecipients\": \"\",\n \"outlookBeta\": \"\",\n \"messageEncryption\": \"\",\n \"linkColor\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"a9f7d735-a8e5-49ef-be32-618cc12599e9"},{"name":"Get Enterprise Contact Groups","id":"a7098095-b520-41e2-9cb2-f475bbf12d19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/groups/","description":"

Get enterprise contact groups

\n","urlObject":{"path":["enterprise","groups",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"c1254196-4d60-4efc-9e0e-3bb054b46209","name":"Get Enterprise Contact Groups Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/groups/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contactGroups\": [\n {\n \"contactGroupId\": \"\",\n \"contactGroupName\": \"\",\n \"contactGroupIsOrganizationGroup\": \"\",\n \"users\": [\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n },\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n }\n ]\n },\n {\n \"contactGroupId\": \"\",\n \"contactGroupName\": \"\",\n \"contactGroupIsOrganizationGroup\": \"\",\n \"users\": [\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n },\n {\n \"userEmail\": \"\",\n \"userId\": \"\"\n }\n ]\n }\n ],\n \"response\": \"\"\n}"}],"_postman_id":"a7098095-b520-41e2-9cb2-f475bbf12d19"},{"name":"Get AuditLog","id":"77cb66c8-554b-44b9-a67f-3bf773e018d5","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true},"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-timestamp","value":""},{"key":"ss-request-signature","value":""},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"eventType\": \"\", //Filter results to only include a specific event type. Can be PACKAGE_FILE_DOWNLOAD, FINALIZE_PACKAGE, WORKSPACE_UPLOAD, WORKSPACE_DOWNLOAD, ADMIN_EVENT, USER_EVENT. Leave blank to return all event types. \n \"ipAddress\": \"\", //Filter results to only include entries originating from a specific IP address\n \"authenticatedUser\": \"\", //Filter results to only include entries originating from a specific user (email address)\n \"impersonatedUser\": \"\", //Filter results to only include entries where this user is being impersonated by an admin (email address)\n \"packageOwner\": \"\", //Filter results to only include packages owned by this user (email address)\n \"minTimestamp\": \"\", //Filter results to only include entries after this date/time. Format can be yyyy-MM-dd HH:mm:ss or yyyy-MM-dd) \n \"maxTimestamp\": \"\", //Filter results to only include entries before this date/time. Format can be yyyy-MM-dd HH:mm:ss or yyyy-MM-dd) \n \"pageSize\": 100, //How many records you want returned in each page. Can be any number from 1 to 100. \n \"rowIndex\": 0 //Offset of the first record to be returned in this page. Leave blank for the first page, otherwise use the nextRowIndex value returned from the previous page. \n}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/audit-logs/","description":"

This endpoint returns Audit Log entries related to activity within your SendSafely portal. The calling user must be a SendSafely Enterprise Administrator, and the organizaiton must have Audit Logging enabled.

\n","urlObject":{"path":["enterprise","audit-logs",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"027acd43-93e2-4b3b-b0f3-f6fdb44bf336","name":"Get AuditLog Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/groups/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"auditLog\": [\n {\n \"eventType\": \"PACKAGE_FILE_DOWNLOAD\",\n \"ipAddress\": \"127.0.0.1\",\n \"authenticatedUser\": \"user@example.com\",\n \"impersonatedUser\": null,\n \"packageOwner\": \"employee@yourcompany.com\",\n \"logDetails\": {\n \"packageId\": \"1234-ABCD\",\n \"fileName\": \"My Report.pdf\",\n \"fileSize\": \"2434812\",\n \"packageType\": \"DROPZONE\"\n },\n \"timestamp\": \"2023-01-01 12:00:00 UTC\"\n },\n {\n \"eventType\": \"PACKAGE_FILE_DOWNLOAD\",\n \"ipAddress\": \"127.0.0.1\",\n \"authenticatedUser\": \"user@example.com\",\n \"impersonatedUser\": null,\n \"packageOwner\": \"employee@yourcompany.com\",\n \"logDetails\": {\n \"packageId\": \"AAAA-9999\",\n \"fileName\": \"Another File.pdf\",\n \"fileSize\": \"1728364\",\n \"packageType\": \"DROPZONE\"\n },\n \"timestamp\": \"2023-01-01 12:00:00 UTC\"\n }\n ],\n \"pagination\": {\n \"rowIndex\": \"0\",\n \"rowsReturned\": \"0\"\n },\n \"response\": \"SUCCESS\",\n \"message\": \"AuditLog query successful\"\n}"}],"_postman_id":"77cb66c8-554b-44b9-a67f-3bf773e018d5"}],"id":"8ee928b1-2059-4695-aaee-765a9055960f","description":"

The enterprise organization that manages a specific SendSafely portal and all registered users within it. Endpoints within this path are used to perform operations on enterprise-level data for the organization that the authenticated API user belongs to.

\n","_postman_id":"8ee928b1-2059-4695-aaee-765a9055960f"},{"name":"sync","item":[{"name":"Sync Public Key","id":"666299be-78d0-4532-b753-490d36ce1946","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/sync/:publicKeyId/","description":"

This endpoint returns a list of keycodes that are eligible to be sync'd using a specific trusted device key.

\n","urlObject":{"path":["sync",":publicKeyId",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"e1cfadb1-8c48-428b-a389-f7ee0f9d59c7","type":"any","value":"","key":"publicKeyId"}]}},"response":[{"id":"de910854-6f90-4a56-8e7b-c5cf53ac76f9","name":"Sync Public Key Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/sync//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{ \"keycodes\": [ \"\", \"\" ], \"publicKeys\": [ { \"id\": \"\", \"key\": \"\" }, { \"id\": \"\", \"key\": \"\" } ], \"response\": \"\"}"}],"_postman_id":"666299be-78d0-4532-b753-490d36ce1946"}],"id":"8a8f2da6-09b4-40b5-8ff6-a56971da6084","description":"

Endpoints within this path are used to synchronize keycodes using a particular trusted device key.

\n","_postman_id":"8a8f2da6-09b4-40b5-8ff6-a56971da6084"},{"name":"recipient","item":[{"name":"Get Recipient Packages History","id":"facde7fd-5901-45dd-9047-464547bfde33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/recipient/history/:recipientEmail/","description":"

This endpoint gets historical information about the packages sent to a particular recipient email address.

\n","urlObject":{"path":["recipient","history",":recipientEmail",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"8418fc5d-a133-46d1-b261-c601164509af","type":"any","value":"","key":"recipientEmail"}]}},"response":[{"id":"32b1440d-2a30-41dc-a071-ba16288579ff","name":"Get Recipient Packages History Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"role\": \"\"}"},"url":"https://yourcompany.sendsafely.com/api/v2.0/package//recipient//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"packages\": [\n {\n \"packageId\": \"\",\n \"packageUserName\": \"\",\n \"packageUserId\": \"\",\n \"packageState\": \"\",\n \"packageLife\": \"\",\n \"packageBrowser\": \"\",\n \"packageOS\": \"\",\n \"recipient\": {\n \"recipientId\": \"\",\n \"email\": \"\",\n \"needsApproval\": \"\",\n \"confirmations\": [],\n \"isPackageOwner\": \"\",\n \"checkForPublicKeys\": \"\",\n \"smsAuth\": \"\",\n \"isGuest\": \"\"\n },\n \"filenames\": [],\n \"packageContainsMessage\": \"\"\n },\n {\n \"packageId\": \"\",\n \"packageUserName\": \"\",\n \"packageUserId\": \"\",\n \"packageState\": \"\",\n \"packageLife\": \"\",\n \"packageBrowser\": \"\",\n \"packageOS\": \"\",\n \"recipient\": {\n \"recipientId\": \"\",\n \"email\": \"\",\n \"needsApproval\": \"\",\n \"confirmations\": [],\n \"isPackageOwner\": \"\",\n \"checkForPublicKeys\": \"\",\n \"smsAuth\": \"\",\n \"isGuest\": \"\"\n },\n \"filenames\": [],\n \"packageContainsMessage\": \"\"\n }\n ],\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"facde7fd-5901-45dd-9047-464547bfde33"}],"id":"b53a938d-f425-412e-94a2-d8ccfb0ad8e0","description":"

Package recipient information

\n","_postman_id":"b53a938d-f425-412e-94a2-d8ccfb0ad8e0"},{"name":"config","item":[{"name":"Verify Credentials","id":"6ef7285a-d8f7-4bef-b92e-d35f261abb81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/config/verify-credentials/","description":"

This endpoint verifies the API user's credentials.

\n","urlObject":{"path":["config","verify-credentials",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"254327a3-dc9f-41cc-a32e-7212613ced1a","name":"Verify Credentials Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":""},{"key":"ss-request-signature","value":""},{"key":"ss-request-timestamp","value":""},{"key":"content-type","value":"application/json"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/sync//"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"requiresApprover\": \"\",\n \"response\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"6ef7285a-d8f7-4bef-b92e-d35f261abb81"}],"id":"dd006c1a-867b-4457-b9ae-acd64b309364","description":"

API Configuration

\n","_postman_id":"dd006c1a-867b-4457-b9ae-acd64b309364"},{"name":"Workflows","item":[{"name":"Workflows Callback","id":"9a9043ef-74e7-40ae-83a0-e6a3a575e014","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \"runnerId\": \"\",\"actionId\": \"\",\"callbackToken\": \"\",\"result\": \"\",\"message\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/callback","urlObject":{"path":["workflow","callback"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"932d9140-e463-41a6-97c7-f9ec0f6a0802","name":"Workflows Callback Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"runnerId\": \"\",\n \"actionId\": \"\",\n \"callbackToken\": \"\",\n \"result\": \"\",\n \"message\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/callback"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"Workflow resumed for runner id \"\n}"}],"_postman_id":"9a9043ef-74e7-40ae-83a0-e6a3a575e014"},{"name":"Add Workflow","id":"488076d2-2003-4bad-85e0-75f2d8cae58d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"workflowEventType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/","urlObject":{"path":["workflow",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"4c891b8e-e5b9-493d-b746-9523007b125d","name":"Add Workflow Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"eventType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"eventFilters\": []\n}"}],"_postman_id":"488076d2-2003-4bad-85e0-75f2d8cae58d"},{"name":"Add Enterprise Workflow","id":"1dfee494-6643-4408-befd-320eab9336c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"workflowEventType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/workflow/","urlObject":{"path":["enterprise","workflow",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"7f9b5005-cb74-4ff4-b7e8-a05b2766617b","name":"Add Enterprise Workflow Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"eventType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/workflow/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"eventFilters\": []\n}"}],"_postman_id":"1dfee494-6643-4408-befd-320eab9336c2"},{"name":"Get Workflow","id":"fd8a6841-bc6c-4fa7-bd7c-9469559ed8be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","urlObject":{"path":["workflow",":workflowId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[{"disabled":true,"key":"workflowId","value":null}],"variable":[{"id":"17bf22be-e504-4da3-81de-8849d0f982d9","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"512a19bf-4dc3-4844-8542-e4ed4cc7d903","name":"Get Workflow Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId"],"query":[{"key":"workflowId","value":null,"disabled":true}],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"eventFilters\": [],\n \"actions\": []\n}"}],"_postman_id":"fd8a6841-bc6c-4fa7-bd7c-9469559ed8be"},{"name":"Get Workflows","id":"9eb9ed05-11e5-4754-aa9d-06b6ade67f73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflows/","urlObject":{"path":["workflows",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"067da2a4-83a1-4cf0-b22e-ec47ccdaf4af","name":"Get Workflows Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflows/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowIsOrgScope\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"modifiedTimestamp\": \"\",\n \"actions\": [\n {\n \"actionId\": \"\",\n \"actionOrder\": \"\",\n \"actionType\": \"\",\n \"actionNotify\": \"\"\n }\n ],\n \"eventFilters\": [\n {\n \"filterId\": \"\",\n \"filterType\": \"\",\n \"filterValue\": \"\",\n \"filterOperator\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"9eb9ed05-11e5-4754-aa9d-06b6ade67f73"},{"name":"Get Enterprise Workflows","id":"7e748470-8004-4557-b37f-00e12c955b24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/workflows/","urlObject":{"path":["enterprise","workflows",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"dacabf7f-29b7-4144-876d-0c8ce3d1599e","name":"Get Enterprise Workflows Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/enterprise/workflows/"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"[\n {\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowIsOrgScope\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"modifiedTimestamp\": \"\",\n \"actions\": [\n {\n \"actionId\": \"\",\n \"actionOrder\": \"\",\n \"actionType\": \"\",\n \"actionNotify\": \"\"\n }\n ],\n \"eventFilters\": [\n {\n \"filterId\": \"\",\n \"filterType\": \"\",\n \"filterValue\": \"\",\n \"filterOperator\": \"\"\n }\n ]\n }\n]"}],"_postman_id":"7e748470-8004-4557-b37f-00e12c955b24"},{"name":"Update Workflow","id":"9e663e38-0292-40c7-9751-cd29d55c7539","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"workflowPriority\": \"\", \"workflowStatus\": \"\", \"workflowName\": \"\", \"workflowIdentity\": \"\", \"workflowNotificationEmail\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","urlObject":{"path":["workflow",":workflowId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"7f93733e-757e-4018-a8fd-51372f88e213","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"450ebb55-f50d-46b0-8cd9-3b1a73c48c62","name":"Update Workflow Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"priority\": \"\", \"status\": \"\", \"name\": \"\", \"identity\": \"\", \"notificationEmail\": \"\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId"],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"workflowId\": \"\",\n \"workflowName\": \"\",\n \"workflowIdentity\": \"\",\n \"workflowOrgId\": \"\",\n \"workflowEventType\": \"\",\n \"workflowStatus\": \"\",\n \"workflowPriority\": \"\",\n \"workflowNotificationEmail\": \"\",\n \"eventFilters\": [],\n \"actions\": []\n}"}],"_postman_id":"9e663e38-0292-40c7-9751-cd29d55c7539"},{"name":"Delete Workflow","id":"8684f1a7-99a5-4cee-8d6f-badc5d1adf4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","urlObject":{"path":["workflow",":workflowId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"681c7235-3389-410c-aa47-d0db96909a5a","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"b96562a4-525c-46dc-aacf-56844d01669b","name":"Delete Workflow Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId"],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8684f1a7-99a5-4cee-8d6f-badc5d1adf4c"},{"name":"Add Workflow Filter","id":"312d2884-62df-48df-9527-4bfd46568aa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"filterType\": \"\",\"filterValue\": \"\",\"filterOperator\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/filter","urlObject":{"path":["workflow",":workflowId","filter"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"834e11a4-d747-4bf2-af91-37ff3a4b1a14","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"b76192ec-0e6e-4aaf-a5f6-b19afea10bdd","name":"Add Workflow Filter Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"filterType\": \"\",\"filterValue\": \"\",\"filterOperator\": \"\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/filter","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","filter"],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"filterId\": \"\",\n \"filterType\": \"\",\n \"filterValue\": \"\",\n \"filterOperator\": \"\"\n}"}],"_postman_id":"312d2884-62df-48df-9527-4bfd46568aa2"},{"name":"Delete Workflow Filter","id":"5f0e25c3-618c-484a-9a1e-049b185add60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/filter/:filterId","urlObject":{"path":["workflow",":workflowId","filter",":filterId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"fca79f9d-370f-4065-8f7a-b2590dd29ce5","type":"any","value":"","key":"workflowId"},{"id":"585fdaf4-474e-48f8-91fb-d726f9dd84d2","type":"any","value":"","key":"filterId"}]}},"response":[{"id":"17fe50b5-d9a4-4063-95a0-cb487bce8880","name":"Delete Workflow Filter Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/filter/:filterId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","filter",":filterId"],"variable":[{"key":"workflowId","value":""},{"key":"filterId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"5f0e25c3-618c-484a-9a1e-049b185add60"},{"name":"Add Action","id":"12ce0b1d-6d30-4181-90fc-f8ca99b55b27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"actionType\": \"\", \"actionInput\": \"\", \"actionNotify\": \"\", \"actionOrder\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/","urlObject":{"path":["workflow",":workflowId","action",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"f57fc242-8096-4135-a3d4-7e18e5b3b014","type":"any","value":"","key":"workflowId"}]}},"response":[{"id":"5010d068-a9e2-4bcc-8ba2-03f3ca3f51f2","name":"Add Action Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"actionType\": \"\", \"actionInput\": \"\", \"actionNotify\": \"\", \"actionOrder\": \"\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",""],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"actionId\": \"\",\n \"actionOrder\": \"\",\n \"actionType\": \"\",\n \"actionNotify\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"12ce0b1d-6d30-4181-90fc-f8ca99b55b27"},{"name":"Update Action","id":"e5844022-b7ee-4e5a-91fc-83ae3211a7d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"actionInput\":\"\", \"actionNotify\":\"\", \"actionOrder\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId","urlObject":{"path":["workflow",":workflowId","action",":actionId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"ddaa738c-d652-4736-9795-45f964930c9b","type":"any","value":"","key":"workflowId"},{"id":"6800d0ad-7522-4b24-b704-8dc36e71d2a2","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"beddb745-4ec1-42c7-aba7-7c47cba88160","name":"Update Action Example","originalRequest":{"method":"PUT","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"actionInput\":\"\", \"actionNotify\":\"\", \"actionOrder\": \"\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",":actionId"],"variable":[{"key":"workflowId","value":""},{"key":"actionId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"actionId\": \"\",\n \"actionOrder\": \"\",\n \"actionType\": \"\",\n \"actionNotify\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"e5844022-b7ee-4e5a-91fc-83ae3211a7d3"},{"name":"Delete Action","id":"3526ab95-4495-4d19-b076-41e6a0350dd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId","urlObject":{"path":["workflow",":workflowId","action",":actionId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"f4ab4033-ae88-42ed-aa73-742648e83205","type":"any","value":"","key":"workflowId"},{"id":"c1b9f0c0-9874-4495-95c4-da391b34ce9b","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"03e7c9dd-2d2c-4cee-b035-f368fb546817","name":"Delete Action Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",":actionId"],"variable":[{"key":"workflowId","value":""},{"key":"actionId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"3526ab95-4495-4d19-b076-41e6a0350dd7"},{"name":"Add Action Filter","id":"1ae8ac77-20c6-4faf-9db0-902790e862b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"filterType\": \"\", \"filterValue\": \"\", \"filterOperator\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/filter","urlObject":{"path":["workflow",":workflowId","action",":actionId","filter"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"db673fbe-8873-4275-ac31-7ac16687c0cb","type":"any","value":"","key":"workflowId"},{"id":"a8403276-5c86-4cbd-91ce-f1060c5f9c7f","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"e411df49-bb9f-4b07-b81e-9514c5caa624","name":"Add Action Filter Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"filterType\": \"\", \"filterValue\": \"\", \"filterOperator\": \"\"}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/filter","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",":actionId","filter"],"variable":[{"key":"workflowId","value":""},{"key":"actionId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"filterId\": \"\",\n \"filterType\": \"\",\n \"filterValue\": \"\",\n \"filterOperator\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"1ae8ac77-20c6-4faf-9db0-902790e862b0"},{"name":"Delete Action Filter","id":"115c532e-5f3e-4701-a2d5-3ecf52b58393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/filter/:filterId","urlObject":{"path":["workflow",":workflowId","action",":actionId","filter",":filterId"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"7f2b5d4a-1721-458d-82ff-e53984d5751a","type":"any","value":"","key":"workflowId"},{"id":"aca14c10-3944-44a0-96ba-de2947f9c96c","type":"any","value":"","key":"actionId"},{"id":"eb1c51eb-62f3-4d43-891d-c5e6c7017540","type":"any","value":"","key":"filterId"}]}},"response":[{"id":"95727007-5604-4d1d-b2d7-8f042f1776cc","name":"Delete Action Filter Example","originalRequest":{"method":"DELETE","header":[{"key":"ss-api-key","value":"","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/filter/:filterId","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",":actionId","filter",":filterId"],"variable":[{"key":"workflowId","value":""},{"key":"actionId","value":""},{"key":"filterId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"\",\n \"response\": \"\"\n}"}],"_postman_id":"115c532e-5f3e-4701-a2d5-3ecf52b58393"},{"name":"Get Workflow Metadata","id":"20af6d70-167f-460d-99a1-0bb1c85462b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"eventType\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/metadata/","urlObject":{"path":["workflow","metadata",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"3851007d-bc72-426e-9e39-5ecc03f1dc33","name":"Get Workflow Metadata Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"eventType\": \"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/metadata/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"eventType\": \"\",\n \"supportedEventProperties\": [\"\"],\n \"supportedEventFilters\": [\"\"]\n}"}],"_postman_id":"20af6d70-167f-460d-99a1-0bb1c85462b2"},{"name":"Execution Logs","id":"17cc85e2-4a93-47a0-9e0e-96a0659c3c50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflows/execution-logs?workflowId=&type=&state=&workflowIdentity=&fromDateTime=&toDateTime=","urlObject":{"path":["workflows","execution-logs"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[{"disabled":true,"key":"executionId","value":""},{"key":"workflowId","value":""},{"key":"type","value":""},{"key":"state","value":""},{"key":"workflowIdentity","value":""},{"key":"fromDateTime","value":""},{"key":"toDateTime","value":""}],"variable":[]}},"response":[{"id":"65d9159c-58d0-48fd-927a-4d465ad67b4a","name":"Execution Logs Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/execution-logs?executionId=&workflowId=&type=&state=&workflowIdentity=&fromDateTime=&toDateTime=","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","execution-logs"],"query":[{"key":"executionId","value":""},{"key":"workflowId","value":""},{"key":"type","value":""},{"key":"state","value":""},{"key":"workflowIdentity","value":""},{"key":"fromDateTime","value":""},{"key":"toDateTime","value":""}],"variable":[{"key":"workflowId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"executionLogs\": [\n {\n \"workflowId\": \"\",\n \"eventPayloadId\": \"\",\n \"workflowName\": \"\",\n \"runnerId\": \"\",\n \"createTimestamp\": \"\",\n \"startTimestamp\": \"\",\n \"endTimestamp\": \"\",\n \"state\": \"\",\n \"eventTarget\": \"\",\n \"workflowIdentity\": \"\",\n \"orgScope\": \"\",\n \"organizationId\": \"\",\n \"eventPayload\": {\n \"eventType\": \"\",\n \"eventProperties\": {\n \"authenticatedUser\": \"\",\n \"organizationId\": \"\",\n \"packageId\": \"\",\n \"packageOwner\": \"\",\n \"packageType\": \"\",\n \"uploader\": \"\",\n \"recipientEmails\": [\"\"],\n \"ipAddress\": \"\",\n \"dateTime\": \"\",\n \"keylessPackageLink\": \"\",\n \"isGuest\": \"\"\n }\n },\n \"executionResults\": [\n {\n \"step\": \"\",\n \"actionId\": \"\",\n \"actionType\": \"\",\n \"input\": \"\",\n \"start\": \"\",\n \"end\": \"\",\n \"result\": \"\",\n \"message\": \"\",\n \"notify\": \"\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"17cc85e2-4a93-47a0-9e0e-96a0659c3c50"},{"name":"Get Action Secret","id":"b1581045-d564-4432-8ff0-66441e66c8af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/secret","urlObject":{"path":["workflow",":workflowId","action",":actionId","secret"],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[{"id":"91edada2-cec1-4a1e-805d-df83322837ca","type":"any","value":"","key":"workflowId"},{"id":"6b1c6b5e-f943-4a08-b290-d1ed6a8b7723","type":"any","value":"","key":"actionId"}]}},"response":[{"id":"e7d18ff8-9d04-41fd-ada8-fcf93d40a5ee","name":"Get Action Secret Example","originalRequest":{"method":"GET","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/api/v2.0/workflow/:workflowId/action/:actionId/secret","host":["https://yourcompany.sendsafely.com/api/v2.0"],"path":["workflow",":workflowId","action",":actionId","secret"],"variable":[{"key":"workflowId","value":""},{"key":"actionId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"actionSecret\": \"\"}s"}],"_postman_id":"b1581045-d564-4432-8ff0-66441e66c8af"},{"name":"Replay Workflow","id":"fd70a0d0-bd0e-4c27-ab23-29abae319397","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"ss-api-key","value":"","description":"

SendSafely API Key (API_KEY)

\n","type":"text"},{"key":"ss-request-timestamp","value":"","description":"

TIMESTAMP (ex: 2014-01-14T22:24:00+0000)

\n","type":"text"},{"key":"ss-request-signature","value":"","description":"

HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": {\n \"eventPayloadId\": [\"\", \"\"]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflows/replay/","urlObject":{"path":["workflows","replay",""],"host":["https://yourcompany.sendsafely.com/api/v2.0"],"query":[],"variable":[]}},"response":[{"id":"4a0bf23c-3d66-4c83-85df-c9225acf2d43","name":"Replay Workflows Example","originalRequest":{"method":"POST","header":[{"key":"ss-api-key","value":"","name":"Content-Type","description":"SendSafely API Key (API_KEY)","type":"text"},{"key":"ss-request-timestamp","value":"","description":"TIMESTAMP (ex: 2014-01-14T22:24:00+0000)","type":"text"},{"key":"ss-request-signature","value":"","description":"HmacSHA256(API_SECRET, API_KEY + URL_PATH + TIMESTAMP + REQUEST_BODY)","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"eventType\":\"\"}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.sendsafely.com/api/v2.0/workflow/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"executionLogs\": {\n \"workflowId\":\"\",\n \"workflowName\":\"\",\n \"runnerId\":\"\",\n \"eventPayloadId\":\"\",\n \"eventTimestamp\":\"\",\n \"createTimestamp\":\"\",\n \"startTimestamp\":\"\",\n \"endTimestamp\":\"\",\n \"eventTarget\":\"\",\n \"workflowIdentity\":\"\",\n \"orgScope\":\"\",\n \"organizationId\":\"\",\n \"eventPayload\":{\n \"eventType\":\"\",\n \"eventProperties\":{\n \"authenticatedUser\":\"\",\n \"organizationId\":\"\",\n \"packageId\":\"\",\n \"packageOwner\":\"\",\n \"packageType\":\"\",\n \"uploader\":\"\",\n \"recipientEmails\":[\"\",\"\"],\n \"ipAddress\":\"\",\n \"dateTime\":\"\",\n \"keylessPackageLink\":\"\",\n \"isGuest\":\"\"\n }\n },\n \"executionResults\":[\n {\n \"step\":\"\",\n \"actionId\":\"\",\n \"actionType\":\"\",\n \"start\":\"\",\n \"end\":\"\",\n \"result\":\"\",\n \"message\":\"\",\n \"notify\":\"\"\n }\n ],\n \"state\":\"\"\n }, \n \"response\": \"\"\n}"}],"_postman_id":"fd70a0d0-bd0e-4c27-ab23-29abae319397"}],"id":"9f8b27b8-dc2b-496d-9797-939b12747f65","description":"

Workflows API

\n","_postman_id":"9f8b27b8-dc2b-496d-9797-939b12747f65"},{"name":"SCIM","item":[{"name":"Get Users","id":"8fa893cc-fdf6-459c-8831-5433c2d9397f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"url":"https://yourcompany.sendsafely.com/scim/v2/Users?startIndex=1&count=1","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"de5103fd-5632-45eb-bb99-85b8b8b64e51","id":"de5103fd-5632-45eb-bb99-85b8b8b64e51","name":"SCIM","type":"folder"}},"urlObject":{"path":["Users"],"host":["https://yourcompany.sendsafely.com/scim/v2"],"query":[{"key":"startIndex","value":"1"},{"key":"count","value":"1"}],"variable":[]}},"response":[{"id":"14709d4f-4a50-4d1b-99c9-473313d76440","name":"Get Users Example","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"url":{"raw":"https://yourcompany.sendsafely.com/scim/v2/Users?startIndex=1&count=1","host":["https://yourcompany.sendsafely.com/scim/v2"],"path":["Users"],"query":[{"key":"startIndex","value":"1"},{"key":"count","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Jul 2024 16:08:29 GMT"},{"key":"Content-Type","value":"application/scim+json;charset=utf-8"},{"key":"Content-Length","value":"359"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"null"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Service-Worker-Allowed","value":"/"},{"key":"Expires","value":"Tue, 03 Jul 2001 06:00:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":""},{"key":"X-WebKit-CSP","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\"\"],\n \"totalResults\": \"\",\n \"itemsPerPage\": \"\",\n \"startIndex\": \"\",\n \"Resources\": [\n {\n \"schemas\": [\"\"],\n \"id\": \"\",\n \"userName\": \"\",\n \"name\": {\n \"formatted\": \"\",\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"active\": \"\",\n \"userLastLoggedInTimeStamp\": \"\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n }\n ]\n}"}],"_postman_id":"8fa893cc-fdf6-459c-8831-5433c2d9397f"},{"name":"Create User","id":"9c448b93-4b25-47a9-9351-db82b5290f80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\"\n ],\n \"userName\": \"user@yourcompany.com\",\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"active\": true,\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": { \"isAdmin\": false }\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"de5103fd-5632-45eb-bb99-85b8b8b64e51","id":"de5103fd-5632-45eb-bb99-85b8b8b64e51","name":"SCIM","type":"folder"}},"urlObject":{"path":["Users"],"host":["https://yourcompany.sendsafely.com/scim/v2"],"query":[],"variable":[]}},"response":[{"id":"b091416f-ea40-4b9c-84f7-fa8affa2724f","name":"Create User Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\"\"],\n \"userName\": \"\",\n \"name\": {\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"active\": \"\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Jul 2024 16:11:24 GMT"},{"key":"Content-Type","value":"application/scim+json;charset=utf-8"},{"key":"Content-Length","value":"259"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"null"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Service-Worker-Allowed","value":"/"},{"key":"Expires","value":"Tue, 03 Jul 2001 06:00:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":""},{"key":"X-WebKit-CSP","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\"\"],\n \"id\": \"\",\n \"userName\": \"\",\n \"name\": {\n \"formatted\": \"\",\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"active\": \"\",\n \"userLastLoggedInTimeStamp\": \"\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n}"}],"_postman_id":"9c448b93-4b25-47a9-9351-db82b5290f80"},{"name":"Update User","id":"43ba890c-f1ed-4a54-ae74-edd9ea7ea201","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\"\n ],\n \"name\": {\n \"givenName\": \"Test\",\n \"familyName\": \"User\"\n },\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": { \"isAdmin\": false }\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users/user@yourcompany.com","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"de5103fd-5632-45eb-bb99-85b8b8b64e51","id":"de5103fd-5632-45eb-bb99-85b8b8b64e51","name":"SCIM","type":"folder"}},"urlObject":{"path":["Users","user@yourcompany.com"],"host":["https://yourcompany.sendsafely.com/scim/v2"],"query":[],"variable":[]}},"response":[{"id":"7e848ab4-92cc-4218-8c8e-a99248b2350b","name":"Update User Example","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\"\"],\n \"name\": {\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users/user@yourcompany.com"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Jul 2024 16:11:24 GMT"},{"key":"Content-Type","value":"application/scim+json;charset=utf-8"},{"key":"Content-Length","value":"259"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"null"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Service-Worker-Allowed","value":"/"},{"key":"Expires","value":"Tue, 03 Jul 2001 06:00:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":""},{"key":"X-WebKit-CSP","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\"\"],\n \"id\": \"\",\n \"userName\": \"\",\n \"name\": {\n \"formatted\": \"\",\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"active\": \"\",\n \"userLastLoggedInTimeStamp\": \"\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n}"}],"_postman_id":"43ba890c-f1ed-4a54-ae74-edd9ea7ea201"},{"name":"Deactivate User","id":"16581ada-584d-48f9-a2f7-0313bb980f26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n ],\n \"Operations\": [\n {\n \"op\": \"replace\",\n \"value\": {\n \"active\": false\n }\n }\n ]\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users/user@yourcompany.com","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"de5103fd-5632-45eb-bb99-85b8b8b64e51","id":"de5103fd-5632-45eb-bb99-85b8b8b64e51","name":"SCIM","type":"folder"}},"urlObject":{"path":["Users","user@yourcompany.com"],"host":["https://yourcompany.sendsafely.com/scim/v2"],"query":[],"variable":[]}},"response":[{"id":"0c3dba8e-7a1e-4dc8-bd90-9eb77bc1bc34","name":"Deactivate User Example","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/scim+json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n ],\n \"Operations\": [\n {\n \"op\": \"replace\",\n \"value\": {\n \"active\": false\n }\n }\n ]\n}"},"url":"https://yourcompany.sendsafely.com/scim/v2/Users/user@yourcompany.com"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Jul 2024 16:11:47 GMT"},{"key":"Content-Type","value":"application/scim+json;charset=utf-8"},{"key":"Content-Length","value":"206"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"null"},{"key":"Strict-Transport-Security","value":"max-age=31536000"},{"key":"X-Permitted-Cross-Domain-Policies","value":"master-only"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Service-Worker-Allowed","value":"/"},{"key":"Expires","value":"Tue, 03 Jul 2001 06:00:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, max-age=0"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Security-Policy","value":""},{"key":"X-WebKit-CSP","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\"\"],\n \"id\": \"\",\n \"userName\": \"\",\n \"name\": {\n \"formatted\": \"\",\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"active\": \"\",\n \"userLastLoggedInTimeStamp\": \"\",\n \"urn:ietf:scim:schemas:extension:SendSafely:2.0:User\": {\n \"isAdmin\": \"\"\n }\n}"}],"_postman_id":"16581ada-584d-48f9-a2f7-0313bb980f26"}],"id":"de5103fd-5632-45eb-bb99-85b8b8b64e51","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"85612038-f538-4202-bfb8-67fbc4c22bc6"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1dab46d4-9d9c-4d83-8c1b-1495afd1b0a6"}}],"_postman_id":"de5103fd-5632-45eb-bb99-85b8b8b64e51","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var sdk = require('postman-collection');","var path = pm.variables.get('baseUrl').substring(pm.variables.get('baseUrl').indexOf('/',8)) + \"/\" + new sdk.Url(request.url).toJSON().path.join(\"/\");","pm.variables.set(\"timestamp\", new Date().toISOString().substr(0, 19) + \"+0000\");","var body = \"\";","if (pm.request.hasOwnProperty('body') && pm.request.body.hasOwnProperty('raw')) {"," var bodyLines = pm.request.body.raw.split(\"\\n\");"," for (var i = 0; i < bodyLines.length; i++) {"," if (bodyLines[i].includes(\"//\"))"," {"," bodyLines[i] = bodyLines[i].substring(0,bodyLines[i].lastIndexOf(\"//\"));"," }"," body += bodyLines[i].trim();"," }","}","var data = pm.variables.get(\"ss-api-key\") + path + pm.variables.get(\"timestamp\") + body;","console.log(data);","var signature = CryptoJS.HmacSHA256(data, pm.variables.get(\"ss-api-secret\")).toString(CryptoJS.enc.Hex);","console.log(signature);","var signature2 = CryptoJS.HmacSHA256(data, pm.variables.get(\"ss-api-secret\")).toString(CryptoJS.enc.Base64);","toString(CryptoJS.enc.Hex);","console.log(signature2);","pm.variables.set(\"ss-api-signature\",signature);","pm.request.headers.upsert({key: 'ss-request-signature', value: signature });","pm.request.headers.upsert({key: 'ss-api-key', value: pm.variables.get(\"ss-api-key\") });","pm.request.headers.upsert({key: 'ss-request-timestamp', value: pm.variables.get(\"timestamp\") });","pm.request.body.raw = body;"],"id":"9fbb4531-c81e-4340-af8c-c6ecc5f30f29"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"a402eccc-7163-4a89-97f6-a721775c4f68"}}],"variable":[{"key":"baseUrl","value":"https://yourcompany.sendsafely.com/api/v2.0"},{"key":"ss-api-key","value":""},{"key":"ss-api-secret","value":""},{"key":"SCIMUsername","value":"","type":"string"},{"key":"baseSCIMUrl","value":"https://yourcompany.sendsafely.com/scim/v2","type":"string"},{"key":"SCIMPassword","value":"","type":"string"}]}