SIGNL4 REST API – Introduction
\r\nUse the SIGNL4 REST API to integrate external systems or build custom workflows and applications on top of SIGNL4.\r\n The API enables seamless interaction with alerts, users, and on-call scheduling.
\r\nTypical use cases include:\r\n
Important:
\r\nIf your primary goal is simply to send event or alert data to SIGNL4 (for example, from monitoring tools or scripts),\r\n you may consider using the SIGNL4 inbound webhook instead\r\n (https://docs.signl4.com/integrations/webhook/webhook.html). The webhook provides a simpler and more lightweight way\r\n to trigger alerts without implementing a full API-based integration.
Versioning:\r\n
The SIGNL4 API is versioned to ensure backward compatibility and stable integrations. Each request must specify the\r\n API version in the base URL, for example: https://connect.signl4.com/api/v3/. We recommend always using a fixed\r\n version (e.g., /v3/) to avoid unexpected breaking changes.
Authentication:\r\n
Access to the SIGNL4 API requires an API key. You can generate an API key in the SIGNL4 portal under Integrations →\r\n API Keys. Include the API key in every request using the HTTP header: X-S4-Api-Key.
Base URL: https://connect.signl4.com/api/v3/
\r\nCopyright © Derdack
", "contact": { "url": "https://www.signl4.com/feedback-we-love-hear-from-you/" }, "license": { "name": "Derdack GmbH", "url": "https://www.signl4.com" }, "version": "3" }, "servers": [ { "url": "https://connect.signl4.com/api" } ], "paths": { "/prepaid/{subscriptionId}/prepaidSettings": { "put": { "tags": [ "Prepaid" ], "summary": "Update a subscription's current prepaid settings.", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "ID of the subscription", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Settings object containing the new values.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/prepaid/balance": { "get": { "tags": [ "Prepaid" ], "summary": "Get your subscription's current prepaid balance.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrepaidBalanceInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrepaidBalanceInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepaidBalanceInfo" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/prepaid/settings": { "get": { "tags": [ "Prepaid" ], "summary": "Get your subscription's current prepaid settings.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } }, "put": { "tags": [ "Prepaid" ], "summary": "Update your subscription's current prepaid settings.", "requestBody": { "description": "Settings object containing the new values.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/prepaid/transactions": { "get": { "tags": [ "Prepaid" ], "summary": "Get your subscription's prepaid transactions.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrepaidTransactionInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrepaidTransactionInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrepaidTransactionInfo" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/scripts/instances": { "get": { "tags": [ "Scripts" ], "summary": "Returns all script instances of the SIGNL4 team", "description": "Returns all script instances in the subscription.", "parameters": [ { "name": "teamId", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "modifiedSince", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptInstanceInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptInstanceInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptInstanceInfo" } } } } }, "400": { "description": "Required information could not be found in the request/claims.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } }, "post": { "tags": [ "Scripts" ], "summary": "Creates a new script instance in the in the SIGNL4 team.", "description": "Creates a new script instance of the script specified in the request body.", "requestBody": { "description": "Script instance to be created.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceCreateInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceCreateInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceCreateInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceCreateInfo" } } } }, "responses": { "200": { "description": "Existing script instance was updated as specified in body.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } } } }, "201": { "description": "New script instance was updated as specified in body.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } } } }, "400": { "description": "Required information could not be found in the request/claims.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Required entities could not be found in the database.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "An internal error has occurred during instance creation.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/scripts/instances/{instanceId}": { "get": { "tags": [ "Scripts" ], "summary": "Returns all information about a given script instance which includes its runtime status.", "description": "Gets the script instance specified by the passed instance id.", "parameters": [ { "name": "instanceId", "in": "path", "description": "Instance Id of script instance to be returned.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } } } }, "400": { "description": "Required information could not be found in the request/claims.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Required entities could not be found in the database or in memory.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } }, "put": { "tags": [ "Scripts" ], "summary": "Updates a given script instance, typically used for updating the configuration of a script.", "description": "Updates the specified script instance.", "parameters": [ { "name": "instanceId", "in": "path", "description": "InstanceId of the script to be updated.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Script instance to be updated.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceUpdateInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceUpdateInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceUpdateInfo" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceUpdateInfo" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } } } }, "400": { "description": "Required information could not be found in the request/claims.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Required entities could not be found in the database.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "An internal error has occurred during instance creation.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } }, "delete": { "tags": [ "Scripts" ], "summary": "Deletes a script instance.", "description": "Gets the script instance specified by the passed instance id.", "parameters": [ { "name": "instanceId", "in": "path", "description": "Instance Id of script instance to be returned.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Required information could not be found in the request/claims.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Required entities could not be found in the database or in memory.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/scripts/instances/{instanceId}/data": { "put": { "tags": [ "Scripts" ], "summary": "Updates custom data of a given script instance which includes its display name.", "description": "Updates the specified script instance.", "parameters": [ { "name": "instanceId", "in": "path", "description": "InstanceId of the script to be updated.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Script instance to be updated.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceCustomUserData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceCustomUserData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceCustomUserData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceCustomUserData" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } } } }, "400": { "description": "Required information could not be found in the request/claims.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Required entities could not be found in the database.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "An internal error has occurred during instance creation.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/scripts/instances/{instanceId}/disable": { "post": { "tags": [ "Scripts" ], "summary": "Disables a given script instance.", "parameters": [ { "name": "instanceId", "in": "path", "description": "Id of the instance to be disabled.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/scripts/instances/{instanceId}/enable": { "post": { "tags": [ "Scripts" ], "summary": "Enables a script instance.", "parameters": [ { "name": "instanceId", "in": "path", "description": "Id of the instance to be enabled.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/scripts/inventory": { "get": { "tags": [ "Scripts" ], "summary": "Returns all available inventory scripts which can be added to a SIGNL4 subscription.", "description": "Returns all available inventory scripts which can be added to a SIGNL4 subscription.", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryScriptInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryScriptInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryScriptInfo" } } } } }, "400": { "description": "Required information could not be found in the request/claims.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "An internal error occurred while loading all inventory scripts.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/scripts/inventory/parsed": { "get": { "tags": [ "Scripts" ], "summary": "Returns all inventory scripts.", "parameters": [ { "name": "language", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryScriptInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryScriptInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryScriptInfo" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/scripts/inventory/parsed/{scriptId}": { "get": { "tags": [ "Scripts" ], "summary": "Returns an inventory script by its id.", "description": "Gets the script specified by the passed script id.", "parameters": [ { "name": "scriptId", "in": "path", "description": "The Id of the script to be returned.", "required": true, "schema": { "type": "string" } }, { "name": "language", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ScriptInstanceDetails" } } } }, "400": { "description": "Required information could not be found in the request/claims.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Required entities could not be found in the database or in memory.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/subscriptions/{subscriptionId}/prepaidBalance": { "get": { "tags": [ "Prepaid" ], "summary": "Get a subscription's current prepaid balance.", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrepaidBalanceInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrepaidBalanceInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepaidBalanceInfo" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/subscriptions/{subscriptionId}/prepaidSettings": { "get": { "tags": [ "Prepaid" ], "summary": "Get a subscription's current prepaid settings.", "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepaidSettingsInfo" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/subscriptions/{subscriptionId}/prepaidTransactions": { "get": { "tags": [ "Prepaid" ], "summary": "Get a subscription's prepaid transactions.", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "ID of the subscription to get transactions for", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrepaidTransactionInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrepaidTransactionInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PrepaidTransactionInfo" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseContent" } } } } } } }, "/v3/audits": { "get": { "tags": [ "Audits" ], "summary": "Get Audit Logs", "parameters": [ { "name": "language", "in": "query", "description": "Language of the requested autit logs", "schema": { "$ref": "#/components/schemas/SupportedLanguage" } }, { "name": "teamId", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "initiatorType", "in": "query", "schema": { "$ref": "#/components/schemas/LogInitiatorTypes" } }, { "name": "initiatorId", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogEntryCategories" }, "x-enum-varnames": [ "None", "User", "Team", "AlertingPattern", "Category", "ApiKey", "Integration", "Workflows", "ExternalWebhook", "RemoteAction", "Schedule", "Shift", "InboundNumber", "Template", "Scim", "Feed", "Stakeholder", "Alert", "AI", "Retention", "InventoryScript", "RemoteActionDefinition", "Subscription", "Branch", "Reporting" ] } }, { "name": "type", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LogEntryTypes" }, "x-enum-varnames": [ "None", "UserInvited", "UserReInvited", "UserInviteDeleted", "UserInviteExpired", "UserActivated", "UserActivationExpired", "UserMigratedToExternal", "UserCreated", "UserDeleted", "UserRenamed", "UserImageUploaded", "UserImageDeleted", "RemoteActionPinUpdated", "UserPunchedIn", "UserPunchedInAsManager", "UserPunchedOut", "UserEnabled", "UserDisabled", "UserMfaEnrollmentStarted", "UserMfaEnabled", "UserMfaDisabled", "AddressUpdated", "AddressDeleted", "PhoneAddressValidated", "PhoneAddressValidationExpired", "PushAddressExpired", "UserAbsenceCreatedOrUpdated", "UserAbsenceDeleted", "TeamCreated", "TeamDeleted", "TeamRenamed", "TeamImageUploaded", "TeamImageDeleted", "TeamAlertSettingsUpdated", "TeamAlertSettingsDeleted", "TeamAlertsDeleted", "TeamEventsDeleted", "TeamHolidaysDeleted", "TeamAlertAuditReportsDeleted", "TeamUserAssigned", "TeamUserRemoved", "TeamUserRoleSpecified", "TeamUserRoleChanged", "TeamPrivacyUpdated", "AlertingPatternCreated", "AlertingPatternDeleted", "AlertingPatternUpdated", "AlertingPatternsDeleted", "CategoryCreated", "CategoryDeleted", "CategoryUpdated", "CategoriesDeleted", "CategoryAssigned", "CategoryAssignedMuted", "CategoryAssignedHidden", "SharedCalendarUserKeyCreated", "SharedCalendarUserKeyDeleted", "SharedCalendarTeamKeyCreated", "SharedCalendarTeamKeyDeleted", "SettingUpdated", "SettingDeleted", "ApiKeyCreated", "ApiKeyDeleted", "ApiKeyUpdated", "ApiKeyRenamed", "ApiKeyEnabled", "ApiKeyDisabled", "ApiKeyExpired", "IntegrationCreated", "IntegrationDeleted", "IntegrationUpdated", "IntegrationRenamed", "IntegrationEnabled", "IntegrationDisabled", "IntegrationSetToGlobal", "IntegrationTeamAssigned", "IntegrationSecretUpdated", "WorkflowCreated", "WorkflowDeleted", "WorkflowUpdated", "WorkflowRenamed", "WorkflowEnabled", "WorkflowDisabled", "WorkflowTeamAssigned", "WorkflowTeamRemoved", "WorkflowEventSourceChanged", "WorkflowDistributionListAssigned", "WorkflowDistributionListRemoved", "ExternalWebhookCreated", "ExternalWebhookDeleted", "ExternalWebhookUpdated", "ExternalWebhookRenamed", "ExternalWebhookEnabled", "ExternalWebhookDisabled", "ExternalWebhookSetToGlobal", "ExternalWebhookTeamAssigned", "RemoteActionCreated", "RemoteActionDeleted", "RemoteActionUpdated", "RemoteActionRenamed", "RemoteActionEnabled", "RemoteActionDisabled", "RemoteActionSetToGlobal", "RemoteActionTeamAssigned", "ScheduleCreated", "ScheduleDeleted", "ScheduleUpdated", "SchedulesDeleted", "SchedulesCreatedInRange", "SchedulesDeletedInRange", "StandInCreated", "StandInUpdated", "StandInDeleted", "ShiftCreated", "ShiftDeleted", "ShiftUpdated", "ShiftRenamed", "ShiftUserAssigned", "ShiftUserRemoved", "ShiftUserReplaced", "ShiftUserMoved", "ShiftUserSwap", "ShiftUsersRemovedFromFutureIntervals", "InboundNumberCreated", "InboundNumberUpdated", "InboundNumberDeleted", "InboundNumberChangeStarted", "InboundNumberChangeCompleted", "InboundNumberChangeCancelled", "TemplateCreated", "TemplateUpdated", "TemplateDeleted", "TemplateExecuted", "ScimEnabled", "ScimDisabled", "ScimApiKeyCreated", "ScimSettingsChanged", "ScimSynchronizationSummary", "DistributionListCreated", "DistributionListDeleted", "DistributionListRenamed", "DistributionListAlertsDeleted", "DistributionListEventsDeleted", "DistributionListUserAssigned", "DistributionListUserRemoved", "DistributionListStakeholderAssigned", "DistributionListStakeholderRemoved", "DistributionListAlertSettingsUpdated", "StakeholderInvited", "StakeholderReInvited", "StakeholderInviteDeleted", "StakeholderInviteExpired", "StakeholderInviteActivated", "StakeholderCreated", "StakeholderDeleted", "StakeholderRenamed", "StakeholderUpdated", "StakeholderPasswordChanged", "StakeholderPasswordReset", "StakeholderEnabled", "StakeholderDisabled", "StakeholderAddressUpdated", "StakeholderAddressDeleted", "StakeholderPushAddressExpired", "AlertCreated", "AlertAcknowledged", "AlertUnAcknowledged", "AlertClosed", "AlertUnClosed", "AlertAnnotated", "AlertEscalatedToTeam", "AlertEscalatedToManagers", "AlertsAllAcknowledged", "AlertsAllClosed", "AlertAcknowledgedByEvent", "AlertClosedByEvent", "EventWaitingForAutoClose", "EventAutoClosed", "EventNotEnoughOccurrences", "EventDuplicateSupressed", "EventProcessingContinued", "EventTeamAssignedByAI", "AlertSummaryCreated", "ExpiredAuditsDeleted", "ExpiredAlertsDeleted", "ExpiredEventsDeleted", "ExpiredSchedulesDeleted", "ExpiredDutyReportsDeleted", "ExpiredAlertAuditsDeleted", "ExpiredAlertReportsDeleted", "InventoryScriptCreated", "InventoryScriptDeleted", "InventoryScriptUpdated", "InventoryScriptsLoaded", "RemoteActionDefinitionCreated", "RemoteActionDefinitionDeleted", "RemoteActionDefinitionUpdated", "RemoteActionDefinitionEnabled", "RemoteActionDefinitionDisabled", "RemoteActionDefinitionInvalid", "SubscriptionCreated", "SubscriptionDeleted", "SubscriptionUpdated", "SubscriptionRenamed", "SubscriptionSettingsUpdated", "SubscriptionUserLicensesUpdated", "SubscriptionVoiceLicensesUpdated", "SubscriptionAutoTopUpEnabled", "SubscriptionAutoTopUpDisabled", "InactiveSubscriptionDeleted", "SubscriptionSupportPinGenerated", "SubscriptionImageUploaded", "SubscriptionImageDeleted", "SubscriptionImageSettingsChanged", "SubscriptionCancelled", "LastAdministratorChanged", "PrepaidPackagePurchased", "BranchCreated", "BranchSubscriptionCreated", "BranchManagerDeleted", "ReportingSettingsUpdated", "SubscriptionOwnerChanged", "SubscriptionRemovedFromBranch", "SubscriptionBoundToManager", "SubscriptionBoundToReferrer" ] } }, { "name": "messageContains", "in": "query", "schema": { "type": "string" } }, { "name": "initiatorContains", "in": "query", "schema": { "type": "string" } }, { "name": "maxResults", "in": "query", "description": "Maximum logs to return", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "continuationToken", "in": "query", "description": "Continuation token in case of paging", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PagedResultsPublicV2`1