# Versori User Documentation - [Getting Started with Versori](https://docs.versori.com/latest/home.md) - [The Plan Agent: Research & Scope Your Integrations](https://docs.versori.com/latest/how-it-works/plan.md) - [The Connect Agent: Manage Your Systems and Authentication](https://docs.versori.com/latest/how-it-works/connect.md) - [The Build Agent: Implement Your Custom Workflows](https://docs.versori.com/latest/how-it-works/build.md) - [The Deploy Agent: Release & Monitor Your Integrations](https://docs.versori.com/latest/how-it-works/deploy.md) - [Connectors](https://docs.versori.com/latest/concepts/connectors.md) - [Connections](https://docs.versori.com/latest/concepts/connections.md) - [Run SDK](https://docs.versori.com/latest/concepts/run-sdk.md) - [Deployment](https://docs.versori.com/latest/concepts/deployment.md) - [Changelog](https://docs.versori.com/latest/changelog.md): Product updates and announcements - [The Chat: Plan and Build in One Conversation](https://docs.versori.com/latest/guides/getting-started/chat.md) - [Starting your plan](https://docs.versori.com/latest/guides/getting-started/plan.md) - [Plan Questions](https://docs.versori.com/latest/guides/getting-started/plan/questions.md) - [Connecting](https://docs.versori.com/latest/guides/getting-started/connect.md) - [Embedded connectors](https://docs.versori.com/latest/guides/getting-started/connect/embedded-connectors.md) - [Bypass authentication](https://docs.versori.com/latest/guides/getting-started/connect/bypass-auth.md) - [Building your integration](https://docs.versori.com/latest/guides/getting-started/build.md) - [Version control](https://docs.versori.com/latest/guides/getting-started/build/versions.md) - [Environments](https://docs.versori.com/latest/guides/getting-started/build/environments.md) - [Testing](https://docs.versori.com/latest/guides/getting-started/build/test.md) - [Field Mapping](https://docs.versori.com/latest/guides/getting-started/build/field-mapping.md): Map fields between your connected systems in the Field Mapping tab, with AI-assisted expressions and transformation pipelines. - [Deploy](https://docs.versori.com/latest/guides/getting-started/deploy.md) - [Monitoring your integration](https://docs.versori.com/latest/guides/getting-started/monitor.md): Use logs, issues, and email channels to monitor a deployed integration, and optionally attach Issue Watcher to investigate failures. - [Issue Watcher: Fixes Proposed From Real Failures](https://docs.versori.com/latest/guides/getting-started/monitor/issue-watcher.md) - [Prompting tips](https://docs.versori.com/latest/guides/getting-started/misc/prompting-tips.md) - [Single Sign-On](https://docs.versori.com/latest/guides/sso/overview.md) - [Setting Up Single Sign-On](https://docs.versori.com/latest/guides/sso/admin-setup.md) - [Real-time Workflows](https://docs.versori.com/latest/guides/use-cases/real-time.md) - [Batch Jobs](https://docs.versori.com/latest/guides/use-cases/batch.md) - [Bidirectional Data Sync](https://docs.versori.com/latest/guides/use-cases/bidirectional.md) - [Multi-tenant Integrations](https://docs.versori.com/latest/guides/use-cases/multi-tenancy.md) - [Authentication Methods](https://docs.versori.com/latest/guides/auth-methods/introduction.md) - [HTTP](https://docs.versori.com/latest/guides/auth-methods/http.md) - [API Key](https://docs.versori.com/latest/guides/auth-methods/api-key.md) - [OAuth 2.0](https://docs.versori.com/latest/guides/auth-methods/oauth2.md) - [Authorization Code](https://docs.versori.com/latest/guides/auth-methods/oauth2/authorization-code.md) - [Client Credentials](https://docs.versori.com/latest/guides/auth-methods/oauth2/client-credentials.md) - [Password/Resource Owner](https://docs.versori.com/latest/guides/auth-methods/oauth2/password-resource-owner.md) - [Refresh Token](https://docs.versori.com/latest/guides/auth-methods/oauth2/refresh-token.md) - [OAuth 1.0](https://docs.versori.com/latest/guides/auth-methods/oauth1.md) - [IP Allowlist](https://docs.versori.com/latest/guides/advanced/ip-allowlist.md) - [Run SDK](https://docs.versori.com/latest/run-sdk/latest/introduction.md) - [Connections](https://docs.versori.com/latest/run-sdk/latest/connections.md) - [Workflows, Triggers and Tasks](https://docs.versori.com/latest/run-sdk/latest/workflows.md) - [Inputs and outputs](https://docs.versori.com/latest/run-sdk/latest/workflows/inputs-outputs.md) - [Task Types](https://docs.versori.com/latest/run-sdk/latest/workflows/task-types.md) - [Background](https://docs.versori.com/latest/run-sdk/latest/workflows/background.md) - [Catch](https://docs.versori.com/latest/run-sdk/latest/workflows/catch.md) - [The Context Object](https://docs.versori.com/latest/run-sdk/latest/context.md) - [Durable Workflows](https://docs.versori.com/latest/run-sdk/latest/durable-workflows.md) - [Developers Overview](https://docs.versori.com/latest/run-sdk/latest/developers/overview.md) - [Introduction](https://docs.versori.com/latest/cli/introduction.md): A command-line interface for managing resources on the Versori platform. - [Installation](https://docs.versori.com/latest/cli/installation.md): Install the Versori CLI on macOS, Linux, or Windows. - [Quickstart](https://docs.versori.com/latest/cli/quickstart.md): Set up authentication and run your first CLI command. - [context](https://docs.versori.com/latest/cli/commands/context.md): Manages the authentications to the Versori platform - [projects](https://docs.versori.com/latest/cli/commands/projects.md): Manage projects, deployments, versions, assets, and environments - [projects activations](https://docs.versori.com/latest/cli/commands/projects/activations.md): Manage activations (end-user → environment links). Alias for the activation-lifecycle commands under `versori projects users`. - [projects asset](https://docs.versori.com/latest/cli/commands/projects/asset.md): Manage assets within a project - [projects environments](https://docs.versori.com/latest/cli/commands/projects/environments.md): Manage project environments - [projects systems](https://docs.versori.com/latest/cli/commands/projects/systems.md): Manage systems within a project - [projects users](https://docs.versori.com/latest/cli/commands/projects/users.md): Manage users (activations) within a project - [projects variables](https://docs.versori.com/latest/cli/commands/projects/variables.md): Manage a project's DynamicVariablesSchema (declares valid activation-variable keys) - [projects versions](https://docs.versori.com/latest/cli/commands/projects/versions.md): Manage versions within a project. - [systems](https://docs.versori.com/latest/cli/commands/systems.md): Manage systems - [connections](https://docs.versori.com/latest/cli/commands/connections.md): Manage connections - [kv](https://docs.versori.com/latest/cli/commands/kv.md): Inspect and manage KV store entries - [kv stores](https://docs.versori.com/latest/cli/commands/kv/stores.md): Inspect KV stores - [issues](https://docs.versori.com/latest/cli/commands/issues.md): List, inspect, and update issues - [notifications](https://docs.versori.com/latest/cli/commands/notifications.md): Manage notification channels and project notification bindings - [notifications channels](https://docs.versori.com/latest/cli/commands/notifications/channels.md): Manage organisation-wide notification channels - [notifications project](https://docs.versori.com/latest/cli/commands/notifications/project.md): Link, unlink, and list notification channels on a project + environment - [skills](https://docs.versori.com/latest/cli/commands/skills.md): Manages the skills - [users](https://docs.versori.com/latest/cli/commands/users.md): Manage users - [execution-pools](https://docs.versori.com/latest/cli/commands/execution-pools.md): Manage execution pools - [completion](https://docs.versori.com/latest/cli/commands/completion.md): Generate the autocompletion script for the specified shell - [Configuration](https://docs.versori.com/latest/cli/configuration.md): Configure the Versori CLI with contexts and global settings. - [Project Workflow](https://docs.versori.com/latest/cli/workflow.md): A typical workflow for managing Versori projects with the CLI. - [Connections Guide](https://docs.versori.com/latest/cli/connections.md): Learn how connections work in Versori and how to manage them using the CLI. - [Cloud Agents](https://docs.versori.com/latest/ai-tooling/cloud-agents.md): What Cloud Agents are, how they differ from the agents you work with in chat, and what they can do on your behalf. - [Skills](https://docs.versori.com/latest/ai-tooling/skills.md): What Skills are in the Versori platform, how to write one, and how the AI applies them when planning and building integrations. - [Skills Marketplace](https://docs.versori.com/latest/ai-tooling/marketplace.md): Browse the Versori skills catalogue, add skills to your organisation, and fork them to fit how your team works. - [Manage Your Skills](https://docs.versori.com/latest/ai-tooling/manage-skills.md): Upload your own skills to your Versori organisation, then edit them, set whether they always apply, and remove them. - [AI-Assisted Integration Development](https://docs.versori.com/latest/ai-tooling/overview.md): Use the Versori skill in your AI coding tool to build data integrations locally. - [Installation](https://docs.versori.com/latest/ai-tooling/installation.md): Add the Versori skill to Cursor, Codex, Claude Code, or any other AI coding tool. - [Workflow](https://docs.versori.com/latest/ai-tooling/workflow.md): The structured 8-step process the Versori skill follows to build integrations. - [Tips & Best Practices](https://docs.versori.com/latest/ai-tooling/tips.md): Get the most out of AI-assisted integration development with the Versori skill. - [Versori Skill](https://docs.versori.com/latest/ai-tooling/versori-skill.md): What the coding-versori-sdk skill contains, how it is structured, and the platform behaviour it encodes. - [Getting Started](https://docs.versori.com/latest/api-reference/getting-started.md): Get started with Versori APIs. - [Authentication](https://docs.versori.com/latest/api-reference/authentication.md): Learn how to authenticate with the Versori Platform. - [Getting Started](https://docs.versori.com/latest/api-reference/platform-api/getting-started.md): Get started with the Versori Platform API. - [Activates a User on an Environment.](https://docs.versori.com/api-reference/platform-api/end_users/activates-a-user-on-an-environment.md): ActivateUser activates a user on an environment. This will create a new activation record for the user on the environment. Connections must be made for all environment systems to be successfully activated. - [List End Users](https://docs.versori.com/api-reference/platform-api/end_users/list-end-users.md): ListEndUsers returns a list of all the End Users for the given organisation. - [Create an End User](https://docs.versori.com/api-reference/platform-api/end_users/create-an-end-user.md): CreateEndUser creates a new End User for the given organisation. - [Retrieve an End User](https://docs.versori.com/api-reference/platform-api/end_users/retrieve-an-end-user.md): GetEndUser returns the End User for the given user ID. - [Delete an End User](https://docs.versori.com/api-reference/platform-api/end_users/delete-an-end-user.md): DeleteEndUser deletes the End User for the given user ID. - [List available execution pools.](https://docs.versori.com/api-reference/platform-api/execution_pools/list-available-execution-pools.md) - [List projects for organisation](https://docs.versori.com/api-reference/platform-api/projects/list-projects-for-organisation.md) - [Create new project](https://docs.versori.com/api-reference/platform-api/projects/create-new-project.md): CreateProject creates a new project. - [Get Project](https://docs.versori.com/api-reference/platform-api/projects/get-project.md): GetProject returns the files and configuration for the specified project ID. If one does not exist then a 404 will be returned. - [Update Project](https://docs.versori.com/api-reference/platform-api/projects/update-project.md): UpdateProject updates the project record. This endpoint will not make changes to the file or the running deployment. - [Delete Project](https://docs.versori.com/api-reference/platform-api/projects/delete-project.md): DeleteProject delete the project. - [Clone Project](https://docs.versori.com/api-reference/platform-api/projects/clone-project.md): CloneProject clones the project with the given ID. The new project will have a new ID and will not be deployed. The files and configuration will be copied from the original project. Connection templates will be copied, however no connections will be created. - [Clone Environment](https://docs.versori.com/api-reference/platform-api/projects/clone-environment.md): CloneEnvironment creates a new environment by copying the details of an existing environment in the same project. - [Sync Environments](https://docs.versori.com/api-reference/platform-api/projects/sync-environments.md): SyncEnvironments copies the deployment configuration (currently the deployed docker image/version) from one environment to another within the same project. - [Get project variables](https://docs.versori.com/api-reference/platform-api/projects/get-project-variables.md): GetProjectVariablesSchema returns the variables schema for the project. - [Set the schema for the project variables](https://docs.versori.com/api-reference/platform-api/projects/set-the-schema-for-the-project-variables.md): SetProjectVariablesSchema sets the JSON schema for the project's dynamic variables. Dynamic variables can then be set by end users on activation. This schema is used to validate the variables when they are set and defines the variables that can be set and used within the integration code. - [Patch the schema for the project's dynamic variables](https://docs.versori.com/api-reference/platform-api/projects/patch-the-schema-for-the-projects-dynamic-variables.md): PatchProjectVariablesSchema patches the JSON schema for the project's dynamic variables. This allows you to add, remove or edit the schema for the project's dynamic variables. - [Add sentiment data to project history](https://docs.versori.com/api-reference/platform-api/projects/add-sentiment-data-to-project-history.md): AddProjectSentiment adds a new sentiment entry to the project's sentiment history. This endpoint appends to the existing sentiment history in the project metadata. - [Get Files](https://docs.versori.com/api-reference/platform-api/projects/get-files.md): GetFiles returns the current files for the project. Those may not be the files that the project is deployed with. - [Update Files](https://docs.versori.com/api-reference/platform-api/projects/update-files.md): UpdateFiles updates the files for the project. This will not deploy the project. - [Patch Files](https://docs.versori.com/api-reference/platform-api/projects/patch-files.md): PatchFiles updates only the files that are specified in the payload. - [Change the execution pool of an environment](https://docs.versori.com/api-reference/platform-api/projects/change-the-execution-pool-of-an-environment.md): Updates the execution pool used to deploy this environment. If the environment is running it will be suspended first. This will result in a new public URL being created for the environment. - [Call Integration](https://docs.versori.com/api-reference/platform-api/projects/call-integration.md): CallIntegration sends an HTTP request to a project's deployed environment and returns the response. This allows triggering a project remotely via an HTTP call. - [Deploy Project](https://docs.versori.com/api-reference/platform-api/projects/deploy-project.md): DeployProject deploys the project to the specified environment using the current files. It processes the files to deploy a new version of the project and updates the underlying connector to integrate the new API. - [Deploy Project Version](https://docs.versori.com/api-reference/platform-api/projects/deploy-project-version.md): DeployProjectVersion deploys the project to the specified environment using the specified version. If the docker image is not build for the version it will build one. - [Start Test Container](https://docs.versori.com/api-reference/platform-api/projects/start-test-container.md): StartTestContainer starts a test container for the project. The test container is a temporary environment that can be used to test the project. This endpoint will available triggers for the project. - [Start test workflow](https://docs.versori.com/api-reference/platform-api/projects/start-test-workflow.md): TriggerWorkflow tells the test runner to trigger a test workflow. - [Validate Project Files](https://docs.versori.com/api-reference/platform-api/projects/validate-project-files.md): ValidateFiles validates the project files using deno check without deploying. It processes the files to build a Docker image and runs validation checks to ensure the TypeScript code is valid before deployment. - [Get Project Logs](https://docs.versori.com/api-reference/platform-api/projects/get-project-logs.md) - [Search project logs](https://docs.versori.com/api-reference/platform-api/projects/search-project-logs.md) - [List project traces](https://docs.versori.com/api-reference/platform-api/projects/list-project-traces.md): ListTraces returns a list of traces for the given organisation. - [Get Trace](https://docs.versori.com/api-reference/platform-api/projects/get-trace.md): GetTrace returns an individual trace with all the spans. - [Get integration flows](https://docs.versori.com/api-reference/platform-api/projects/get-integration-flows.md): GetIntegrationFlows returns the OpenTelemetry spans for a project, representing execution traces and telemetry data. - [Get integration flow by name](https://docs.versori.com/api-reference/platform-api/projects/get-integration-flow-by-name.md): GetIntegrationFlow returns a single integration flow by its name. - [Update integration flow](https://docs.versori.com/api-reference/platform-api/projects/update-integration-flow.md): UpdateIntegrationFlow updates or creates a new flow with the given name. This endpoint will overwrite the entire flow with the provided data. - [Delete integration flow](https://docs.versori.com/api-reference/platform-api/projects/delete-integration-flow.md) - [Suspend Project](https://docs.versori.com/api-reference/platform-api/projects/suspend-project.md): Suspend project will stop the project but not delete it. It can be deployed later again. - [UpdateEnvironmentConfig updates the environment config for infrastructure.](https://docs.versori.com/api-reference/platform-api/projects/updateenvironmentconfig-updates-the-environment-config-for-infrastructure.md) - [Lists versions for a project](https://docs.versori.com/api-reference/platform-api/versions/lists-versions-for-a-project.md): List all versions of a project. - [Create a new version for a project.](https://docs.versori.com/api-reference/platform-api/versions/create-a-new-version-for-a-project.md): Create a new version for a project. - [Get Files for a given version](https://docs.versori.com/api-reference/platform-api/versions/get-files-for-a-given-version.md): Retrieves the files for the given version ID and project ID. - [List Connections](https://docs.versori.com/api-reference/platform-api/connections/list-connections.md): ListConnections returns a list of Connections. - [Create a new connection.](https://docs.versori.com/api-reference/platform-api/connections/create-a-new-connection.md): CreateConnection creates a new connection for the given organisation. - [Get a Connection by ID](https://docs.versori.com/api-reference/platform-api/connections/get-a-connection-by-id.md): GetConnection returns the Connection for the given connection ID. - [Update a Connection by ID](https://docs.versori.com/api-reference/platform-api/connections/update-a-connection-by-id.md): UpdateConnection updates the Connection for the given connection ID. - [Delete a Connection by ID](https://docs.versori.com/api-reference/platform-api/connections/delete-a-connection-by-id.md): Delete a Connection by ID. This action will fail if the connections is one that is dynamic and is currently in use by an end user. This action will NOT fail if the connection is a static connection that is in use. - [Link an existing connection to an environment](https://docs.versori.com/api-reference/platform-api/connections/link-an-existing-connection-to-an-environment.md): LinkConnectionToEnvironment links an existing connection to a specified environment. - [Unlink a connection from an environment](https://docs.versori.com/api-reference/platform-api/connections/unlink-a-connection-from-an-environment.md): UnlinkConnectionFromEnvironment removes the link between a connection and an environment for the given connectionTemplateId. - [Retrieve the connection for the activations.](https://docs.versori.com/api-reference/platform-api/connections/retrieve-the-connection-for-the-activations.md) - [List static connections for project environment](https://docs.versori.com/api-reference/platform-api/connections/list-static-connections-for-project-environment.md): Lists all static connections (connections without end users) for a given environment. - [Initialise OAuth 2.0 Connection](https://docs.versori.com/api-reference/platform-api/connections/initialise-oauth-20-connection.md): InitialiseOAuth2Connection returns a URL to redirect the user to an OAuth 2.0 Provider's Authorize endpoint. - [Initialise OAuth 1.0 Connection](https://docs.versori.com/api-reference/platform-api/connections/initialise-oauth-10-connection.md): InitialiseOAuth1Connection returns a URL to redirect the user to an OAuth 1.0 Provider's Authorize endpoint. - [List Automations](https://docs.versori.com/api-reference/platform-api/automations/list-automations.md): ListAutomations returns a list of all the Automations for the given organisation. - [Create a new automation.](https://docs.versori.com/api-reference/platform-api/automations/create-a-new-automation.md) - [List Automation Runs](https://docs.versori.com/api-reference/platform-api/automations/list-automation-runs.md): ListAutomationRuns returns a list of all the Automation Runs for the given automation ID. - [Run an Automation](https://docs.versori.com/api-reference/platform-api/automations/run-an-automation.md) - [Get an Automation by ID](https://docs.versori.com/api-reference/platform-api/automations/get-an-automation-by-id.md): GetAutomation returns the Automation for the given automation ID. - [Update an Automation](https://docs.versori.com/api-reference/platform-api/automations/update-an-automation.md): UpdateAutomation updates the name or prompt template of an existing automation. - [List Recordings](https://docs.versori.com/api-reference/platform-api/automations/list-recordings.md): ListRecordings returns a list of all the Recordings for the given automation ID. - [Create a recording for an automation](https://docs.versori.com/api-reference/platform-api/automations/create-a-recording-for-an-automation.md): CreateRecording creates a recording for an automation. The recording file is uploaded to the GCP bucket and the transcription is requested. - [Get an Automation Run by ID](https://docs.versori.com/api-reference/platform-api/automations/get-an-automation-run-by-id.md): GetAutomationRun returns the Automation Run for the given run ID. - [Get a recording by ID](https://docs.versori.com/api-reference/platform-api/automations/get-a-recording-by-id.md): GetRecording returns the recording for the given recording ID. - [Create a transcription for a recording](https://docs.versori.com/api-reference/platform-api/automations/create-a-transcription-for-a-recording.md): CreateTranscription creates a transcription for a recording. - [List Schedulers](https://docs.versori.com/api-reference/platform-api/schedulers/list-schedulers.md): ListSchedulers returns a list of all the Schedulers for the given environment. - [Get a Scheduler by ID](https://docs.versori.com/api-reference/platform-api/schedulers/get-a-scheduler-by-id.md): GetScheduler returns the Scheduler for the given scheduler ID. - [Trigger a Scheduler once](https://docs.versori.com/api-reference/platform-api/trigger-a-scheduler-once.md): TriggerScheduler triggers the Scheduler for the given scheduler ID once. This is useful for testing or running a one-off task without waiting for the next scheduled run. - [List Activations](https://docs.versori.com/api-reference/platform-api/activations/list-activations.md): ListActivations returns a list of all the Activations for the given environment. - [Retrieve an Activation by ID](https://docs.versori.com/api-reference/platform-api/activations/retrieve-an-activation-by-id.md): GetActivation returns the Activation for the given activation ID. - [Delete an Activation](https://docs.versori.com/api-reference/platform-api/activations/delete-an-activation.md): DeleteActivation deletes the Activation for the given activation ID. - [Set static variables for the static activation](https://docs.versori.com/api-reference/platform-api/activations/set-static-variables-for-the-static-activation.md): Updates one or more static variables for the static user's activation for this environment. The request body will be validated against the variable schema. - [Set dynamic variables for an activation](https://docs.versori.com/api-reference/platform-api/activations/set-dynamic-variables-for-an-activation.md): Updates one or more dynamic variables for the specified activation. The request body will be validated against the variable schema. - [Set a dynamic variable by name](https://docs.versori.com/api-reference/platform-api/activations/set-a-dynamic-variable-by-name.md): Updates a single dynamic variable identified by name for the specified activation. This endpoint is designed to support the SDK's ability to update individual variables with a friendly, descriptive API for error handling. - [List Activations for User](https://docs.versori.com/api-reference/platform-api/activations/list-activations-for-user.md): ListUserActivations returns an array of all activations for a specific user in a given environment. - [Lists the systems for the organisation.](https://docs.versori.com/api-reference/platform-api/systems/lists-the-systems-for-the-organisation.md) - [Create a new system.](https://docs.versori.com/api-reference/platform-api/systems/create-a-new-system.md) - [Get a system by ID.](https://docs.versori.com/api-reference/platform-api/systems/get-a-system-by-id.md) - [Update system.](https://docs.versori.com/api-reference/platform-api/systems/update-system.md) - [Delete a system by ID.](https://docs.versori.com/api-reference/platform-api/systems/delete-a-system-by-id.md): DeleteSystem deletes the system for the given system ID. This endpoint will not allow you to delete a system which is in use by a project. You can check if a system is in use by a project, by listing the project connection templates. - [Link system actions to project.](https://docs.versori.com/api-reference/platform-api/systems/link-system-actions-to-project.md) - [Link system triggers to project.](https://docs.versori.com/api-reference/platform-api/systems/link-system-triggers-to-project.md) - [List actions for a system.](https://docs.versori.com/api-reference/platform-api/systems/list-actions-for-a-system.md): ListSystemActions returns a list of all the actions for the given system. If the `project_id` query parameter is provided, this endpoint will only return actions that are being used in that project. - [Create new actions for a system.](https://docs.versori.com/api-reference/platform-api/systems/create-new-actions-for-a-system.md): Create new actions for a system. If the project ID parameter is provided in the request body, these actions will also be linked with that project. - [Get an action for a system.](https://docs.versori.com/api-reference/platform-api/systems/get-an-action-for-a-system.md): GetSystemAction returns a single action for the given system. - [Update an action for a system.](https://docs.versori.com/api-reference/platform-api/systems/update-an-action-for-a-system.md): UpdateSystemAction updates a single action for the given system. - [Delete an action for a system.](https://docs.versori.com/api-reference/platform-api/systems/delete-an-action-for-a-system.md): DeleteSystemAction deletes a single action for the given system. - [List triggers for a system.](https://docs.versori.com/api-reference/platform-api/systems/list-triggers-for-a-system.md): ListSystemTriggers returns a list of all the triggers for the given system. If the `project_id` query parameter is provided, this endpoint will only return triggers that are being used in that project. - [Create new triggers for a system.](https://docs.versori.com/api-reference/platform-api/systems/create-new-triggers-for-a-system.md): Create new triggers for a system. If the project ID parameter is provided in the request body, these triggers will also be linked with that project. - [Adds or updates an auth scheme for the system.](https://docs.versori.com/api-reference/platform-api/systems/adds-or-updates-an-auth-scheme-for-the-system.md): UpsertAuthSchemeConfig adds or updates an auth scheme for the system. If the auth scheme ID provided doesn't match any of the record, it will be created. If the auth scheme ID provided matches an existing record, it will be updated. The ID in the path needs to match the ID in the body. - [Deletes an auth scheme for the system.](https://docs.versori.com/api-reference/platform-api/systems/deletes-an-auth-scheme-for-the-system.md) - [List project environment connection templates](https://docs.versori.com/api-reference/platform-api/systems/list-project-environment-connection-templates.md) - [Create a new connection template](https://docs.versori.com/api-reference/platform-api/systems/create-a-new-connection-template.md) - [Remove a system from a project environment](https://docs.versori.com/api-reference/platform-api/systems/remove-a-system-from-a-project-environment.md) - [Remove a connection template](https://docs.versori.com/api-reference/platform-api/systems/remove-a-connection-template.md) - [List Issues](https://docs.versori.com/api-reference/platform-api/issues/list-issues.md): ListIssues returns a list of all the Issues for the given organisation. The issues can be filtered by status, assignee, and other parameters. Before and After query parameters refer to the createdAt timestamp of the issue. - [Create a new issue.](https://docs.versori.com/api-reference/platform-api/issues/create-a-new-issue.md) - [Update an Issue](https://docs.versori.com/api-reference/platform-api/issues/update-an-issue.md): UpdateIssue updates the editable fields of an issue. Any fields not provided in the request body will not be changed. - [List notification channels for an organisation](https://docs.versori.com/api-reference/platform-api/notifications/list-notification-channels-for-an-organisation.md) - [Post o notification channels](https://docs.versori.com/api-reference/platform-api/notifications/post-o-notification_channels.md) - [Delete a notification channel](https://docs.versori.com/api-reference/platform-api/notifications/delete-a-notification-channel.md) - [List notifications for a project](https://docs.versori.com/api-reference/platform-api/notifications/list-notifications-for-a-project.md) - [Create a new project notification](https://docs.versori.com/api-reference/platform-api/notifications/create-a-new-project-notification.md) - [Delete a project notification](https://docs.versori.com/api-reference/platform-api/notifications/delete-a-project-notification.md) - [Get organisation metrics summary](https://docs.versori.com/api-reference/platform-api/metrics/get-organisation-metrics-summary.md) - [Get metrics summary for all projects](https://docs.versori.com/api-reference/platform-api/metrics/get-metrics-summary-for-all-projects.md) - [List all stores for an organization](https://docs.versori.com/api-reference/platform-api/kv-store/list-all-stores-for-an-organization.md) - [Create a new store](https://docs.versori.com/api-reference/platform-api/kv-store/create-a-new-store.md) - [Get a value by key](https://docs.versori.com/api-reference/platform-api/kv-store/get-a-value-by-key.md) - [Set a value for a key](https://docs.versori.com/api-reference/platform-api/kv-store/set-a-value-for-a-key.md) - [Delete a key](https://docs.versori.com/api-reference/platform-api/kv-store/delete-a-key.md) - [Set multiple key-value pairs](https://docs.versori.com/api-reference/platform-api/kv-store/set-multiple-key-value-pairs.md) - [Get multiple values by keys](https://docs.versori.com/api-reference/platform-api/kv-store/get-multiple-values-by-keys.md) - [Delete multiple keys](https://docs.versori.com/api-reference/platform-api/kv-store/delete-multiple-keys.md) - [List keys and values with filtering](https://docs.versori.com/api-reference/platform-api/kv-store/list-keys-and-values-with-filtering.md) - [Count entries matching selector](https://docs.versori.com/api-reference/platform-api/kv-store/count-entries-matching-selector.md) - [Getting Started](https://docs.versori.com/latest/api-reference/organisations-api/getting-started.md): Get started with the Versori Organisations API. - [Retrieve public key](https://docs.versori.com/api-reference/organisations-api/signing-keys/retrieve-public-key.md): GetPublicKey returns the public key for the given Signing Key ID. This can be used to verify JWTs signed by an Organisation's Signing Key. - [List Signing Keys](https://docs.versori.com/api-reference/organisations-api/signing-keys/list-signing-keys.md): ListSigningKeys returns a list of all Signing Keys for the Organisation. - [Create Signing Key](https://docs.versori.com/api-reference/organisations-api/signing-keys/create-signing-key.md): CreateSigningKey creates a new Signing Key for the Organisation. - [Delete Signing Key](https://docs.versori.com/api-reference/organisations-api/signing-keys/delete-signing-key.md): DeleteSigningKey deletes the signing key for the Organisation. - [Get Active Organisation](https://docs.versori.com/api-reference/organisations-api/get-active-organisation.md): GetActiveOrganisation returns the active Organisation for the current user. - [Get Organisations](https://docs.versori.com/api-reference/organisations-api/get-organisations.md): GetOrganisations returns a paginated list of Organisations which the current user is a member of. If there is no filter provided, the result will always contain the active Organisation as the first item of the first page. Otherwise, the filter is applied to the name and slug using a case-insensitive… - [Create Organisation](https://docs.versori.com/api-reference/organisations-api/create-organisation.md): CreateOrganisation creates a new Organisation with the current user as the owner. A user can create as many Organisations as they like, but each has their own billing profile and must be on a paid plan to use certain features. - [Get Organisation](https://docs.versori.com/api-reference/organisations-api/get-organisation.md): Get an Organisation by its ID - [Get Members](https://docs.versori.com/api-reference/organisations-api/get-members.md): GetMembers returns a paginated list of members for the given Organisation. - [Get Member](https://docs.versori.com/api-reference/organisations-api/get-member.md): GetMember returns a member for the given Organisation. - [Delete Member](https://docs.versori.com/api-reference/organisations-api/delete-member.md): DeleteMember removes a member from the given Organisation. - [Get Service Accounts](https://docs.versori.com/api-reference/organisations-api/get-service-accounts.md): GetServiceAccounts returns a paginated list of ServiceAccounts for the given Organisation. - [Create Service Account](https://docs.versori.com/api-reference/organisations-api/create-service-account.md): CreateServiceAccount creates a new ServiceAccount for the given Organisation. The ServiceAccount will be created with a random client ID and secret, which will be returned in the response. - [Get Service Account](https://docs.versori.com/api-reference/organisations-api/get-service-account.md): GetServiceAccount returns a ServiceAccount for the given Organisation. - [Delete Service Account](https://docs.versori.com/api-reference/organisations-api/delete-service-account.md): DeleteServiceAccount deletes a ServiceAccount for the given Organisation. - [Get Groups](https://docs.versori.com/api-reference/organisations-api/get-groups.md): GetGroups returns a paginated list of Groups for the given Organisation. - [Create Group](https://docs.versori.com/api-reference/organisations-api/create-group.md): CreateGroup creates a new Group for the given Organisation. - [Get Group](https://docs.versori.com/api-reference/organisations-api/get-group.md): GetGroup returns a Group for the given Organisation. - [Delete Group](https://docs.versori.com/api-reference/organisations-api/delete-group.md): DeleteGroup deletes a Group for the given Organisation. - [Get Invitations](https://docs.versori.com/api-reference/organisations-api/get-invitations.md): GetInvitations returns a paginated list of invitations for the given Organisation. - [Invite Member](https://docs.versori.com/api-reference/organisations-api/invite-member.md): InviteMember invites a new User to the given Organisation. The user will receive an email with a link to accept the invitation. The invitation is valid for 7 days, after which the invitation will need to be resent or deleted. Expired invitations may be deleted manually, or will be automatically dele… - [Delete Invitation](https://docs.versori.com/api-reference/organisations-api/delete-invitation.md): DeleteInvitation deletes an invitation for the given Organisation. This is typically used to invalidate an invitation which is no longer required. - [Accept Invitation](https://docs.versori.com/api-reference/organisations-api/accept-invitation.md): AcceptInvitation accepts an invitation for the given Organisation. The authenticated user email must match the email address of the invitation. - [Resend Invitation](https://docs.versori.com/api-reference/organisations-api/resend-invitation.md): ResendInvitation resends an invitation for the given Organisation. This is typically used to resend an invitation which has expired or was not received. Everytime an invitation is resent, the expiresAt time is updated to 7 days from the current time. - [Set Active Organisation](https://docs.versori.com/api-reference/organisations-api/set-active-organisation.md): SetActiveOrganisation sets the active Organisation for the current user and returns said Organisation. - [Get Billing](https://docs.versori.com/api-reference/organisations-api/get-billing.md): GetBilling returns the billing information for the given Organisation. - [Update Billing Details such as billing email](https://docs.versori.com/api-reference/organisations-api/update-billing-details-such-as-billing-email.md): UpdateBillingDetails updates the billing details for the given Organisation. This endpoint can be used to update the billing email address for the Organisation as well as the customerID, subscriptionID and platformID. - [Get Invoices](https://docs.versori.com/api-reference/organisations-api/get-invoices.md): GetInvoices returns a paginated list of invoices for the given Organisation. The query parameters `from` and `to` can be used to filter the invoices returned. If no query parameters are provided, this endpoint will return the upcoming invoice. If to is not provided, it will default to the current da… - [Update Subscription](https://docs.versori.com/api-reference/organisations-api/update-subscription.md): UpdateSubscription updates the subscription for the given Organisation. This endpoint can be used to increase the board quota of an organisation. It will update the billing information to reflect the amount of boards that are allowed to be published. - [Create Checkout Session](https://docs.versori.com/api-reference/organisations-api/create-checkout-session.md): CreateCheckoutSession creates a new checkout session for the given Organisation. This will redirect the user to the Stripe checkout page to complete the payment. - [Get Slug Availability](https://docs.versori.com/api-reference/organisations-api/get-slug-availability.md): GetSlugAvailability validates and returns whether the slug provided in the URL is available for use. Requests to this endpoint are purposefully slow to mitigate automated enumeration of slugs. - [Post billing webhooks](https://docs.versori.com/api-reference/organisations-api/webhooks/post-billing-webhooks.md): BillingWebhooks is the endpoint for receiving webhooks from the billing platform. This endpoint is used to update the billing information for an Organisation. Right now, only Stripe webhooks are supported. - [Welcome](https://docs.versori.com/legacy/welcome.md): Welcome to the Versori Platform documentation. - [Introduction](https://docs.versori.com/legacy/concepts.md) - [Overview](https://docs.versori.com/legacy/concepts/connectors.md): Connect your APIs to the Versori Platform. - [Protocols](https://docs.versori.com/legacy/concepts/connectors/protocols.md): Learn about the protocols used by the Versori Platform. - [Authentication Methods](https://docs.versori.com/legacy/concepts/connectors/authentication-methods.md) - [Actions](https://docs.versori.com/legacy/concepts/connectors/actions.md) - [Triggers](https://docs.versori.com/legacy/concepts/connectors/triggers.md) - [Connections](https://docs.versori.com/legacy/concepts/connectors/connections.md): Provide credentials for a Connector to facilitate Versori to interact with an external system. - [Overview](https://docs.versori.com/legacy/concepts/boards.md): Build integrations between your systems with Boards. - [Introduction](https://docs.versori.com/legacy/integrate/intro.md): Build integrations between your internal systems. - [Overview](https://docs.versori.com/legacy/integrate/boards.md): Boards are the entrypoint to building integrations. - [Overview](https://docs.versori.com/legacy/integrate/boards/tools.md): Tools provide the building blocks to build you integrations. - [Jay](https://docs.versori.com/legacy/integrate/boards/tools/jay.md): Welcome to **Jay**, your AI assistant by Versori! - [Trigger](https://docs.versori.com/legacy/integrate/boards/tools/trigger.md): The Trigger is used to trigger an action on a schedule. - [Filter](https://docs.versori.com/legacy/integrate/boards/tools/filter.md): Filter data in an Integration workflow - [Transformer](https://docs.versori.com/legacy/integrate/boards/tools/transformer.md): The transformer action is a drag and drop action that allows you to transform the data in your workflow. - [Code Tool](https://docs.versori.com/legacy/integrate/boards/tools/code-tool.md): The Code Tool gives the ability to write custom Node.js code against the data in an integration. It also offers the ability to write a custom output schema, which can be useful to reshape the data for later on in an integration. - [Email](https://docs.versori.com/legacy/integrate/boards/tools/email.md) - [Variables](https://docs.versori.com/legacy/integrate/boards/tools/global-variables.md) - [Splitter](https://docs.versori.com/legacy/integrate/boards/tools/splitter.md): Process list items individually in an Integration workflow - [Introduction](https://docs.versori.com/legacy/embedded/intro.md) - [How It Works](https://docs.versori.com/legacy/embedded/how-it-works.md) - [Dynamic Extractor](https://docs.versori.com/legacy/embedded/integrations/tools/user_extractor.md) - [Creating a Hub](https://docs.versori.com/legacy/embedded/guides/create-hub.md) - [Introduction](https://docs.versori.com/legacy/embedded/developer/intro.md) - [Quickstart React](https://docs.versori.com/legacy/embedded/developer/quickstart-react.md) - [Quickstart](https://docs.versori.com/legacy/embedded/sdks/typescript.md) - [React SDK](https://docs.versori.com/legacy/embedded/sdks/react.md) - [Introduction](https://docs.versori.com/legacy/switchboard/introduction.md): Welcome to the user documentation for the Versori Platform - [Introduction](https://docs.versori.com/legacy/switchboard/introduction.md): Welcome to the user documentation for the Versori Platform - [Core Concepts](https://docs.versori.com/legacy/switchboard/core-concepts.md): Welcome to the user documentation for the Versori Platform - [Apps](https://docs.versori.com/legacy/switchboard/features/apps.md): Within Switchboard, apps are the external-system nodes that you use to build out your integrations. - [Boards](https://docs.versori.com/legacy/switchboard/features/boards.md) - [Board Editor](https://docs.versori.com/legacy/switchboard/features/board-editor.md): The Board Editor is your main tool for creating and editing boards. It is a visual tool that allows you to create and edit boards by dragging and dropping components onto the board. - [Hubs SDK](https://docs.versori.com/legacy/switchboard/features/hubs-sdk.md): The Hubs SDK is a tool that allows the users of your Product to integrate into different Apps you have configured in the Versori Platform. - [Overview](https://docs.versori.com/legacy/switchboard/features/actions/overview.md): Learn how to use Actions to automate your workflows. - [Transformer](https://docs.versori.com/legacy/switchboard/features/actions/transformer.md): The transformer action is a drag and drop action that allows you to transform the data in your workflow. - [Databuilder](https://docs.versori.com/legacy/switchboard/features/actions/databuilder.md): The Databuilder allows for familiar form based templating and transformations - [Filter](https://docs.versori.com/legacy/switchboard/features/actions/filter.md): The filter action allows you to filter the resulting data based on a series of conditions. - [Datamapper](https://docs.versori.com/legacy/switchboard/features/actions/datamapper.md): Datamapper provides storage within Switchboard for remembering cross-system references to different entities. - [Batch](https://docs.versori.com/legacy/switchboard/features/actions/batch.md): The Batch action allows you to aggregate requests into a single output format. - [Delay](https://docs.versori.com/legacy/switchboard/features/actions/delay.md): The Delay Action is used to delay the execution of the next node in the workflow. - [Splitter](https://docs.versori.com/legacy/switchboard/features/actions/splitter.md): The Splitter Action accepts a List input and splits each item to be processed individually. - [Trigger](https://docs.versori.com/legacy/switchboard/features/actions/trigger.md): The Trigger Action is used as a startpoint within your flows, to trigger requests either manually or on a schedule. - [Onboard a REST API](https://docs.versori.com/legacy/switchboard/how-to-guides/apps/onboarding-apps/rest-api.md): REST apps are onboarded via uploading an OpenAPI specification file. - [Onboard a GraphQL API](https://docs.versori.com/legacy/switchboard/how-to-guides/apps/onboarding-apps/graphql-api.md): GraphQL Apps are onboarded by providing a URL for introspection. - [Onboard an SQL App](https://docs.versori.com/legacy/switchboard/how-to-guides/apps/onboarding-apps/sql-app.md) - [How to create a Board, an use the Board Editor](https://docs.versori.com/legacy/switchboard/how-to-guides/create-a-board.md): Boards are built from Apps, and Actions in a drag-and-drop interface. - [How to Connect to your Apps](https://docs.versori.com/legacy/switchboard/how-to-guides/connect-to-an-app.md): Multiple methods of connecting your apps are available. - [How to add a Webhook Listener into your Integration](https://docs.versori.com/legacy/switchboard/how-to-guides/adding-a-webhook.md): When building your integrations - you can add your operations from different systems, and provide further configuration. - [How to use Selectors to template data within your Integrations](https://docs.versori.com/legacy/switchboard/how-to-guides/using-selectors.md): Selectors provide an intuitive interface for plucking data from previous steps in your flow, to be used within your requests and actions. - [How to use the Versori Hubs SDK](https://docs.versori.com/legacy/switchboard/how-to-guides/using-the-hubs-sdk.md): The Hubs SDK enables users to authenticate and onboard into external integrations that are connected to your product - [Authentication](https://docs.versori.com/legacy/api-reference/authentication.md): Learn how to authenticate with the Versori Platform. - [Introduction](https://docs.versori.com/legacy/api-reference/connect.md): Our next-generation API for connecting to your external systems. - [Create a new new connector version.](https://docs.versori.com/legacy/api-reference/connect-api/protocol-http/create-a-new-new-connector-version.md): ImportHTTPConnectorVersion is used to create a new version for the connector. - [Import HTTP Connector](https://docs.versori.com/legacy/api-reference/connect-api/protocol-http/import-http-connector.md): ImportHTTPConnector imports a Connector from another format such as OpenAPI or Postman Collections. - [Create HTTP Connector](https://docs.versori.com/legacy/api-reference/connect-api/connectors/create-http-connector.md): CreateHTTPConnector creates a new HTTP Connector. By default the Connector will be created in a draft state and will need to be published before it can be used by other Versori products. - [List Connectors](https://docs.versori.com/legacy/api-reference/connect-api/connectors/list-connectors.md): ListConnectors returns a paginated list of Connectors, ordered with most recently updated first. - [List Public Connectors](https://docs.versori.com/legacy/api-reference/connect-api/connectors/list-public-connectors.md): ListConnectors returns a paginated list of all public Connectors, ordered with most recently updated first. - [Get Connector](https://docs.versori.com/legacy/api-reference/connect-api/connectors/get-connector.md): GetConnector returns a single Connector for the specified ID. If one does not exist then a 404 will be returned. - [Update Connector](https://docs.versori.com/legacy/api-reference/connect-api/connectors/update-connector.md): UpdateConnector updates a Connector with the specified request body. All mutable fields are updated as per the request body, and the `updatedAt` field is set to the current time. Any missing fields will be unset unless this causes a validation error, in which case the request will fail with a 400 Ba… - [Update Connector Tags](https://docs.versori.com/legacy/api-reference/connect-api/connectors/update-connector-tags.md): UpdateConnectorTags updates the tags for a Connector. The tags are replaced with the new tags provided in the request body. - [Update Connector Categories](https://docs.versori.com/legacy/api-reference/connect-api/connectors/update-connector-categories.md): UpdateConnectorCategories updates the categories for a Connector. The categories are replaced with the new categories provided in the request body. - [Upsert Auth Scheme Config to Connector](https://docs.versori.com/legacy/api-reference/connect-api/connectors/upsert-auth-scheme-config-to-connector.md): UpsertAuthSchemeConfig updates or adds an AuthSchemeConfig to the specified Connector. The ID must be generated by the client and be unique across all other AuthSchemeConfig objects for this connector. - [Delete Connector](https://docs.versori.com/legacy/api-reference/connect-api/connectors/delete-connector.md): DeleteConnector deletes a Connector with the specified ID. If the Connector is in use by another product then a 409 Conflict response will be returned. If the Connector does not exist then a 404 Not Found response will be returned. - [Create Connector Version](https://docs.versori.com/legacy/api-reference/connect-api/connector-version/create-connector-version.md): CreateConnectorVersion creates a new ConnectorVersion for the specified Connector. The ConnectorVersion will be created as a draft (i.e. publishedAt will be `null`). - [Import Public Connector Version](https://docs.versori.com/legacy/api-reference/connect-api/connector-version/import-public-connector-version.md): ImportPublicConnectorVersion imports a public ConnectorVersion into the users organisation. - [List Connector Versions](https://docs.versori.com/legacy/api-reference/connect-api/connector-version/list-connector-versions.md): ListConnectorVersions returns a page of ConnectorVersions ordered by most recently updated first. Customising the sort behaviour is not currently supported but may be added in the future. Similarly with filtering, this will be implemented in a future release. - [Get Connector Version](https://docs.versori.com/legacy/api-reference/connect-api/connector-version/get-connector-version.md): GetConnectorVersion returns a single ConnectorVersion for the specified ID. If one does not exist then a 404 will be returned. - [Update Connector Version](https://docs.versori.com/legacy/api-reference/connect-api/connector-version/update-connector-version.md): UpdateConnectorVersion updates a ConnectorVersion with the specified request body. Changes to read-only fields will result in a 400 Bad Request response. - [Delete Connector Version](https://docs.versori.com/legacy/api-reference/connect-api/connector-version/delete-connector-version.md): DeleteConnectorVersion deletes a ConnectorVersion with the specified version name. - [Create a new connection.](https://docs.versori.com/legacy/api-reference/connect-api/connections/create-a-new-connection.md): CreateConnectorConnection creates a new connection for the given connector. - [List Connector Connections](https://docs.versori.com/legacy/api-reference/connect-api/connections/list-connector-connections.md): ListConnectorConnections returns a paginated list of Connections, ordered with most recently updated first. Customising the sort behaviour is not currently supported but may be added in the future. Similarly with filtering, this will be implemented in a future release. - [Get Connection](https://docs.versori.com/legacy/api-reference/connect-api/connections/get-connection.md): GetConnection returns a specific Connection within a Connector. - [Update Connection](https://docs.versori.com/legacy/api-reference/connect-api/connections/update-connection.md): UpdateConnection updates an Connection. Credentials may be reordered and AuthSchemeConfigs updated, however actual Credentials may only be updated via the `UpdateCredential` operation. - [Delete Connection](https://docs.versori.com/legacy/api-reference/connect-api/connections/delete-connection.md): DeleteConnection deletes an Connection. - [Initialise OAuth 2.0 Connection](https://docs.versori.com/legacy/api-reference/connect-api/connections/initialise-oauth-20-connection.md): InitialiseOAuth2Connection returns a URL to redirect the user to an OAuth 2.0 Provider's Authorize endpoint. - [Create Action](https://docs.versori.com/legacy/api-reference/connect-api/actions/create-action.md): CreateAction creates a new Action for the specified ConnectorVersion. The Action type must be compatible with the protocol of the Connector, otherwise a 400 Bad Request response will be returned. - [Get Actions](https://docs.versori.com/legacy/api-reference/connect-api/actions/get-actions.md): GetActions returns a paginated list of Actions for the specified ConnectorVersion. - [Get Action](https://docs.versori.com/legacy/api-reference/connect-api/actions/get-action.md): GetAction returns the Action for the specified parameters. - [Create Trigger](https://docs.versori.com/legacy/api-reference/connect-api/triggers/create-trigger.md): CreateTrigger creates a new Trigger for the specified ConnectorVersion. The Trigger type must be compatible with the protocol of the Connector, otherwise a 400 Bad Request response will be returned. - [Get Triggers](https://docs.versori.com/legacy/api-reference/connect-api/triggers/get-triggers.md): GetTriggers returns a paginated list of Triggers for the specified ConnectorVersion. - [Get Trigger](https://docs.versori.com/legacy/api-reference/connect-api/triggers/get-trigger.md): GetTrigger returns the Trigger for the specified parameters. - [Create Definitions](https://docs.versori.com/legacy/api-reference/connect-api/definitions/create-definitions.md): CreateDefinitions creates one-many new Definitions for the specified ConnectorVersion. For simple cases, it's recommended to create Definitions individually, however this endpoint can be used to create multiple Definitions for cases where one Definition references another. - [Get Definitions](https://docs.versori.com/legacy/api-reference/connect-api/definitions/get-definitions.md): GetDefinitions returns a paginated list of Definitions for the specified ConnectorVersion. - [Get Definition](https://docs.versori.com/legacy/api-reference/connect-api/definitions/get-definition.md): GetDefinition returns the Definition for the specified parameters. - [Get a Raw Schema](https://docs.versori.com/legacy/api-reference/connect-api/definitions/get-a-raw-schema.md) - [Update Definition](https://docs.versori.com/legacy/api-reference/connect-api/definitions/update-definition.md): UpdateDefinition updates the specified Definition with the request body. - [Delete Definitions](https://docs.versori.com/legacy/api-reference/connect-api/definitions/delete-definitions.md): DeleteDefinitions deletes the specified Definitions as per the request body. - [Delete Definition](https://docs.versori.com/legacy/api-reference/connect-api/definitions/delete-definition.md): DeleteDefinition deletes the specified Definition. - [List Protocols](https://docs.versori.com/legacy/api-reference/connect-api/protocols/list-protocols.md): ListProtocols returns all the supported Protocols for this organisation. - [List Auth Schemes](https://docs.versori.com/legacy/api-reference/connect-api/protocols/list-auth-schemes.md): ListAuthSchemes returns all the supported Auth Schemes for the provided Protocol within this organisation. If a desired Auth Scheme is not listed then please contact support@versori.io to request it be added. - [Get Protocol Upload URL](https://docs.versori.com/legacy/api-reference/connect-api/protocols/get-protocol-upload-url.md): GetProtocolUploadURL returns a Signed URL to an object storage service which can be used to upload a file via a PUT request. This is used as a precursor to importing a Connector from a file, which expects a URL. If the user already has a publicly accessible URL to a file then this step can be skippe… - [List all available categories](https://docs.versori.com/legacy/api-reference/connect-api/misc/list-all-available-categories.md): ListCategories returns a list of all available categories. - [Introduction](https://docs.versori.com/legacy/api-reference/embedded.md): Our next-generation API for exposing Versori-powered integrations to your users. - [List Hubs](https://docs.versori.com/legacy/api-reference/embedded-api/hubs/list-hubs.md): ListHubs returns all the hubs for the given organisation, but is returned as a paginated list. - [Create a new Hub](https://docs.versori.com/legacy/api-reference/embedded-api/hubs/create-a-new-hub.md): Create a new Hub - [Retrieve a Hub](https://docs.versori.com/legacy/api-reference/embedded-api/hubs/retrieve-a-hub.md): GetHub returns the Hub for the given ID. - [Create Integration](https://docs.versori.com/legacy/api-reference/embedded-api/hubs/create-integration.md): Create Integration - [Update integration information](https://docs.versori.com/legacy/api-reference/embedded-api/hubs/update-integration-information.md): Updates an integration information - [List End Users](https://docs.versori.com/legacy/api-reference/embedded-api/end-users/list-end-users.md): ListEndUsers returns a paginated list of all the End Users for the given Hub. - [Create an End User](https://docs.versori.com/legacy/api-reference/embedded-api/end-users/create-an-end-user.md): CreateEndUser creates a new End User for the given Hub. - [Retrieve an End User](https://docs.versori.com/legacy/api-reference/embedded-api/end-users/retrieve-an-end-user.md): GetEndUser returns the End User for the given ID. By default, this ID is assumed to be the external ID for the user. If the `identifier_type` query parameter is set to `internal`, then the internal ID is used. - [List End User Connections](https://docs.versori.com/legacy/api-reference/embedded-api/connections/list-end-user-connections.md): ListEndUserConnections returns all the Connections for the given End User. - [Create End User Connection](https://docs.versori.com/legacy/api-reference/embedded-api/connections/create-end-user-connection.md): CreateEndUserConnection creates a new Connection for the given User. The Connection is used to authenticate the user to a Hub Connector. - [Initialise OAuth 2.0 Connection](https://docs.versori.com/legacy/api-reference/embedded-api/connections/initialise-oauth-20-connection.md): InitialiseOAuth2Connection returns a URL to redirect the user to an OAuth 2.0 Provider's Authorize endpoint. - [List Integrations](https://docs.versori.com/legacy/api-reference/embedded-api/integrations/list-integrations.md): ListIntegrations returns all the integrations for the given Hub. - [Delete an integration.](https://docs.versori.com/legacy/api-reference/embedded-api/integrations/delete-an-integration.md): DeleteIntegration deletes the integration. - [List Hub Connectors](https://docs.versori.com/legacy/api-reference/embedded-api/connectors/list-hub-connectors.md): ListIntegrationConnectors returns all the Hub Connectors for the given Integration. - [Create a Hub Connector](https://docs.versori.com/legacy/api-reference/embedded-api/connectors/create-a-hub-connector.md): CreateHubConnectionTemplate creates a new Hub Connector for the given Integration. - [List End User Integrations](https://docs.versori.com/legacy/api-reference/embedded-api/embedded/list-end-user-integrations.md): ListEndUserIntegrations returns all integrations which are available to the given End User. - [Retrieve an Embedded Integration](https://docs.versori.com/legacy/api-reference/embedded-api/embedded/retrieve-an-embedded-integration.md): GetEmbeddedIntegration returns the Integration for the given ID to be displayed to the user in the embedded UI. - [List End User Activations](https://docs.versori.com/legacy/api-reference/embedded-api/embedded/list-end-user-activations.md): ListEndUserActivations returns all activations which are available to the given End User. This API can be filtered to only return activations for a given integration. - [Activate Integration](https://docs.versori.com/legacy/api-reference/embedded-api/activations/activate-integration.md): ActivateIntegration activates an Integration for an End User. This is the final step in the activation process and will create the necessary connections and configurations to allow the Integration to run. - [Retrieve an Activation](https://docs.versori.com/legacy/api-reference/embedded-api/activations/retrieve-an-activation.md): GetActivation returns the Activation for the given ID. - [Delete an Activation](https://docs.versori.com/legacy/api-reference/embedded-api/activations/delete-an-activation.md): DeleteActivation deletes the Activation for the given ID. - [Health Check](https://docs.versori.com/legacy/api-reference/embedded-api/miscellaneous/health-check.md): HealthCheck returns a successful status if the API is healthy. - [Overview](https://docs.versori.com/legacy/api-reference/organisations-api.md): Organisations API provides access to manage your Versori Organisation. - [Create Signing Key](https://docs.versori.com/legacy/api-reference/organisations-api/v1/signing-keys/post-organisations-keys.md): CreateSigningKey creates a new Signing Key for the Organisation. - [List Signing Keys](https://docs.versori.com/legacy/api-reference/organisations-api/v1/signing-keys/get-organisations-keys.md): ListSigningKeys returns a list of all Signing Keys for the Organisation. - [Delete Signing Key](https://docs.versori.com/legacy/api-reference/organisations-api/v1/signing-keys/delete-organisations-keys.md): DeleteSigningKey deletes the signing key for the Organisation. - [Retrieve public key](https://docs.versori.com/legacy/api-reference/organisations-api/v1/signing-keys/get-keys.md): GetPublicKey returns the public key for the given Signing Key ID. This can be used to verify JWTs signed by an Organisation's Signing Key. - [Overview](https://docs.versori.com/legacy/api-reference/proxy-api.md): Proxy API enables authenticated requests through Connections in the Platform. - [Use Cases](https://docs.versori.com/legacy/api-reference/proxy-api/use-cases.md) - [Endpoint](https://docs.versori.com/legacy/api-reference/proxy-api/endpoint.md) - [Preview the output of a transformer.](https://docs.versori.com/legacy/api-reference/switchboard-api/preview-the-output-of-a-transformer.md): Preview the output of a transformer. This endpoint is useful for testing a transformer before creating an integration. - [Get organisations boards](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/get-organisations-boards.md): Retrieves the boards belonging to a given organisation. - [Post organisations boards](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/post-organisations-boards.md): Create a new Board for the provided organisation. No request body required as all parameters provided by server. - [Post organisations myfirstboard](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/post-organisations-myfirstboard.md): Create a Demo Board for the provided organisation. No request body required as all parameters provided by server. - [Put organisations boards](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/put-organisations-boards.md): Update an existing board, by ID for the given organisation. - [Delete organisations boards](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/delete-organisations-boards.md): Delete an Board by ID in the current organisation. - [Preview the output of a Code Action.](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/preview-the-output-of-a-code-action.md): Preview the output of a Code Action. This endpoint is useful for testing a Code Action. - [Post organisations boards actors test](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/post-organisations-boards-actors-test.md): BoardTest finds the webhook url from within the cluster for a board and sends a POST request to it with the data in the payload. - [Post organisations boards publish](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/post-organisations-boards-publish.md): Publish a board at the revision specified by the provided event ID. This is an asynchronous action, callers should await for a `BoardPublishedEvent` over the websocket API (recommended) or poll GetBoard until `publishedEventId` matches the event ID which has been provided to publish. - [Post organisations boards unpublish](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/post-organisations-boards-unpublish.md): UnpublishBoard stops the board execution. This is an asynchronous request and will respond with a "202 Accepted" to acknowledge that the board has been scheduled for termination. A `BoardUnpublishedEvent` will be emitted once the board has actually been terminated which can be listened for over the… - [Get organisations boards out of date board nodes](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/get-organisations-boards-out-of-date-board-nodes.md): ListOutOfDateNodesForBoard will list for a single board the nodes which are using an operation for a schema which is not the one currently assigned to the corresponding app. - [Get organisations boards variables](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/get-organisations-boards-variables.md): Get the JSON schema for the variables of a board. - [Put organisations boards variables](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/put-organisations-boards-variables.md): Update or create the JSON schema for the variables of a board. - [Put organisations boards variablesglobal](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/put-organisations-boards-variablesglobal.md): Updates or creates the global variable schema for a board. - [Put organisations boards variablesdynamic](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/put-organisations-boards-variablesdynamic.md): Updates or creates the dynamic variable schema for a board. - [Get organisations out of date board nodes](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/get-organisations-out-of-date-board-nodes.md): ListOutOfDateBoardNodes will list all of the board nodes which are using an operation for a schema which is not the one currently assigned to the corresponding app. - [Get organisations boards actors codelogs](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/get-organisations-boards-actors-codelogs.md): CodePreviewExecutionLogs will list for a single code action the execution logs stored in the Google Cloud logging. - [Get organisations boards execution logs](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/get-organisations-boards-execution-logs.md): ListExecutionLogsForBoard will list for a single published board the execution logs stored in the Google Cloud logging. - [Post organisations board instances incoming webhooks](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/post-organisations-board-instances-incoming-webhooks.md): Trigger a board webhook execution. - [Post organisations board instances trigger execution](https://docs.versori.com/legacy/api-reference/switchboard-api/boards/post-organisations-board-instances-trigger-execution.md): Trigger a board to execute specific start-nodes. - [Get organisations hubs](https://docs.versori.com/legacy/api-reference/switchboard-api/hubs/get-organisations-hubs.md): Retrieves the hubs belonging to a given organisation. - [Post organisations hubs](https://docs.versori.com/legacy/api-reference/switchboard-api/hubs/post-organisations-hubs.md): Create a new Hub for the provided organisation. No request body required as all parameters provided by server. - [Put organisations hubs](https://docs.versori.com/legacy/api-reference/switchboard-api/hubs/put-organisations-hubs.md): Update an existing hub, by ID for the given organisation. - [Delete organisations hubs](https://docs.versori.com/legacy/api-reference/switchboard-api/hubs/delete-organisations-hubs.md): Delete a Hub by ID in the current organisation. - [Get organisations hubs boards](https://docs.versori.com/legacy/api-reference/switchboard-api/hubs/get-organisations-hubs-boards.md): Retrieves the boards belonging to a given hub and organisation. - [Post organisations hubs boards](https://docs.versori.com/legacy/api-reference/switchboard-api/hubs/post-organisations-hubs-boards.md): Creates a board associated with the given Hub ID. - [Get organisations hubs boards integration info](https://docs.versori.com/legacy/api-reference/switchboard-api/hubs/get-organisations-hubs-boards-integration-info.md): Retrieves all the information needed that a user needs to fill out to use a Hub integration. - [Get organisations hubs users](https://docs.versori.com/legacy/api-reference/switchboard-api/hubs/get-organisations-hubs-users.md): Retrieves a pagniated list of boards belonging to a given user and hub. - [Get organisations hubs boards users](https://docs.versori.com/legacy/api-reference/switchboard-api/hubs/get-organisations-hubs-boards-users.md): Retrieves all users of a hub board. - [Post organisations hubs boards users](https://docs.versori.com/legacy/api-reference/switchboard-api/hubs/post-organisations-hubs-boards-users.md): Internal endpoint meant to link a dynamic user to a board. - [Delete organisations hubs boards users](https://docs.versori.com/legacy/api-reference/switchboard-api/hubs/delete-organisations-hubs-boards-users.md): Internal endpoint meant to unlink a dynamic user to a board. This would indicate a user has removed an integration from the hub. - [Get organisations data mappings](https://docs.versori.com/legacy/api-reference/switchboard-api/data-mappings/get-organisations-data-mappings.md): Retrieves the data mappings belonging to a given organisation. - [Post organisations data mappings](https://docs.versori.com/legacy/api-reference/switchboard-api/data-mappings/post-organisations-data-mappings.md): Create a new DataMapping for the provided organisation. - [Put organisations data mappings](https://docs.versori.com/legacy/api-reference/switchboard-api/data-mappings/put-organisations-data-mappings.md): Update an existing data mapping, by ID for the given organisation. - [Delete organisations data mappings](https://docs.versori.com/legacy/api-reference/switchboard-api/data-mappings/delete-organisations-data-mappings.md): Delete a DataMapping by ID in the current organisation. - [Get organisations data mappings entries](https://docs.versori.com/legacy/api-reference/switchboard-api/data-mappings/get-organisations-data-mappings-entries.md): Retrieves the data mapping entries belonging to a given organisation and mapping. - [Post organisations data mappings entries](https://docs.versori.com/legacy/api-reference/switchboard-api/data-mappings/post-organisations-data-mappings-entries.md): Create a new DataMappingEntry for the provided organisation and mapping. - [Put organisations data mappings entries](https://docs.versori.com/legacy/api-reference/switchboard-api/data-mappings/put-organisations-data-mappings-entries.md): Update an existing data mapping entry by ID for the given organisation and mapping. - [Delete organisations data mappings entries](https://docs.versori.com/legacy/api-reference/switchboard-api/data-mappings/delete-organisations-data-mappings-entries.md): Delete a DataMappingEntry by ID in the current organisation and mapping. - [Get apps](https://docs.versori.com/legacy/api-reference/switchboard-api/apps/get-apps.md): Retrieves public Apps not owned by this organisation Apps, as a paginated response. - [Get organisations apps](https://docs.versori.com/legacy/api-reference/switchboard-api/apps/get-organisations-apps.md): Retrieves all Apps owned by this organisation as a paginated response. - [Post organisations apps](https://docs.versori.com/legacy/api-reference/switchboard-api/apps/post-organisations-apps.md): Create a new App for the provided organisation - [Put organisations apps](https://docs.versori.com/legacy/api-reference/switchboard-api/apps/put-organisations-apps.md): Update an existing App for by ID in the current organisation. - [Delete organisations apps](https://docs.versori.com/legacy/api-reference/switchboard-api/apps/delete-organisations-apps.md): Delete an App by ID in the current organisation. - [Post organisations apps operation builder](https://docs.versori.com/legacy/api-reference/switchboard-api/apps/post-organisations-apps-operation-builder.md): BuildSchemaOperationForApp validates and uses the schema builder to fill in any possible fields on a proposed new schema operation for an app. - [Get connectionsoauth2callback](https://docs.versori.com/legacy/api-reference/switchboard-api/apps/get-connectionsoauth2callback.md): FinaliseConnectionCallback is the redirect URL to exchange an authorization code for an access token in an OAuth2.0 authorization code grant. It must be noted that the real callback URL configured with the OAuth2.0 provider should be a Switchboard URL (prompted to the user at app-creation time) and… - [Get organisations apps operations](https://docs.versori.com/legacy/api-reference/switchboard-api/operations/get-organisations-apps-operations.md): Retrieve the set of all operations available for the App specified by appId. - [Post organisations apps operations](https://docs.versori.com/legacy/api-reference/switchboard-api/operations/post-organisations-apps-operations.md): Create a new operation for the App in the provided organisation - [Delete organisations apps operations](https://docs.versori.com/legacy/api-reference/switchboard-api/operations/delete-organisations-apps-operations.md): Delete the schema operation belonging to an app. - [Get organisations apps operations schema](https://docs.versori.com/legacy/api-reference/switchboard-api/operations/get-organisations-apps-operations-schema.md): Retrieve the input and output schema for a given operation belonging to an app. - [Get organisations schemas](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/get-organisations-schemas.md): Retrieves all Schemas owned by this organisation as a paginated response. - [Post organisations schemas](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/post-organisations-schemas.md): Create a new schema, which can be used to create an App and in the future be used to reconfigure an existing App. - [Get organisations schemas info](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/get-organisations-schemas-info.md): GetSchemaInfo returns information about a schema. This replaces the deprecated operation `SchemaInfo`. - [Delete organisations schemas](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/delete-organisations-schemas.md): DeleteSchema deletes an unpublished schema. - [Post organisations schemas clone](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/post-organisations-schemas-clone.md): CloneSchema clones an existing schema. - [Post organisations schemas publish](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/post-organisations-schemas-publish.md): PublishSchema publishes an existing schema. - [Get organisations schemas operations](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/get-organisations-schemas-operations.md): Retrieve the set of all operations available for the Schema specified by id. - [Post organisations schemas operations](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/post-organisations-schemas-operations.md): Create a new operation for the Schema in the provided organisation - [Put organisations schemas operations](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/put-organisations-schemas-operations.md): Updates or creates a schema operation. - [Delete organisations schemas operations](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/delete-organisations-schemas-operations.md): Delete the schema operation belonging to an schema. - [Get organisations schemas components](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/get-organisations-schemas-components.md): Retrieve the set of all schema components available for the Schema specified by id. - [Post organisations schemas components](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/post-organisations-schemas-components.md): Create a batch of schema components. - [Put organisations schemas components](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/put-organisations-schemas-components.md): Update a schema component. - [Delete organisations schemas components](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/delete-organisations-schemas-components.md): Deletes a schema component, along with any other components referencing it. - [Post organisations schemas delete components](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/post-organisations-schemas-delete-components.md): DeleteSchemaComponents deletes a list of schema components, along with any others depending on them. - [Post organisations schemas operation builder](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/post-organisations-schemas-operation-builder.md): BuildSchemaOperation validates and uses the schema builder to fill in any possible fields on a proposed new schema operation. - [Put organisations schemas import](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/put-organisations-schemas-import.md): ImportSchemaOperations adds the operations for a schema the database for faster retrieval. - [Post organisations schema utils import](https://docs.versori.com/legacy/api-reference/switchboard-api/schemas/post-organisations-schema-utils-import.md): Create a schema record and import the operations to store locally as DB records. - [Get organisations schema utils signed url](https://docs.versori.com/legacy/api-reference/switchboard-api/get-organisations-schema-utils-signed-url.md): Retrieve a signed URL for uploading a schema specification - [Post organisations schema utils source url](https://docs.versori.com/legacy/api-reference/switchboard-api/post-organisations-schema-utils-source-url.md): Upload a schema document based on a source URL. The server will download this URL and upload to object storage automatically. - [Post organisations schema utils info](https://docs.versori.com/legacy/api-reference/switchboard-api/post-organisations-schema-utils-info.md): SchemaInfo processes the schema referenced by the provided URL and returns information to allow a user to create an App. - [Get organisations connected apps](https://docs.versori.com/legacy/api-reference/switchboard-api/connections/get-organisations-connected-apps.md): Retrieves a page of Apps which have connections for an organisation. - [Get organisations connections](https://docs.versori.com/legacy/api-reference/switchboard-api/connections/get-organisations-connections.md): Retrieves connections for an organisation, potentially filtering by appId. The response is structured as a page but currently the response returns all items. Consumers wishing to be backwards compatible should not assume this API will always return all items. - [Post organisations connections](https://docs.versori.com/legacy/api-reference/switchboard-api/connections/post-organisations-connections.md): Creates a connection between an organisation and an App. This is to be used by authentication methods which the user can explicitly configure, such as API Key and Basic Auth. For OAuth2/OIDC connections, users should call the InitialiseConnection endpoint instead. - [Put organisations connections](https://docs.versori.com/legacy/api-reference/switchboard-api/connections/put-organisations-connections.md): Updates an existing Connection by ID in the current organisation. - [Delete organisations connections](https://docs.versori.com/legacy/api-reference/switchboard-api/connections/delete-organisations-connections.md): Deletes a connection, and unpublishes all boards referencing it. - [Post organisations connection init](https://docs.versori.com/legacy/api-reference/switchboard-api/connections/post-organisations-connection-init.md): InitialiseConnection is used to initiate a connection of an App to a user's organisation. Different connections require different auth methods (or even no auth method at all), this endpoint returns the necessary configuration required to establish that connection. - [Get organisations credentials](https://docs.versori.com/legacy/api-reference/switchboard-api/credentials/get-organisations-credentials.md): Retrieves all Credentials owned by this organisation as a paginated response. - [Post organisations credentials](https://docs.versori.com/legacy/api-reference/switchboard-api/credentials/post-organisations-credentials.md): CreateCredential allows users to create new Credentials. Valid requests which return a credential marked as "invalid" is normal behaviour, but the credential won't be usable until it's updated to become valid. - [Put organisations credentials](https://docs.versori.com/legacy/api-reference/switchboard-api/credentials/put-organisations-credentials.md): Updates an existing Credential by ID in the current organisation. - [Delete organisations credentials](https://docs.versori.com/legacy/api-reference/switchboard-api/credentials/delete-organisations-credentials.md): Deletes an existing Credential by ID in the current organisation. - [Get organisations signed url](https://docs.versori.com/legacy/api-reference/switchboard-api/get-organisations-signed-url.md): Retrieve a signed URL for uploading assets - [Introduction](https://docs.versori.com/v2/introduction.md): Welcome to the Versori Platform documentation. - [Introduction](https://docs.versori.com/v2/embedded/introduction.md) - [Concepts](https://docs.versori.com/v2/embedded/concepts.md) - [Introduction](https://docs.versori.com/v2/embedded/sdk/introduction.md) - [Security](https://docs.versori.com/v2/embedded/security.md): How to authenticate with Versori APIs. - [Quick Start React](https://docs.versori.com/v2/embedded/sdk/quick-start.md): How to get an integration hub up and running in a React application in minutes. - [Getting Started](https://docs.versori.com/v2/embedded/sdk/embed-react/getting-started.md) - [Hooks](https://docs.versori.com/v2/embedded/sdk/embed-react/hooks.md) - [Components](https://docs.versori.com/v2/embedded/sdk/embed-react/components.md) - [Delete an Activation](https://docs.versori.com/v2/api-reference/activations/delete-an-activation.md): DeleteActivation deletes the Activation for the given activation ID. - [List Activations for User](https://docs.versori.com/v2/api-reference/activations/list-activations-for-user.md): ListUserActivations returns an array of all activations for a specific user in a given environment. - [List Activations](https://docs.versori.com/v2/api-reference/activations/list-activations.md): ListActivations returns a list of all the Activations for the given environment. - [Retrieve an Activation by ID](https://docs.versori.com/v2/api-reference/activations/retrieve-an-activation-by-id.md): GetActivation returns the Activation for the given activation ID. - [Set a dynamic variable by name](https://docs.versori.com/v2/api-reference/activations/set-a-dynamic-variable-by-name.md): Updates a single dynamic variable identified by name for the specified activation. This endpoint is designed to support the SDK's ability to update individual variables with a friendly, descriptive API for error handling. - [Set dynamic variables for an activation](https://docs.versori.com/v2/api-reference/activations/set-dynamic-variables-for-an-activation.md): Updates one or more dynamic variables for the specified activation. The request body will be validated against the variable schema. - [Set static variables for the static activation](https://docs.versori.com/v2/api-reference/activations/set-static-variables-for-the-static-activation.md): Updates one or more static variables for the static user's activation for this environment. The request body will be validated against the variable schema. - [Create a new connection.](https://docs.versori.com/v2/api-reference/connections/create-a-new-connection.md): CreateConnection creates a new connection for the given organisation. - [Get a Connection by ID](https://docs.versori.com/v2/api-reference/connections/get-a-connection-by-id.md): GetConnection returns the Connection for the given connection ID. - [Initialise OAuth 2.0 Connection](https://docs.versori.com/v2/api-reference/connections/initialise-oauth-20-connection.md): InitialiseOAuth2Connection returns a URL to redirect the user to an OAuth 2.0 Provider's Authorize endpoint. - [Link an existing connection to an environment](https://docs.versori.com/v2/api-reference/connections/link-an-existing-connection-to-an-environment.md): LinkConnectionToEnvironment links an existing connection to a specified environment. - [List Connections](https://docs.versori.com/v2/api-reference/connections/list-connections.md): ListConnections returns a list of Connections. - [List static connections for project environment](https://docs.versori.com/v2/api-reference/connections/list-static-connections-for-project-environment.md): Lists all static connections (connections without end users) for a given environment. - [Retrieve the connection for the activations.](https://docs.versori.com/v2/api-reference/connections/retrieve-the-connection-for-the-activations.md) - [Update a Connection by ID](https://docs.versori.com/v2/api-reference/connections/update-a-connection-by-id.md): UpdateConnection updates the Connection for the given connection ID. - [Create an End User](https://docs.versori.com/v2/api-reference/end_users/create-an-end-user.md): CreateEndUser creates a new End User for the given organisation. - [Delete an End User](https://docs.versori.com/v2/api-reference/end_users/delete-an-end-user.md): DeleteEndUser deletes the End User for the given user ID. - [List End Users](https://docs.versori.com/v2/api-reference/end_users/list-end-users.md): ListEndUsers returns a list of all the End Users for the given organisation. - [Retrieve an End User](https://docs.versori.com/v2/api-reference/end_users/retrieve-an-end-user.md): GetEndUser returns the End User for the given user ID. - [Activates a User on an Environment.](https://docs.versori.com/v2/api-reference/projects/activates-a-user-on-an-environment.md): ActivateUser activates a user on an environment. This will create a new activation record for the user on the environment. Connections must be made for all environment systems to be successfully activated. - [Create new project](https://docs.versori.com/v2/api-reference/projects/create-new-project.md): CreateProject creates a new project. - [Delete Project](https://docs.versori.com/v2/api-reference/projects/delete-project.md): DeleteProject delete the project. - [Deploy Project](https://docs.versori.com/v2/api-reference/projects/deploy-project.md): DeployProject deploys the project to the specified environment using the current files. It processes the files to deploy a new version of the project and updates the underlying connector to integrate the new API. - [Get Files](https://docs.versori.com/v2/api-reference/projects/get-files.md): GetFiles returns the current files for the project. Those may not be the files that the project is deployed with. - [Get Project Logs](https://docs.versori.com/v2/api-reference/projects/get-project-logs.md) - [Get Project](https://docs.versori.com/v2/api-reference/projects/get-project.md): GetProject returns the files and configuration for the specified project ID. If one does not exist then a 404 will be returned. - [Get Trace](https://docs.versori.com/v2/api-reference/projects/get-trace.md): GetTrace returns an individual trace with all the spans. - [List project traces](https://docs.versori.com/v2/api-reference/projects/list-project-traces.md): ListTraces returns a list of traces for the given organisation. - [List projects for organisation](https://docs.versori.com/v2/api-reference/projects/list-projects-for-organisation.md) - [Patch the schema for the project's dynamic variables](https://docs.versori.com/v2/api-reference/projects/patch-the-schema-for-the-projects-dynamic-variables.md): PatchProjectVariablesSchema patches the JSON schema for the project's dynamic variables. This allows you to add, remove or edit the schema for the project's dynamic variables. - [Set the schema for the project variables](https://docs.versori.com/v2/api-reference/projects/set-the-schema-for-the-project-variables.md): SetProjectVariablesSchema sets the JSON schema for the project's dynamic variables. Dynamic variables can then be set by end users on activation. This schema is used to validate the variables when they are set and defines the variables that can be set and used within the integration code. - [Suspend Project](https://docs.versori.com/v2/api-reference/projects/suspend-project.md): Suspend project will stop the project but not delete it. It can be deployed later again. - [Update Files](https://docs.versori.com/v2/api-reference/projects/update-files.md): UpdateFiles updates the files for the project. This will not deploy the project. - [Update Project](https://docs.versori.com/v2/api-reference/projects/update-project.md): UpdateProject updates the project record. This endpoint will not make changes to the file or the running deployment. - [Add a system to a project environment](https://docs.versori.com/v2/api-reference/systems/add-a-system-to-a-project-environment.md) - [Adds or updates an auth scheme for the system.](https://docs.versori.com/v2/api-reference/systems/adds-or-updates-an-auth-scheme-for-the-system.md): UpsertAuthSchemeConfig adds or updates an auth scheme for the system. If the auth scheme ID provided doesn't match any of the record, it will be created. If the auth scheme ID provided matches an existing record, it will be updated. The ID in the path needs to match the ID in the body. - [Create a new connection template](https://docs.versori.com/v2/api-reference/systems/create-a-new-connection-template.md) - [Create a new system.](https://docs.versori.com/v2/api-reference/systems/create-a-new-system.md) - [Deletes an auth scheme for the system.](https://docs.versori.com/v2/api-reference/systems/deletes-an-auth-scheme-for-the-system.md) - [List project environment connection templates](https://docs.versori.com/v2/api-reference/systems/list-project-environment-connection-templates.md) - [List the systems linked to the project environment](https://docs.versori.com/v2/api-reference/systems/list-the-systems-linked-to-the-project-environment.md) - [Lists the systems for the organisation.](https://docs.versori.com/v2/api-reference/systems/lists-the-systems-for-the-organisation.md) - [Remove a connection template](https://docs.versori.com/v2/api-reference/systems/remove-a-connection-template.md) - [Remove a system from a project environment](https://docs.versori.com/v2/api-reference/systems/remove-a-system-from-a-project-environment-1.md) - [Remove a system from a project environment](https://docs.versori.com/v2/api-reference/systems/remove-a-system-from-a-project-environment.md) - [Update system.](https://docs.versori.com/v2/api-reference/systems/update-system.md) ## OpenAPI Specs - [connect-api-v1](/openapi/connect-api-v1.yaml) - [embedded-api-v1](/openapi/embedded-api-v1.yaml) - [organisations-api-v1](/openapi/organisations-api-v1.yaml) - [platform-api](/openapi/platform-api.yaml) - [switchboard-api-v1alpha1](/openapi/switchboard-api-v1alpha1.yaml) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.