{ "openapi": "3.0.0", "info": { "title": "StrikeDM Backend User API", "description": "Backend API for the StrikeDM user interface ... ", "termsOfService": "https://webapi.strikedm.com/backend/api/terms", "version": "1.0" }, "servers": [ { "url": "https://webapi.plura.ai/backend/api/user" } ], "paths": { "/passKeyRegOptions.json": { "get": { "tags": [ "User" ], "summary": "Get Passkey Registration options", "description": "Test", "operationId": "passKeyRegOptions", "parameters": [ { "name": "nickname", "in": "query", "description": "Passkey nickname", "required": true, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array" } } } }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/passKeyRegister.json": { "post": { "tags": [ "User" ], "summary": "Register a passkey", "operationId": "f9ee7e53d891269a4dd62d5ce35ab4de", "requestBody": { "content": { "application/json": { "schema": { "properties": { "nickname": { "type": "string", "default": "" }, "id": { "type": "string", "default": "" }, "rawId": { "type": "string", "default": "" }, "type": { "type": "string", "default": "" }, "response": { "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } } } }, "/deletepassKey.json": { "delete": { "tags": [ "User" ], "summary": "Delete a specific passkey", "operationId": "7a5dd250e962c40f01e1c5e610ae54cc", "requestBody": { "content": { "application/json": { "schema": { "properties": { "passkey_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/passKeyAuthOptions.json": { "post": { "tags": [ "User" ], "summary": "Register a passkey", "operationId": "bef50b069ea9e4341b40baa5f6930b32", "requestBody": { "content": { "application/json": { "schema": { "properties": { "username": { "type": "string", "default": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } } } }, "/passkeyAuthenticate.json": { "post": { "tags": [ "User" ], "summary": "Authenticate a passkey", "operationId": "d052f4bccc17c660e33d6ee996bcc9ae", "requestBody": { "content": { "application/json": { "schema": { "properties": { "username": { "type": "string", "default": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } } } }, "/getPasskey.json": { "get": { "tags": [ "User" ], "summary": "Get a list of passkeys for the current logged in user or provide a passkey_id to get a particular one.", "description": "Get passkey list", "operationId": "getPasskey", "parameters": [ { "name": "passkey_id", "in": "query", "description": "Passkey UUID", "required": false, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array" } } } }, "404": { "description": "Not found" } } } }, "/enableTOTP.json": { "patch": { "tags": [ "User" ], "summary": "Enable TOTP and get a secert code", "operationId": "b00ca35d9f41173cf00e2b761f3568ee", "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/disableTOTP.json": { "patch": { "tags": [ "User" ], "summary": "Disable TOTP and remove secret", "operationId": "cbfc7b2501b072a75ce5177eaded83b7", "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/verifyTOTP.json": { "get": { "tags": [ "User" ], "summary": "Verify a TOTP code.", "description": "Get passkey list", "operationId": "verifyTOTP", "parameters": [ { "name": "username", "in": "query", "description": "Username", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "code", "in": "query", "description": "TOTP 6 digit code", "required": true, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array" } } } }, "404": { "description": "Not found" } } } }, "/startRecovery.json": { "post": { "tags": [ "User" ], "summary": "Start the account recovery process", "operationId": "63d81bd6595f968fe21aabf265cbf298", "requestBody": { "content": { "application/json": { "schema": { "properties": { "username": { "type": "string", "default": "" }, "sms": { "type": "boolean", "default": false } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } } } }, "/verifyRecovery.json": { "get": { "tags": [ "User" ], "summary": "Get JWT to recover account.", "description": "OTP account recovery", "operationId": "verifyRecovery", "parameters": [ { "name": "username", "in": "query", "description": "Username", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "code", "in": "query", "description": "6 digit OTP", "required": true, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array" } } } }, "404": { "description": "Not found" } } } }, "/Authenticate.json": { "get": { "tags": [ "User" ], "summary": "Authenticate with the API to get a JWT", "description": "Test", "operationId": "Authenticate", "parameters": [ { "name": "user", "in": "query", "description": "Username", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "password", "in": "query", "description": "Password", "required": true, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array" } } } }, "404": { "description": "Not found" } } }, "post": { "tags": [ "User" ], "summary": "Authenticate with the API to get a JWT", "operationId": "3974a7b254c508e88d84934b07b5a853", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "user", "password" ], "properties": { "user": { "type": "string" }, "password": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } } } }, "/WorkspaceToken.json": { "get": { "tags": [ "Workspace" ], "summary": "Generate a workspace specific token this token can be used to generate another workpace token if moving to another workspace.", "description": "Test", "operationId": "WorkspaceToken", "parameters": [ { "name": "workspace_id", "in": "query", "description": "Workspace ID", "required": true, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array" } } } }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Account.json": { "get": { "tags": [ "Account" ], "summary": "Get the current Account information", "description": "Test", "operationId": "Account", "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Profile.json": { "get": { "tags": [ "User" ], "summary": "Get current user information", "description": "Test", "operationId": "Profile", "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "User" ], "summary": "Update a users information", "operationId": "f67ff6e260cf4df3fe7ae53c5ad8749b", "requestBody": { "content": { "application/json": { "schema": { "properties": { "first": { "type": "string", "default": "" }, "last": { "type": "string", "default": "" }, "email": { "type": "string", "default": "" }, "phone": { "type": "string", "default": "" }, "meta": { "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/UserProfile.json": { "get": { "tags": [ "Account" ], "summary": "Get a users profile", "description": "Test", "operationId": "UserProfile", "parameters": [ { "name": "user_id", "in": "query", "description": "The User id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/UserRole.json": { "patch": { "tags": [ "Account" ], "summary": "Change a users Role", "operationId": "82bebf46b4642a10750ee6a2c4429fa6", "requestBody": { "content": { "application/json": { "schema": { "properties": { "user_id": { "type": "string", "default": "" }, "role": { "type": "string", "default": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/WorkspaceUserRole.json": { "patch": { "tags": [ "Workspace" ], "summary": "Change a users Role on a workspace", "operationId": "40ac7def01d077f5a1c9f56337f3de77", "requestBody": { "content": { "application/json": { "schema": { "properties": { "user_id": { "type": "string", "default": "" }, "workspace_id": { "type": "string", "default": "" }, "role": { "type": "string", "default": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/GetUsers.json": { "get": { "tags": [ "Account" ], "operationId": "8f52f885e1b9b7a161b4be2e39e0fd9b", "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/User.json": { "delete": { "tags": [ "Account" ], "summary": "Delete a user can no be undone", "description": "Test", "operationId": "User", "parameters": [ { "name": "user_id", "in": "query", "description": "The User id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Users.json": { "get": { "tags": [ "Account" ], "summary": "Get a list of users Note: Must have Admin role", "operationId": "ba2eea78443b09b8611099acdc246ced", "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Account" ], "summary": "Add a user to an account", "operationId": "bb055a4e1bfcfb15f6f37d3e1d8bbae2", "requestBody": { "content": { "application/json": { "schema": { "required": [ "username", "email", "phone", "password", "first", "last" ], "properties": { "username": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "password": { "type": "string" }, "first": { "type": "string" }, "last": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/ChangePassword.json": { "patch": { "tags": [ "User" ], "summary": "Change a users password.", "operationId": "31bdf09be89cb5584316fbb4bccf52b0", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "new_password" ], "properties": { "user_id": { "type": "string" }, "new_password": { "type": "string" }, "current_password": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/UserInvite.json": { "get": { "tags": [ "Account" ], "summary": "Get a list of created user invite", "operationId": "4278deb81f291233046e58657ca57541", "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "Account" ], "summary": "Create a new invite when the invite is accepted a user entry will be created.", "operationId": "c1e51b5dc055a1a978bfef56e1bd2d7e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "first_name", "last_name", "email", "workspace_id" ], "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "workspace_id": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Account" ], "summary": "Get a specific user invite email or phone can return multiple invites", "operationId": "c666241318e9486ceca3469df60537ae", "requestBody": { "content": { "application/json": { "schema": { "properties": { "token": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Account" ], "summary": "Delete a specific user invite email or phone can return multiple invites", "operationId": "5a58fb4b7f3697cc2628b2ca1504a0c1", "requestBody": { "content": { "application/json": { "schema": { "properties": { "token": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/GetWorkspaces.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a list of users workspaces.", "operationId": "38a9e28d6243ace6ac27a85212a1e71a", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "activeonly", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "deprecated": true, "security": [ { "bearerAuth": [] } ] } }, "/Workspaces.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a list of users workspaces.", "operationId": "7322d3aad6818b13be82576bd65fec9a", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer" } }, { "name": "activeonly", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Workspace" ], "summary": "Create a new workspace", "operationId": "556166dbf65a20da5e7cf6827f0db1c4", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/CustomFields.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a list of custom fields", "description": "Test", "operationId": "CustomFields", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "field_id", "in": "query", "description": "The field id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "include_defaults", "in": "query", "description": "Should it include the default fields", "required": false, "explode": true, "schema": { "type": "boolean", "default": "" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Workspace" ], "summary": "Add a custom field to a workspace.", "operationId": "e4d61552de749b74337186d4f48754d7", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "workspace_id", "name", "label", "format" ], "properties": { "workspace_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean", "default": "false" }, "format": { "type": "string", "enum": [ "string", "number", "data_time", "date", "phone", "email" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Update a custom field in a workspace.", "operationId": "313031ca0f29ebe6e7a70f9c61bf239d", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "field_id" ], "properties": { "field_id": { "type": "string" }, "description": { "type": "string" }, "label": { "type": "string" }, "required": { "type": "boolean", "default": "false" }, "format": { "type": "string", "enum": [ "string", "number", "data_time", "date", "phone", "email" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/VectorDB.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a list of Databases for a workspace", "description": "Test", "operationId": "VectorDB", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "db_id", "in": "query", "description": "The database id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Workspace" ], "summary": "Add a Vector DB to a workspace.", "operationId": "69bfa1ba73ee32eccbe4bd8419d1590b", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "workspace_id", "name" ], "properties": { "workspace_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" }, "tags": { "type": "object", "default": [] } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/VectorDBTags.json": { "delete": { "tags": [ "Workspace" ], "summary": "Remove a tag from Vector DB", "operationId": "560e0b9c76e86437162157ab8556f9da", "requestBody": { "content": { "application/json": { "schema": { "properties": { "db_id": { "type": "string" }, "tag": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Add a tag to a Vector DB", "operationId": "5e2653e3693b1f6438d3b522a69efbaf", "requestBody": { "content": { "application/json": { "schema": { "properties": { "db_id": { "type": "string" }, "tag": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/VectorDBQuery.json": { "get": { "tags": [ "Workspace" ], "summary": "Query a vector DB", "description": "Test", "operationId": "VectorDBQuery", "parameters": [ { "name": "db_id", "in": "query", "description": "The Vector Database ID", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "query", "in": "query", "description": "A query term", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "tags", "in": "query", "description": "JSON encode string of tags", "required": false, "explode": true, "schema": { "type": "striun", "default": "" } }, { "name": "top_k", "in": "query", "description": "Number of chunks to return", "required": false, "explode": true, "schema": { "type": "integer", "default": 5 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/VectorDBImport.json": { "patch": { "tags": [ "Workspace" ], "summary": "Add content to a Vector DB.", "operationId": "cc917f1e411f88db506206ab31cdbe58", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "db_id" ], "properties": { "db_id": { "type": "string" }, "documents": { "description": "List of Documents to be indexed.", "type": "array", "items": { "required": [ "file", "mime", "content" ], "properties": { "file": { "description": "The file name.", "type": "string" }, "mime": { "description": "The file mime type example text/plain.", "type": "string" }, "content": { "description": "Base64 encoded string of the file content", "type": "string", "format": "base64" }, "tags": { "description": "Key‑value pairs that annotate the URL (optional).", "type": "object", "additionalProperties": { "type": "string" } }, "maxTokens": { "description": "Maximum tokens to use when processing this URL (optional).", "type": "integer", "format": "int32", "default": 1000 }, "maxOverlap": { "description": "Maximum tokens to use when processing this URL (optional).", "type": "integer", "format": "int32", "default": 100 } }, "type": "object" } }, "urls": { "description": "List of URLs to be indexed.", "type": "array", "items": { "required": [ "url" ], "properties": { "url": { "description": "The URL to fetch and index.", "type": "string", "format": "uri" }, "tags": { "description": "Key‑value pairs that annotate the URL (optional).", "type": "object", "additionalProperties": { "type": "string" } }, "maxTokens": { "description": "Maximum tokens to use when processing this URL (optional).", "type": "integer", "format": "int32", "default": 1000 }, "maxOverlap": { "description": "Maximum tokens to use when processing this URL (optional).", "type": "integer", "format": "int32", "default": 100 } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/WorkspaceTags.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a list of tags", "description": "Test", "operationId": "WorkspaceTags", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "tag_id", "in": "query", "description": "The tag id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Workspace" ], "summary": "Add a tag to a workspace.", "operationId": "a182f493cb223de5984afb34916e0722", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "workspace_id", "name", "label", "format", "active" ], "properties": { "workspace_id": { "type": "string" }, "tag": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean", "default": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Update a Tag in a workspace.", "operationId": "f379a83724b7d06a0521b1946d441537", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "tag_id" ], "properties": { "tag_id": { "type": "string" }, "tag": { "type": "string" }, "description": { "type": "string" }, "active": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Workspace.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a workspace", "description": "Test", "operationId": "Workspace", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Update the details of a workspace.", "operationId": "31eb3fdcddd01a3761d59efbc7af2646", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "workspace_id" ], "properties": { "workspace_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "carrier": { "type": "object" }, "billing": { "type": "object" }, "timezone": { "type": "string" }, "country_code": { "type": "string" }, "report_config": { "type": "object" }, "pause_queue": { "type": "boolean", "default": false } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/WorkspaceAccess.json": { "delete": { "tags": [ "Workspace" ], "summary": "Remove a users access to a workspace", "operationId": "9eb7d35bc624d90274fbd0bc31bc903f", "requestBody": { "content": { "application/json": { "schema": { "properties": { "workspace_id": { "type": "string" }, "user_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Add a users access to a workspace", "operationId": "7395f71d13bc634350563dae006d3a40", "requestBody": { "content": { "application/json": { "schema": { "properties": { "workspace_id": { "type": "string" }, "user_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/WorkspaceTeam.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a list of users with access to the workspace", "description": "Test", "operationId": "WorkspaceTeam", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace_id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "An integer value for what page", "required": false, "explode": true, "schema": { "type": "integer", "default": "1" } }, { "name": "limit", "in": "query", "description": "The max number of records per page", "required": false, "explode": true, "schema": { "type": "integer", "default": "30" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/WorkspaceSupression.json": { "get": { "tags": [ "Workspace" ], "summary": "Check if phone number is on suppression for a workspace", "description": "Test", "operationId": "WorkspaceSupression", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace_id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "phone", "in": "query", "description": "A complete E164 phone number country code needs to be included", "required": true, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Workspace" ], "summary": "Add phone number to workspace supression needs to be E164 format country code included ex. 15555555555", "operationId": "fe0dce95f4c6fbdccac47e6d8ee30ed4", "requestBody": { "content": { "application/json": { "schema": { "required": [ "workspace_id", "phone" ], "properties": { "workspace_id": { "type": "string", "default": "" }, "phone": { "type": "string", "default": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Workspace" ], "summary": "Delete a phone number from a workspace suppression.", "operationId": "3a0ba7bb024ce272af6158c006b3b710", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "workspace_id", "phone" ], "properties": { "workspace_id": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/WorkspaceInbox.json": { "get": { "tags": [ "Workspace" ], "summary": "Get the conversations for a workspace", "description": "Test", "operationId": "WorkspaceInbox", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace_id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "lead_id", "in": "query", "description": "An optional lead ID", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "phone", "in": "query", "description": "An optional phone number", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "detailed", "in": "query", "description": "An optional flag that can be used in conjunction with the lead_id or phone to get a tag report with the response", "required": false, "explode": true, "schema": { "type": "boolean", "default": "" } }, { "name": "page", "in": "query", "description": "An integer value for what page", "required": false, "explode": true, "schema": { "type": "integer", "default": "1" } }, { "name": "limit", "in": "query", "description": "The max number of records per page", "required": false, "explode": true, "schema": { "type": "integer", "default": "30" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Workspace" ], "summary": "Add a lead to a workspace", "operationId": "540293527bf3ab463f8da833b6f92783", "requestBody": { "content": { "application/json": { "schema": { "required": [ "workspace_id" ], "properties": { "workspace_id": { "type": "string", "default": "" }, "first_name": { "type": "string", "default": "" }, "last_name": { "type": "string", "default": "" }, "phone": { "type": "string", "default": "" }, "email": { "type": "string", "default": "" }, "address1": { "type": "string", "default": "" }, "address2": { "type": "string", "default": "" }, "city": { "type": "string", "default": "" }, "state": { "type": "string", "default": "" }, "zip_code": { "type": "string", "default": "" }, "timezone": { "type": "string", "default": "" }, "country": { "type": "string", "default": "" }, "locked": { "type": "boolean", "default": false }, "...custom_fields": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Add a users access to a workspace", "operationId": "b77f2b6a8504c73fd250e393528985f0", "requestBody": { "content": { "application/json": { "schema": { "required": [ "workspace_id", "lead_id" ], "properties": { "workspace_id": { "type": "string" }, "lead_id": { "type": "string" }, "...fields": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/WorkspaceInboxSearch.json": { "get": { "tags": [ "Workspace" ], "summary": "Search a workspace for a lead", "description": "Test", "operationId": "WorkspaceInboxSearch", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace_id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "phone", "in": "query", "description": "The leads phone number", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "first_name", "in": "query", "description": "The leads first name", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "last_name", "in": "query", "description": "The leads last_name", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "email", "in": "query", "description": "The leads email address", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "The leads state", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "tags", "in": "query", "description": "Find the leads that have a tag or set of tags use a , to seperate tags in searching on multiple tag values. Use the tag_matching to determine if and OR or AND should be used.", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "tag_matching", "in": "query", "description": "Use this option to determine if the tag seach should be and AND or OR", "required": false, "explode": true, "schema": { "type": "string", "default": "AND", "enum": [ "AND", "OR" ] } }, { "name": "responders_only", "in": "query", "description": "Return only leads that have responded", "required": false, "explode": true, "schema": { "type": "boolean", "default": "false" } }, { "name": "page", "in": "query", "description": "An integer value for what page", "required": false, "explode": true, "schema": { "type": "integer", "default": "1" } }, { "name": "limit", "in": "query", "description": "The max number of records per page", "required": false, "explode": true, "schema": { "type": "integer", "default": "30" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/WorkspaceInboxByTags.json": { "get": { "tags": [ "Workspace" ], "summary": "Filter the inbox by Tags and Tag creatation date", "description": "Test", "operationId": "WorkspaceInboxByTags", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace_id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "tags", "in": "query", "description": "Find the leads that have a tag or set of tags use a , to seperate tags in searching on multiple tag values. Use the tag_matching to determine if and OR or AND should be used.", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "tag_matching", "in": "query", "description": "Use this option to determine if the tag seach should be and AND or OR", "required": false, "explode": true, "schema": { "type": "string", "default": "AND", "enum": [ "AND", "OR" ] } }, { "name": "start_date", "in": "query", "description": "An ISO 8601 fomratted start date", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "end_date", "in": "query", "description": "An ISO 8601 fomratted end date", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "An integer value for what page", "required": false, "explode": true, "schema": { "type": "integer", "default": "1" } }, { "name": "limit", "in": "query", "description": "The max number of records per page", "required": false, "explode": true, "schema": { "type": "integer", "default": "30" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/LeadsByTagsReport.json": { "get": { "tags": [ "Reports" ], "summary": "Filter the lead by Tags and Lead creatation date", "description": "Test", "operationId": "LeadsByTagsReport", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace_id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "tags", "in": "query", "description": "Find the leads that have a tag or set of tags use a , to seperate tags in searching on multiple tag values. Use the tag_matching to determine if and OR or AND should be used.", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "tag_matching", "in": "query", "description": "Use this option to determine if the tag seach should be and AND or OR", "required": false, "explode": true, "schema": { "type": "string", "default": "AND", "enum": [ "AND", "OR" ] } }, { "name": "start_date", "in": "query", "description": "An ISO 8601 fomratted start date", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "end_date", "in": "query", "description": "An ISO 8601 fomratted end date", "required": false, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Conversation.json": { "get": { "tags": [ "Workspace" ], "summary": "Get conversation for a lead ID", "description": "Test", "operationId": "Conversation", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace ID to search", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "lead_id", "in": "query", "description": "The system ID for a lead/contact in a workspace", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "msg_id", "in": "query", "description": "Get a single message by ID", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "An integer value for what page", "required": false, "explode": true, "schema": { "type": "integer", "default": "1" } }, { "name": "limit", "in": "query", "description": "The max number of records per page", "required": false, "explode": true, "schema": { "type": "integer", "default": "30" } }, { "name": "sort", "in": "query", "description": "The sort order in asc or desc order", "required": false, "explode": true, "schema": { "type": "string", "default": "asc" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Workspace" ], "summary": "Delete a Conversation and Lead.", "operationId": "caa5c243d8b5fef6c5cbcf944e85d8f2", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "workspace_id", "lead_id" ], "properties": { "workspace_id": { "type": "string" }, "lead_id": { "type": "string" }, "phone": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/TagConversation.json": { "delete": { "tags": [ "Workspace" ], "summary": "Remove a Tag from Lead.", "operationId": "9c5c6a9cd9092bcd3c4c7ed1584b8396", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "lead_id", "tag" ], "properties": { "lead_id": { "type": "string" }, "tag": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Add a tag to a conversation", "operationId": "a711c3910dad88b7f5e86bf334a566a7", "requestBody": { "content": { "application/json": { "schema": { "required": [ "lead_id_id", "tag" ], "properties": { "lead_id": { "type": "string", "default": "" }, "tag": { "type": "string", "default": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/GetTagReport.json": { "post": { "tags": [ "Workspace" ], "summary": "Get a tag report for a workspace", "operationId": "8327777ac673d1a1b123aa35fb78b2b2", "requestBody": { "content": { "application/json": { "schema": { "required": [ "workspace_id", "time_from" ], "properties": { "workspace_id": { "type": "string", "default": "" }, "lookup_type": { "type": "string", "default": "lead_date", "enum": [ "lead_date", "tag_date" ] }, "time_from": { "type": "string", "default": "" }, "time_to": { "type": "string", "default": "" }, "timezone": { "type": "string", "default": "" }, "conversion_tags": { "type": "object", "default": "" }, "disqualified_tags": { "type": "object", "default": "" }, "not_interested_tags": { "type": "object", "default": "" }, "segments": { "type": "object", "default": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Journey.json": { "get": { "tags": [ "Journey" ], "summary": "Get a list of Journeys for a workspace", "description": "Test", "operationId": "Journey", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "journey_id", "in": "query", "description": "The specific journeys id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Journey" ], "summary": "Create a new Journey", "operationId": "8b01f74f22ca9c9af9a2ef082d417f11", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "workspace_id" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "workspace_id": { "type": "uuid" }, "active": { "type": "boolean" }, "collection_id": { "type": "uuid" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Journey" ], "summary": "Delete a journey.", "operationId": "2377efcde4d43aa7ecb94b54a5e37a34", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "journey_id" ], "properties": { "journey_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Journey" ], "summary": "Update a journeys details.", "operationId": "a2f316e62d01aaf05bafcc489e7745b1", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "journey_id" ], "properties": { "journey_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "active": { "type": "boolean" }, "collection_id": { "type": "uuid" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Collections.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a list of jouney Collections for a workspace", "description": "Test", "operationId": "Workspace", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "collection_id", "in": "query", "description": "The specific collection id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Workspace" ], "summary": "Create a new Journey Collection", "operationId": "ea04a9aefe841caea1851d6859e513dd", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "workspace_id" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "workspace_id": { "type": "uuid" }, "settings": { "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Workspace" ], "summary": "Delete a journey collection.", "operationId": "6dfabe42c71078d0a83f3d669452113d", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "collection_id" ], "properties": { "collection_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Update a journey collections details.", "operationId": "e102b996343ed4cc8fd2623b1d06402c", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "collection_id" ], "properties": { "collection_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "settings": { "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Flow.json": { "get": { "tags": [ "Journey" ], "summary": "Get a list of versions or a specific flow in a Journey", "description": "Test", "operationId": "Flow", "parameters": [ { "name": "journey_id", "in": "query", "description": "The specific journeys id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "flow_id", "in": "query", "description": "The specific flow id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Journey" ], "summary": "Create a new flow", "operationId": "f5a39d33a58be6349407c1aef3d0053c", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "journey_id", "content" ], "properties": { "name": { "type": "string" }, "content": { "type": "string" }, "description": { "type": "string" }, "journey_id": { "type": "string" }, "active": { "type": "boolean" }, "clone_flow_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Journey" ], "summary": "Delete a flow version [This method maybe disabled but it is here for now].", "operationId": "863a7dc7f7d56464b942d737ece51b7c", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "flow_id" ], "properties": { "flow_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Journey" ], "summary": "Update a flows details and content.", "operationId": "37a4b44261b58b4bca3d594c73700aeb", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "flow_id" ], "properties": { "flow_id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "content": { "type": "string" }, "active": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Publish.json": { "patch": { "tags": [ "Journey" ], "summary": "Publish a flow for a journey.", "operationId": "5af155ffffb96c761ff4530e366f154b", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "flow_id" ], "properties": { "flow_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Simulate.json": { "post": { "tags": [ "Journey" ], "summary": "Test a specific flow through a websocket.", "operationId": "0145a1512d5cfb94f715f3d5e452fab2", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "flow_id" ], "properties": { "flow_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/FlowVersions.json": { "get": { "tags": [ "Journey" ], "summary": "Get a list of flow versions", "description": "Test", "operationId": "FlowVersions", "parameters": [ { "name": "journey_id", "in": "query", "description": "The specific journeys id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Agents.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a list of Agents for a workspace", "description": "Test", "operationId": "Agents", "parameters": [ { "name": "agent_id", "in": "query", "description": "The agents id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "workspace_id", "in": "query", "description": "The workspace id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Workspace" ], "summary": "Create a new Agent", "operationId": "9e6b1a0eceb3f44f11ecab0363afe304", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "workspace_id" ], "properties": { "workspace_id": { "type": "string" }, "journey_id": { "type": "string" }, "name": { "type": "string" }, "configuration": { "type": "object" }, "voice": { "type": "object" }, "advanced": { "type": "object" }, "analysis": { "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Workspace" ], "summary": "Delete an agent.", "operationId": "25dc531462cf9e91952ea57d04864531", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "agent_id" ], "properties": { "agent_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Update a Agents details.", "operationId": "5bc5457f21b1e444c2a1a9ef22672cac", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "agent_id" ], "properties": { "agent_id": { "type": "string" }, "journey_id": { "type": "string" }, "name": { "type": "string" }, "configuration": { "type": "object" }, "voice": { "type": "object" }, "advanced": { "type": "object" }, "analysis": { "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/BackgroundAudio.json": { "get": { "tags": [ "System" ], "summary": "Get a list of Background Audio options", "description": "Test", "operationId": "BackgroundAudio", "parameters": [ { "name": "system_id", "in": "query", "description": "The system id of the option", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/TempApiKey.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a temp API Key for a workspace", "description": "Test", "operationId": "TempApiKey", "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/ApiKey.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a list of API Keys for a workspace", "description": "Test", "operationId": "ApiKey", "parameters": [ { "name": "apikey_id", "in": "query", "description": "Get an API Key by its system id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "workspace_id", "in": "query", "description": "The workspace id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Workspace" ], "summary": "Create a new API Key", "operationId": "48668f81c276e83612c969a302539941", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "workspace_id" ], "properties": { "workspace_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Workspace" ], "summary": "Delete an API Key.", "operationId": "95f90acaa681022735d11624c0fe99d2", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "apikey_id" ], "properties": { "apikey_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Update a API Key name.", "operationId": "e4cd15c63030120eede91d37fb454403", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "apikey_id", "name" ], "properties": { "apikey_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Models.json": { "get": { "tags": [ "System" ], "summary": "Get a list of Ai Models options", "description": "Test", "operationId": "Models", "parameters": [ { "name": "system_id", "in": "query", "description": "The system id of the option", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/Voices.json": { "get": { "tags": [ "System" ], "summary": "Get a list of TTS Voice options", "description": "Test", "operationId": "Voices", "parameters": [ { "name": "system_id", "in": "query", "description": "The system id of the option", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/SpeechToText.json": { "get": { "tags": [ "System" ], "summary": "Get a list of STT Model options", "description": "Test", "operationId": "speech", "parameters": [ { "name": "system_id", "in": "query", "description": "The system id of the option", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/PhoneGroups.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a list of phone groups for a workspace", "description": "Test", "operationId": "PhoneGroups", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "group_id", "in": "query", "description": "The specific group id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "Workspace" ], "summary": "Create a new Phone Group", "operationId": "6e31f5d94d950a0189adb91ce4e85d2f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "workspace_id" ], "properties": { "name": { "type": "string" }, "active": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Workspace" ], "summary": "Delete a phone group.", "operationId": "66753fff4ab5e35efa156bf79d00f89f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "group_id" ], "properties": { "group_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Workspace" ], "summary": "Update a phone group details.", "operationId": "e1b645a6073565b57b3a118d8412c863", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "group_id" ], "properties": { "group_id": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/PhoneNumber.json": { "get": { "tags": [ "Phone Numbers" ], "summary": "Get a list of phone numbers for a workspace/group/account or a single phone number", "description": "Test", "operationId": "PhoneNumber", "parameters": [ { "name": "phone_id", "in": "query", "description": "The specific phone id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "workspace_id", "in": "query", "description": "The workspace id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "group_id", "in": "query", "description": "The group id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "Phone Numbers" ], "summary": "Update a phone details.", "operationId": "3f0363d4880a5b641b01546b05e1d43f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "phone_id" ], "properties": { "phone_id": { "type": "string" }, "name": { "type": "string" }, "group_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/RCSChannels.json": { "get": { "tags": [ "Workspace" ], "summary": "Get a list of RCS channels", "description": "Test", "operationId": "RCSChannels", "parameters": [ { "name": "rcs_id", "in": "query", "description": "The specific RCS channel system id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "workspace_id", "in": "query", "description": "The workspace id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "limit", "in": "query", "description": "Number of returned records", "required": false, "explode": true, "schema": { "type": "integer", "default": 30 } }, { "name": "page", "in": "query", "description": "Start at a specific page", "required": false, "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/setDefaultHookUrl.json": { "patch": { "tags": [ "Phone Numbers" ], "summary": "Updates a phone number to the default web hooks for SMS.", "operationId": "58c6414dbad60c4ba4b2a5c03c4c4654", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "phone_id" ], "properties": { "phone_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/CloneJourney.json": { "post": { "tags": [ "Journey" ], "summary": "Clone an existing Journey", "operationId": "1b978586bf95eaf0530cda40dae8b1e5", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "journey_id" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "journey_id": { "type": "uuid" }, "active": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/CheckUserWorkspaceAccess.json": { "get": { "tags": [ "System" ], "summary": "Check Workspace access for a user id", "description": "Test", "operationId": "CheckUserWorkspaceAccess", "parameters": [ { "name": "user_id", "in": "query", "description": "The users system id ", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "workspace_id", "in": "query", "description": "The workspace system id ", "required": true, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/LiveCalls.json": { "get": { "tags": [ "Calls" ], "summary": "View all live calls", "description": "This method is used to query the live calls", "operationId": "LiveCalls", "parameters": [ { "name": "agent_id", "in": "query", "description": "The agents id ", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "workspace_id", "in": "query", "description": "The workspace system id ", "required": false, "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } }, "/WaitQueue.json": { "get": { "tags": [ "Workspace" ], "summary": "Get Leads in the wait queue", "description": "Test", "operationId": "WaitQueue", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace_id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "lead_id", "in": "query", "description": "Used to find all the items in the wait queue by lead_id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "job_id", "in": "query", "description": "Used to find a current job by its uuid", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "lookup_key", "in": "query", "description": "To and From phone hash used for SMS replies", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "An integer value for what page", "required": false, "explode": true, "schema": { "type": "integer", "default": "1" } }, { "name": "limit", "in": "query", "description": "The max number of records per page", "required": false, "explode": true, "schema": { "type": "integer", "default": "30" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "Workspace" ], "summary": "Delete a lead from the wait queue.", "operationId": "4d264d1037625f85cf11b9062f4dbcf0", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "lead_id" ], "properties": { "lead_id": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "404": { "description": "Not Found" } }, "security": [ { "bearerAuth": [] } ] } }, "/LookupCDR.json": { "get": { "tags": [ "Workspace" ], "summary": "Get Leads in the wait queue", "description": "Test", "operationId": "LookupCDR", "parameters": [ { "name": "workspace_id", "in": "query", "description": "The workspace_id", "required": true, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "call_id", "in": "query", "description": "Used to find all the items in the wait CDR by call_id", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "from", "in": "query", "description": "Used to find all the items in the CDR by phone", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "to", "in": "query", "description": "Used to find all the items in the CDR by phone", "required": false, "explode": true, "schema": { "type": "string", "default": "" } }, { "name": "page", "in": "query", "description": "An integer value for what page", "required": false, "explode": true, "schema": { "type": "integer", "default": "1" } }, { "name": "limit", "in": "query", "description": "The max number of records per page", "required": false, "explode": true, "schema": { "type": "integer", "default": "30" } } ], "responses": { "200": { "description": "successful operation" }, "404": { "description": "Not found" } }, "security": [ { "bearerAuth": [] } ] } } }, "components": { "schemas": { "USERAPI": { "type": "integer", "maximum": 500, "minimum": 1 } }, "securitySchemes": { "bearerAuth": { "type": "http", "description": "JWT Authentication", "in": "header", "scheme": "bearer" } } }, "tags": [ { "name": "User", "description": "Backend user releated methods" }, { "name": "Account", "description": "Backend Account releated methods" }, { "name": "Workspace", "description": "Backend workspace releated methods" }, { "name": "Journey", "description": "Backend journy releated methods" } ] }