{ "opencollection": "1.0.0", "info": { "name": "Unified.to account uc API", "version": "1.0" }, "request": { "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "uc", "type": "folder" }, "items": [ { "info": { "name": "List All Calls", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/uc/:connection_id/call", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "user_id", "value": "", "type": "query", "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "name": "contact_id", "value": "", "type": "query", "description": "The contact ID to filter by (reference to UcContact)" }, { "name": "start_gte", "value": "", "type": "query", "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "end_lt", "value": "", "type": "query", "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Calls" }, { "info": { "name": "Retrieve a Call", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/uc/:connection_id/call/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Call" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Call" }, { "info": { "name": "List All Comments", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/uc/:connection_id/comment", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "user_id", "value": "", "type": "query", "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "name": "call_id", "value": "", "type": "query", "description": "The call ID to filter by" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Comments" }, { "info": { "name": "Create a Comment", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/uc/:connection_id/comment", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Comment" }, { "info": { "name": "Retrieve a Comment", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/uc/:connection_id/comment/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Comment" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Comment" }, { "info": { "name": "Update a Comment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/uc/:connection_id/comment/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Comment" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Comment" }, { "info": { "name": "Update a Comment", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/uc/:connection_id/comment/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Comment" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Comment" }, { "info": { "name": "Remove a Comment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/uc/:connection_id/comment/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Comment" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Comment" }, { "info": { "name": "List All Contacts", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/uc/:connection_id/contact", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "user_id", "value": "", "type": "query", "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Contacts" }, { "info": { "name": "Create a Contact", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/uc/:connection_id/contact", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Contact" }, { "info": { "name": "Retrieve a Contact", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/uc/:connection_id/contact/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Contact" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Contact" }, { "info": { "name": "Update a Contact", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/uc/:connection_id/contact/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Contact" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Contact" }, { "info": { "name": "Update a Contact", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/uc/:connection_id/contact/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Contact" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Contact" }, { "info": { "name": "Remove a Contact", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/uc/:connection_id/contact/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Contact" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Contact" }, { "info": { "name": "List All Recordings", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/uc/:connection_id/recording", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "updated_gte", "value": "", "type": "query", "description": "Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query", "description": "Query string to search. eg. email address or name" }, { "name": "user_id", "value": "", "type": "query", "description": "The user/employee ID to filter by (reference to HrisEmployee)" }, { "name": "call_id", "value": "", "type": "query", "description": "The call ID to filter by" }, { "name": "start_gte", "value": "", "type": "query", "description": "The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "end_lt", "value": "", "type": "query", "description": "The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)" }, { "name": "contact_id", "value": "", "type": "query", "description": "The contact ID to filter by (reference to UcContact)" }, { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "List All Recordings" }, { "info": { "name": "Create a Recording", "type": "http" }, "http": { "method": "POST", "url": "https://api.unified.to/uc/:connection_id/recording", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Create a Recording" }, { "info": { "name": "Retrieve a Recording", "type": "http" }, "http": { "method": "GET", "url": "https://api.unified.to/uc/:connection_id/recording/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Recording" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Retrieve a Recording" }, { "info": { "name": "Update a Recording", "type": "http" }, "http": { "method": "PUT", "url": "https://api.unified.to/uc/:connection_id/recording/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Recording" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Recording" }, { "info": { "name": "Update a Recording", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.unified.to/uc/:connection_id/recording/:id", "params": [ { "name": "fields", "value": "", "type": "query", "description": "Fields to return" }, { "name": "raw", "value": "", "type": "query", "description": "Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar" }, { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Recording" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Update a Recording" }, { "info": { "name": "Remove a Recording", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.unified.to/uc/:connection_id/recording/:id", "params": [ { "name": "connection_id", "value": "", "type": "path", "description": "ID of the connection" }, { "name": "id", "value": "", "type": "path", "description": "ID of the Recording" } ], "auth": { "type": "apikey", "key": "authorization", "value": "{{authorization}}", "placement": "header" } }, "docs": "Remove a Recording" } ] } ], "bundled": true }