### Showpad Connection Parameters

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Outlines the connection parameters for the Showpad connector, which requires a subdomain for setup.

```APIDOC
## Showpad Connection Parameters

### Description
Outlines the connection parameters for the Showpad connector, which requires a subdomain for setup.

### Method
N/A (Configuration parameters)

### Endpoint
N/A

### Parameters
#### Input Parameters
- **subdomain** (string) - Required - Your Showpad subdomain (e.g., the `acme` part in `https://acme.showpad.biz`).

### Request Example
```json
{
    "provider": "showpad",
    "subdomain": "your_subdomain"
}
```

### Response
#### Success Response (N/A)
This is a configuration, not an API endpoint.

#### Response Example
N/A
```

--------------------------------

### Get Filtered Activity Audit Log (Shell)

Source: https://api-docs.workato.com/workato-api/resources/environment-management/get-api-activity-logs.mdx

Retrieves filtered activity audit logs from the Workato API. This example demonstrates using query parameters to exclude specific event types and paginate results starting after a given point. It requires an Authorization token.

```shell
curl -G https://www.workato.com/api/activity_logs \
     -H "Authorization: Bearer <token>" \
     -d exclude_event_types=string \
     -d "page[after]=0"
```

--------------------------------

### Showpad Connection Parameters

Source: https://api-docs.workato.com/workato-api/resources/connections/connections-parameters.mdx

Configuration parameters for connecting to Showpad.

```APIDOC
## Showpad Connection Parameters

### Description
Configuration parameters for establishing a connection to a Showpad account using OAuth.

### Method
Not Applicable (Configuration details)

### Endpoint
Not Applicable (Configuration details)

### Parameters
#### Input Parameters
- **subdomain** (string) - Required - Your Showpad subdomain (e.g., 'acme' for https://acme.showpad.biz).
```

--------------------------------

### Get Customers List using Curl

Source: https://api-docs.workato.com/oem-api/resources/manage-customers/get-managed-users.mdx

Fetches a list of all customers using the Workato API. This example demonstrates a basic GET request with an authorization token. It shows how to retrieve customer data, including task counts for billing periods.

```shell
curl https://www.workato.com/api/managed_users \
     -H "Authorization: Bearer <token>"
```

```shell
curl -G https://www.workato.com/api/managed_users \
     -H "Authorization: Bearer <token>" \
     -d page=0 \
     -d per_page=0
```

--------------------------------

### Workplace Bot Configuration

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Configuration parameters for setting up Workbot for Workplace.

```APIDOC
## Workplace Bot Configuration

### Description
This section details the connection parameters for configuring Workbot for Workplace.

### Method
N/A (Configuration Parameters)

### Endpoint
N/A

### Parameters
#### Input Parameters
- **custom_access_token** (string) - Optional - Custom Access Token

### Request Example
N/A (Configuration Parameters)

### Response
#### Success Response (200)
N/A (Configuration Parameters)

#### Response Example
N/A (Configuration Parameters)
```

--------------------------------

### GET /api/on_prem_groups/{id}

Source: https://api-docs.workato.com/workato-api/resources/on-prem/get-on-prem-groups-id.mdx

Retrieves the details of a specific On-prem group identified by its ID. This endpoint is useful for fetching configuration and status information for your on-premise setups.

```APIDOC
## GET /api/on_prem_groups/{id}

### Description
Retrieves the details of a specific On-prem group identified by its ID. This endpoint is useful for fetching configuration and status information for your on-premise setups.

### Method
GET

### Endpoint
/api/on_prem_groups/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the On-prem group.

### Request Example
```shell
curl https://www.workato.com/api/on_prem_groups/1 \
     -H "Authorization: Bearer <token>"
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the On-prem group.
- **name** (string) - The name of the On-prem group.
- **description** (string) - A description of the On-prem group.
- **created_at** (datetime) - The timestamp when the group was created.
- **updated_at** (datetime) - The timestamp when the group was last updated.

#### Response Example
```json
{
  "id": 1,
  "name": "Production Servers",
  "description": "Groups servers in the production environment.",
  "created_at": "2023-10-27T10:00:00Z",
  "updated_at": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Get Recipe Versions with Curl

Source: https://api-docs.workato.com/workato-api/resources/recipes/get-recipes-recipe-id-versions.mdx

Example of how to retrieve all versions of a Workato recipe using the curl command-line tool. Requires an authorization token. Optional parameters for pagination (page, per_page) can be included.

```shell
curl https://www.workato.com/api/recipes/1/versions \
     -H "Authorization: Bearer <token>"
```

```shell
curl -G https://www.workato.com/api/recipes/0/versions \
     -H "Authorization: Bearer <token>" \
     -d page=0 \
     -d per_page=0
```

--------------------------------

### OutSystems Connection Parameters

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Details for connecting to OutSystems, including required API key and environment URL.

```APIDOC
## OutSystems Connection Parameters

### Description
Configuration details for establishing a connection with the OutSystems platform.

### Method
N/A (Connection Configuration)

### Endpoint
N/A

### Parameters
#### Input Parameters
- **API_key** (string) - Required - API key generated from the OutSystems Workato Connector.
- **EnvironmentURL** (string) - Required - Your OutSystems environment URL (e.g., YOUR_PERSONAL.outsystemscloud.com).
```

--------------------------------

### Get Recipe Details (Shell)

Source: https://api-docs.workato.com/oem-api/resources/recipes/get-managed-users-managed-user-id-recipes-recipe-id.mdx

This example shows a basic curl command to retrieve details of a specific recipe. It requires the managed user ID and recipe ID. An authorization token is necessary to authenticate the request.

```shell
curl https://www.workato.com/api/v2/managed_users/1/recipes/1 \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### Quick Base Connection

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Configuration parameters for the Quick Base connector.

```APIDOC
## Quick Base Connection Parameters

### Description
This section details the connection parameters required to set up the Quick Base connector.

### Parameters
#### Input Parameters
- **subdomain** (string) - Required - Your Quick Base subdomain, often your company name.
- **user_token_auth** (boolean) - Required - Specifies if authentication is based on user tokens. Defaults to 'false'.
- **usertoken** (string) - Optional - User token for authentication if `user_token_auth` is true. Obtain from user profile settings.
- **username** (string) - Optional - Username for authentication if `user_token_auth` is false.
- **password** (string) - Optional - Password for authentication if `user_token_auth` is false.
```

--------------------------------

### Get Activity Audit Log (Shell)

Source: https://api-docs.workato.com/workato-api/resources/environment-management/get-api-activity-logs.mdx

Retrieves activity audit logs from the Workato API. This example shows a basic GET request. Authentication is handled via a Bearer token. No specific filters are applied in this basic retrieval.

```shell
curl https://www.workato.com/api/activity_logs \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### Apttus Connection Parameters

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Configuration details for connecting to Apttus.

```APIDOC
## Apttus Connection Parameters

### Description
Connection parameters for the Apttus connector.

### Method
N/A (Configuration)

### Endpoint
N/A (Configuration)

### Parameters
#### Input Parameters
- **sandbox** (boolean) - Optional - Is this connecting to a sandbox account?

### Request Example
```json
{
  "provider": "apttus",
  "sandbox": true
}
```

### Response
#### Success Response (200)
N/A (Configuration)

#### Response Example
N/A (Configuration)
```

--------------------------------

### Showpad Connection Parameters JSON

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Specifies the connection parameters for the Showpad connector. It utilizes OAuth and personalization, with the subdomain being the primary input required for establishing a connection.

```json
{
    "oauth": true,
    "personalization": true,
    "input":
    [
        {
            "name": "subdomain",
            "type": "string",
            "label": "Subdomain",
            "hint": "Your Showpad subdomain, usually a company name; for example, the <b>acme</b> part in https://acme.showpad.biz"
        }
    ]
}
```

--------------------------------

### Get Skill by ID using cURL

Source: https://api-docs.workato.com/workato-api/resources/agent-studio/get-skills-id.mdx

Demonstrates how to retrieve a skill's details using its ID with a cURL command. Requires an authorization token. The example shows a specific ID and a placeholder for a dynamic ID.

```shell
curl https://www.workato.com/api/agentic/skills/65039789 \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/agentic/skills/:id \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### Apttus Intelligent Cloud Connection Parameters

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Configuration details for connecting to Apttus Intelligent Cloud.

```APIDOC
## Apttus Intelligent Cloud Connection Parameters

### Description
Connection parameters for the Apttus Intelligent Cloud connector.

### Method
N/A (Configuration)

### Endpoint
N/A (Configuration)

### Parameters
#### Input Parameters
- **subdomain** (string) - Required - Your AIC cloud name as found in your apttus AIC URL
- **client_id** (string) - Required - Client ID
- **client_secret** (string) - Required - Client secret
- **directory_id** (string) - Required - Your directory ID can be found <a target="_blank" href="https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/Properties">here</a>.

### Request Example
```json
{
  "provider": "apttus_intelligent_cloud",
  "subdomain": "your_subdomain",
  "client_id": "your_client_id",
  "client_secret": "your_client_secret",
  "directory_id": "your_directory_id"
}
```

### Response
#### Success Response (200)
N/A (Configuration)

#### Response Example
N/A (Configuration)
```

--------------------------------

### Get Recipe Details with Parameters (Shell)

Source: https://api-docs.workato.com/oem-api/resources/recipes/get-managed-users-managed-user-id-recipes-recipe-id.mdx

This example demonstrates how to retrieve recipe details with additional query parameters such as version number and cloned recipe ID. This allows for more specific data retrieval. An authorization token is required.

```shell
curl -G https://www.workato.com/api/v2/managed_users/0/recipes/0 \
     -H "Authorization: Bearer <token>" \
     -d version_no=0 \
     -d cloned_recipe_id=true
```

--------------------------------

### Slack Bot Configuration

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Configuration parameters for setting up Workbot for Slack.

```APIDOC
## Slack Bot Configuration

### Description
This section outlines the connection parameters required to configure Workbot for Slack, enabling conversational interface capabilities.

### Method
N/A (Configuration Parameters)

### Endpoint
N/A

### Parameters
#### Input Parameters
- **nlu_provider_shared_account_id** (string) - Optional - Choose a connection for your conversational interface. Supports Google's DialogFlow and Amazon Lex.
- **advanced** (object) - Optional - Additional fields that are not needed for most users
  #### Advanced Properties
  - **extra_tokens** (string) - Optional - Used for invoking Custom Integration slash commands. Each slash command has a token. Separate tokens with commas to support multiple slash commands. <a href='https://docs.workato.com/en/workbot/legacy-slash-commands.html#configuring-the-workbot-connection' target='_blank'>Learn more.</a>
  - **custom_help** (string) - Optional - Provide simple text help OR rich help using a JSON document corresponding to Slack message.You can build a rich help message using the <a href='https://api.slack.com/docs/messages/builder' target='_blank'>Slack message builder.</a>

### Request Example
N/A (Configuration Parameters)

### Response
#### Success Response (200)
N/A (Configuration Parameters)

#### Response Example
N/A (Configuration Parameters)
```

--------------------------------

### Get Export Status using cURL

Source: https://api-docs.workato.com/oem-api/resources/recipe-lifecycle-management/get-managed-users-managed-user-id-exports-package-id.mdx

This example demonstrates how to retrieve the status of an exported package using the cURL command-line tool. It requires a valid API token for authentication and specifies the managed user and package IDs in the URL.

```shell
curl https://www.workato.com/api/managed_users/managed_user_id/exports/package_id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id/exports/:package_id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id/exports/:package_id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id/exports/:package_id \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### Bitbucket Connection Parameters

Source: https://api-docs.workato.com/workato-api/resources/connections/connections-parameters.mdx

Details for connecting to Bitbucket, with an optional hostname parameter for self-hosted instances.

```APIDOC
## Bitbucket Connector

### Description
Configuration for connecting to Bitbucket using OAuth.

### Provider Value
```json
"provider": "bitbucket"
```

### Connection Parameters

#### Input Parameters
- **hostname** (string) - Optional - Bitbucket hostname. Host (and optional port) of your server. Eg. http://localhost:7990/rest/api
```

--------------------------------

### Get Usage Metrics with Workspace IDs (Shell)

Source: https://api-docs.workato.com/oem-api/resources/manage-customers/post-usage-v-2.mdx

Retrieves usage metrics for specified customer workspaces within a defined time frame using curl. This example shows how to specify workspace IDs and set the interval to 'none'.

```shell
curl -X POST "https://www.workato.com/api/v2/managed_users/statistics/usage?from=string&to=string&interval=none&workspace_ids=string"     -H "Authorization: Bearer <token>"
```

--------------------------------

### On-prem command-line scripts Provider Configuration

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Configuration details for the 'onprem_command_line_scripts' provider, used for executing command-line scripts on-premise.

```APIDOC
## On-prem command-line scripts Provider Configuration

### Description
Configuration for the `onprem_command_line_scripts` provider, which allows execution of command-line scripts locally.

### Provider Value
```json
"provider": "onprem_command_line_scripts"
```

### Connection Parameters

#### Input Parameters

- **profile** (string) - Required - Profile name given in the `config.yml` file.
```

--------------------------------

### Get Custom Connector by ID using cURL

Source: https://api-docs.workato.com/oem-api/resources/custom-connectors/get-custom-connector-by-id.mdx

This snippet demonstrates how to retrieve a specific custom connector by its ID using a cURL command. It requires an authorization token for authentication. The examples show requests for different connector IDs.

```shell
curl https://www.workato.com/api/custom_connectors/1 \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/custom_connectors/0 \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### Get Usage Metrics with Timeframe and Filters (Shell)

Source: https://api-docs.workato.com/oem-api/resources/manage-customers/post-usage-v-2.mdx

Retrieves usage metrics for specified customer workspaces within a defined time frame using curl. This example demonstrates filtering by recipe name pattern and folder name pattern.

```shell
curl -X POST "https://www.workato.com/api/v2/managed_users/statistics/usage?from=2025-01-01T00%3A00%3A00.000Z&to=2025-01-31T23%3A59%3A59.999Z&recipe_name_pattern=TEAM%20recipe&folder_name_pattern=TEAM%20folder"     -H "Authorization: Bearer <token>"
```

--------------------------------

### Quick Base Connection Parameters

Source: https://api-docs.workato.com/workato-api/resources/connections/connections-parameters.mdx

Configuration details for the Quick Base connector, including authentication methods and required parameters.

```APIDOC
## Quick Base Connection Configuration

### Description
This section details the connection parameters for the Quick Base connector, supporting both user token and username/password authentication.

### Method
N/A (Configuration Schema)

### Endpoint
N/A (Configuration Schema)

### Parameters
#### Input Parameters
- **subdomain** (string) - Required - Your Quick Base subdomain.
- **user_token_auth** (boolean) - Required - Set to true for user token authentication, false for username/password.
- **usertoken** (string) - Optional - User token for authentication. Required if `user_token_auth` is true.
- **username** (string) - Optional - Username for authentication. Required if `user_token_auth` is false.
- **password** (string) - Optional - Password for authentication. Required if `user_token_auth` is false.

### Request Example
```json
{
    "provider": "quickbase",
    "input": {
        "subdomain": "yourcompany",
        "user_token_auth": true,
        "usertoken": "your_user_token"
    }
}
```

### Response
#### Success Response (200)
N/A (Configuration Schema)

#### Response Example
N/A (Configuration Schema)
```

--------------------------------

### OAuth Authentication and Shell Connections

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Details on how to create OAuth 2.0 connections, including the structure of `oauth_token_pair` and how to create shell connections for initial setup.

```APIDOC
## OAuth Authentication

The Workato API supports OAuth 2.0 connections. For authorization code grant connections, an `oauth_token_pair` object is required, containing both access and refresh tokens.

### `oauth_token_pair` Object Structure

- **access_token** (string) - Required - The access token for OAuth authentication.
- **refresh_token** (string) - Required - The refresh token for OAuth authentication.

### Creating Shell Connections

A shell connection can be created without immediate access and refresh tokens. This is useful for initializing a connection in a `Disconnected` state, with authentication completed later in the Workato UI. To create a shell connection, include `"shell_connection": true` in the request body or omit authorization fields.

#### Example: Create a Shell Connection (POST /managed_users/{managed_user_id}/connections)

```shell
curl  -X POST https://www.workato.com/api/managed_users/98178/connections \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d  '{
            "name": "Snowflake shell",
            "provider": "snowflake",
            "folder_id": 1234567,
            "shell_connection": true,
            "input": {
                "authentication_type": ["OAuth 2.0", "oauth"],
                "warehouse": "Example warehouse",
                "host": "Example host",
                "database": "Example database",
                "role": "Example role",
                "user": "Example user",
                "schema_name": "Example schema",
                "db_timezone": ["American Samoa", "American Samoa"]
                }
            }'
```

**Note:** After creating a shell connection, sign in to Workato, open the project, select the shell connection, and complete the remaining fields as per connector-specific documentation.
```

--------------------------------

### Get Customer Workspace Collaborator Details using Curl

Source: https://api-docs.workato.com/oem-api/resources/customer-workspace-collaborators/get-managed-users-managed-user-id-members-member-id.mdx

This example demonstrates how to fetch details for a specific member within a customer workspace using a curl command. It requires the base URL, member IDs, and an authorization token.

```shell
curl https://www.workato.com/api/managed_users/managed_user_id/members/member_id \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### Get On-prem Group Status using cURL

Source: https://api-docs.workato.com/oem-api/resources/on-prem/get-on-prem-group-status-managed-user-id-group-id.mdx

This example demonstrates how to retrieve the status of an On-prem group for a managed user using a cURL command. It requires an authorization token for authentication. The endpoint supports retrieving status for specific group IDs.

```shell
curl https://www.workato.com/api/v2/managed_users/id/on_prem_groups/1/status \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/v2/managed_users/:id/on_prem_groups/0/status \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/v2/managed_users/:id/on_prem_groups/0/status \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/v2/managed_users/:id/on_prem_groups/0/status \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/v2/managed_users/:id/on_prem_groups/0/status \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/v2/managed_users/:id/on_prem_groups/0/status \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### Quick Base (Secondary) Connection

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Configuration parameters for the Quick Base (Secondary) connector.

```APIDOC
## Quick Base (Secondary) Connection Parameters

### Description
This section details the connection parameters required to set up the Quick Base (Secondary) connector.

### Parameters
#### Input Parameters
- **subdomain** (string) - Required - Your Quick Base subdomain, often your company name.
- **user_token_auth** (boolean) - Required - Specifies if authentication is based on user tokens. Defaults to 'false'.
- **usertoken** (string) - Optional - User token for authentication if `user_token_auth` is true. Obtain from user profile settings.
- **username** (string) - Optional - Username for authentication if `user_token_auth` is false.
- **password** (string) - Optional - Password for authentication if `user_token_auth` is false.
```

--------------------------------

### Get Job Line Details (Shell)

Source: https://api-docs.workato.com/workato-api/resources/jobs/get-recipes-recipe-id-jobs-handle-line-details.mdx

This example demonstrates how to retrieve a single job's metadata using its job handle via the Workato API. It requires the recipe ID and job handle, and an authorization token. The `id` parameter is used to specify the data to retrieve.

```shell
curl -G https://www.workato.com/api/recipes/recipe_id/jobs/1/line_details \
     -H "Authorization: Bearer <token>" \
     -d id=id
```

```shell
curl -G https://www.workato.com/api/recipes/:recipe_id/jobs/0/line_details \
     -H "Authorization: Bearer <token>" \
     -d id=string
```

```shell
curl -G https://www.workato.com/api/recipes/:recipe_id/jobs/0/line_details \
     -H "Authorization: Bearer <token>" \
     -d id=string
```

```shell
curl -G https://www.workato.com/api/recipes/:recipe_id/jobs/0/line_details \
     -H "Authorization: Bearer <token>" \
     -d id=string
```

```shell
curl -G https://www.workato.com/api/recipes/:recipe_id/jobs/0/line_details \
     -H "Authorization: Bearer <token>" \
     -d id=string
```

--------------------------------

### Bitbucket Connection Parameters

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Configuration for connecting to Bitbucket, utilizing OAuth and optionally requiring a hostname.

```APIDOC
## Bitbucket Connection Parameters

### Description
Configuration for connecting to Bitbucket. This connector uses OAuth authentication.

### Method
N/A (Configuration)

### Endpoint
N/A

### Parameters
#### Input Parameters
- **hostname** (string) - Optional - Bitbucket hostname, including port if necessary (e.g., http://localhost:7990/rest/api).
```

--------------------------------

### Connector Configuration Parameters

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Lists configuration parameters and provider values for various Workato connectors that require connection setup.

```APIDOC
## Connector Configuration Parameters

This section details the configuration parameters and provider values for Workato connectors that require connections.

### 2Checkout

**Provider Value:**
```json
"provider": "two_checkout"
```

### Active Directory

**Provider Value:**
```json
"provider": "active_directory"
```

**Connection Parameters:**
```json
{
   "oauth":false,
   "personalization":false,
   "input":[
      {
         "name":"company_identifier",
         "type":"string",
         "label":"Company identifier"
      },
      {
         "name":"ftp_host",
         "type":"string",
         "label":"FTP host"
      },
      {
         "name":"ftp_user",
         "type":"string",
         "label":"FTP user"
      },
      {
         "name":"ftp_password",
         "type":"string",
         "label":"FTP password"
      },
      {
         "name":"pgp_key",
         "type":"string",
         "label":"PGP public key"
      }
   ]
}
```

### Adobe Experience Manager

**Provider Value:**
```json
"provider": "adobe_experience_manager"
```
```

--------------------------------

### List All Workato Connections (Shell)

Source: https://api-docs.workato.com/workato-api/resources/connections/get-connections.mdx

This example demonstrates how to retrieve all connections for the authenticated Workato user using a simple GET request with curl. It requires an authorization token.

```shell
curl https://www.workato.com/api/connections \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### OutSystems Connection Parameters

Source: https://api-docs.workato.com/workato-api/resources/connections/connections-parameters.mdx

Details the connection parameters for the OutSystems connector, including API key and Environment URL.

```APIDOC
## OutSystems Connector Connection Parameters

### Description
This section details the connection parameters required to set up the OutSystems connector.

### Parameters
#### Request Body
- **API_key** (string) - Required - API key generated using the security configuration page on the OutSystems Workato Connector.
- **EnvironmentURL** (string) - Required - Your OutSystems environment URL (e.g., YOUR_PERSONAL.outsystemscloud.com).
```

--------------------------------

### List Custom Connectors with Curl

Source: https://api-docs.workato.com/oem-api/resources/custom-connectors/get-search-custom-connectors.mdx

This example demonstrates how to list all custom adapters in your Workato workspace using a GET request with curl. It requires an authorization token.

```shell
curl https://www.workato.com/api/custom_connectors \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### Quick Base (Secondary) Connection Parameters

Source: https://api-docs.workato.com/workato-api/resources/connections/connections-parameters.mdx

Configuration details for the secondary Quick Base connector, similar to the primary but for distinct instances.

```APIDOC
## Quick Base (Secondary) Connection Configuration

### Description
This section details the connection parameters for the secondary Quick Base connector. It supports the same authentication methods as the primary Quick Base connector.

### Method
N/A (Configuration Schema)

### Endpoint
N/A (Configuration Schema)

### Parameters
#### Input Parameters
- **subdomain** (string) - Required - Your Quick Base subdomain.
- **user_token_auth** (boolean) - Required - Set to true for user token authentication, false for username/password.
- **usertoken** (string) - Optional - User token for authentication. Required if `user_token_auth` is true.
- **username** (string) - Optional - Username for authentication. Required if `user_token_auth` is false.
- **password** (string) - Optional - Password for authentication. Required if `user_token_auth` is false.

### Request Example
```json
{
    "provider": "quickbase_secondary",
    "input": {
        "subdomain": "yourcompany",
        "user_token_auth": false,
        "username": "your_username",
        "password": "your_password"
    }
}
```

### Response
#### Success Response (200)
N/A (Configuration Schema)

#### Response Example
N/A (Configuration Schema)
```

--------------------------------

### Get Customer Workspace Collaborators using cURL

Source: https://api-docs.workato.com/oem-api/resources/customer-workspace-collaborators/get-managed-users-managed-user-id-members.mdx

This example demonstrates how to retrieve a list of customer workspace collaborators using the cURL command-line tool. It requires the `managed_user_id` and an `Authorization` header with a bearer token. The response includes member details like ID, grant type, name, email, role, and time zone.

```shell
curl https://www.workato.com/api/managed_users/managed_user_id/members \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id/members \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id/members \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id/members \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### SFTP Connection Configuration

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

This section details the parameters required to establish an SFTP connection, including authentication, server details, and transfer configurations.

```APIDOC
## SFTP Connection Parameters

### Description
Configuration details for establishing an SFTP connection.

### Method
N/A (Configuration parameters)

### Endpoint
N/A

### Parameters
#### Input Parameters
- **auth_type** (string) - Required - Authentication type to use for the SFTP connection. Options: 'Username/password' or 'Public/private key pair'. Defaults to 'username_password'.
- **username** (string) - Required - The username for SFTP authentication.
- **password** (string) - Required - The password for SFTP authentication (used with 'username_password' auth_type).
- **private_key** (string) - Required - The private key for SFTP authentication (used with 'pubkey' auth_type). Should be an OpenSSH private key without password protection.
- **hostname** (string) - Required - The hostname or IP address of the SFTP server.
- **port** (integer) - Required - The port number for the SFTP connection. Defaults to 22.
- **host_key_fingerprint** (string) - Optional - The fingerprint of the SFTP server's host key. Helps prevent Man-in-the-Middle attacks.
- **transfer_buffer_size** (integer) - Optional - The size of the buffer used for file transfers. Minimum is 32768, maximum is 327680. Larger sizes can speed up transfers.
- **force_close** (boolean) - Optional - If set to true, forces the underlying SSH connection to close at the end of the transaction. Use only if connection hangs.

### Request Example
```json
{
  "provider": "sftp",
  "auth_type": "username_password",
  "username": "your_username",
  "password": "your_password",
  "hostname": "sftp.example.com",
  "port": 22,
  "transfer_buffer_size": 65536
}
```

### Response
#### Success Response (200)
N/A (Configuration details, not an API endpoint)

#### Response Example
N/A
```

--------------------------------

### Retrieve Customer Details with cURL

Source: https://api-docs.workato.com/oem-api/resources/manage-customers/get-managed-users-managed-user-id.mdx

This example demonstrates how to retrieve details for an embedded customer's account using a cURL command. It requires the managed user ID and an authorization token.

```shell
curl https://www.workato.com/api/managed_users/managed_user_id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### On-prem files (Secondary) Provider Configuration

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Configuration details for the 'onprem_files_secondary' provider, an alternative for accessing files on-premise.

```APIDOC
## On-prem files (Secondary) Provider Configuration

### Description
Configuration for the `onprem_files_secondary` provider, offering an alternative method for accessing local files.

### Provider Value
```json
"provider": "onprem_files_secondary"
```

### Connection Parameters

#### Input Parameters

- **profile** (string) - Required - Profile name given in the `config.yml` file.
```

--------------------------------

### Retrieve Collaborator Privileges via API (Shell)

Source: https://api-docs.workato.com/oem-api/resources/customer-workspace-collaborators/get-managed-users-managed-user-id-members-id-privileges.mdx

This example demonstrates how to retrieve the privileges and roles of a collaborator in an Embedded customer workspace using a curl command. It requires an API token for authentication.

```shell
curl https://www.workato.com/api/managed_users/managed_user_id/members/id/privileges \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### Clearbit Connection Parameters

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Configuration details for the Clearbit connector, including the API key.

```APIDOC
## Clearbit Connection Parameters

### Description
This section details the connection parameters required for the Clearbit connector.

### Provider Value
```json
"provider": "clearbit"
```

### Connection Parameters

#### Input Parameters
- **api_key** (string) - Optional - Api key. Can be found here: https://dashboard.clearbit.com/keys
```

--------------------------------

### Get Knowledge Base Recipes with cURL

Source: https://api-docs.workato.com/workato-api/resources/agent-studio/get-knowledge-bases-id-recipes.mdx

This snippet demonstrates how to retrieve recipes associated with a knowledge base using `curl`. It includes examples of specifying the knowledge base ID, authentication token, and optional query and pagination parameters. The `query` parameter filters recipes by name or content, and `sort_term` can be used to order the results, while `page` controls pagination.

```shell
curl -G https://www.workato.com/api/agentic/knowledge_bases/kb-WSm8kore-blMxr/recipes \
     -H "Authorization: Bearer <token>" \
     -d query=support \
     -d sort_term=name
```

```shell
curl -G https://www.workato.com/api/agentic/knowledge_bases/:id/recipes \
     -H "Authorization: Bearer <token>" \
     -d query=string \
     -d page=0
```

--------------------------------

### View Folder Assets with Curl

Source: https://api-docs.workato.com/oem-api/resources/recipe-lifecycle-management/get-managed-users-managed-user-id-export-manifests-folder-assets.mdx

Demonstrates how to retrieve export manifests for assets in a folder using curl. This example shows a basic GET request and a more advanced request with query parameters for filtering.

```shell
curl https://www.workato.com/api/managed_users/managed_user_id/export_manifests/folder_assets \
     -H "Authorization: Bearer <token>"
```

```shell
curl -G https://www.workato.com/api/managed_users/:managed_user_id/export_manifests/folder_assets \
     -H "Authorization: Bearer <token>" \
     -d folder_id=0 \
     -d include_test_cases=true
```

--------------------------------

### Shopify Connection Parameters

Source: https://api-docs.workato.com/workato-api/resources/connections/connections-parameters.mdx

Configuration parameters for connecting to Shopify.

```APIDOC
## Shopify Connection Parameters

### Description
Configuration parameters for establishing a connection to a Shopify store using OAuth.

### Method
Not Applicable (Configuration details)

### Endpoint
Not Applicable (Configuration details)

### Parameters
#### Input Parameters
- **shop_name** (string) - Required - The name of your Shopify shop, used to construct the admin URL (e.g., 'shopname' for shopname.myshopify.com/admin).
```

--------------------------------

### Quick Base Connection Parameters JSON

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Defines the connection parameters for the Quick Base API connector. It specifies authentication methods (user token or username/password) and required fields like subdomain. OAuth and personalization are set to false.

```json
{
    "provider": "quickbase"
}
```

```json
{
    "oauth": false,
    "personalization": false,
    "input":
    [
        {
            "name": "subdomain",
            "type": "string",
            "label": "Sub-domain",
            "hint": "Your Quick Base subdomain is most often your company name"
        },
        {
            "name": "user_token_auth",
            "type": "boolean",
            "label": "User-token authentication?",
            "hint": "Is authentication based on user tokens? If yes, provide <b>User token</b>. If no, provide <b>Username</b> & <b>Password</b>.",
            "default": "false"
        },
        {
            "name": "usertoken",
            "type": "string",
            "optional": true,
            "label": "User token",
            "hint": "Get/create user token by clicking on <b>Your profile > My preferences > Manage User Tokens</b>. <a href='https://help.quickbase.com/api-guide/manage_user_tokens.html' target='_blank' >Learn more</a>"
        },
        {
            "name": "username",
            "type": "string",
            "optional": true,
            "label": "Username"
        },
        {
            "name": "password",
            "type": "string",
            "optional": true,
            "label": "Password"
        }
    ]
}
```

--------------------------------

### Retrieve Downloaded Package (Shell)

Source: https://api-docs.workato.com/oem-api/resources/projects/get-managed-users-managed-user-id-project-builds-id.mdx

This example demonstrates how to retrieve a downloaded package using `curl` in a shell environment. It requires the `managed_user_id` and `id` of the project build, along with an Authorization Bearer token.

```shell
curl https://www.workato.com/api/managed_users/managed_user_id/project_builds/id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id/project_builds/:id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id/project_builds/:id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id/project_builds/:id \
     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/managed_users/:managed_user_id/project_builds/:id \
     -H "Authorization: Bearer <token>"
```

--------------------------------

### List Managed User Tags via cURL

Source: https://api-docs.workato.com/oem-api/resources/environment-management/get-managed-users-id-tags.mdx

This snippet shows how to list tags for a managed user using a GET request with cURL. It requires an authorization token. The basic example fetches all tags.

```shell
curl https://www.workato.com/api/v2/managed_users/id/tags \
     -H "Authorization: Bearer <token>"
```

```shell
curl -G https://www.workato.com/api/v2/managed_users/:id/tags \
     -H "Authorization: Bearer <token>" \
     -d page=0 \
     -d per_page=0
```

--------------------------------

### Force.com Connection

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Parameters for connecting to the Force.com API.

```APIDOC
## Force.com Connection

### Description
Parameters for connecting to the Force.com API.

### Provider Value
```json
"provider": "forcecom"
```

### Connection Parameters

#### Input Parameters
- **sandbox** (boolean) - Optional - Is this connecting to a sandbox account? (default: false)

### Authentication
- OAuth: true
- Personalization: true
```

--------------------------------

### List Properties by Prefix (Shell)

Source: https://api-docs.workato.com/oem-api/resources/environment-properties/get-managed-users-managed-user-id-properties.mdx

Demonstrates how to list properties using a prefix. This example uses cURL to make a GET request to the Workato API, specifying the managed user ID and the desired prefix. An authorization token is required.

```shell
curl -G https://www.workato.com/api/managed_users/managed_user_id/properties \
     -H "Authorization: Bearer <token>" \
     -d prefix=prefix
```

```shell
curl -G https://www.workato.com/api/managed_users/:managed_user_id/properties \
     -H "Authorization: Bearer <token>" \
     -d prefix=string \
     -d project_id=string
```

```shell
curl -G https://www.workato.com/api/managed_users/:managed_user_id/properties \
     -H "Authorization: Bearer <token>" \
     -d prefix=string \
     -d project_id=string
```

--------------------------------

### OutSystems Connection Parameters JSON

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Defines the connection parameters for the OutSystems connector. It requires an API key and the Environment URL. The API key is generated via the OutSystems Workato Connector, which can be obtained from the OutSystems Forge.

```json
{
    "oauth": false,
    "personalization": false,
    "input":
    [
        {
            "name": "API_key",
            "type": "string",
            "optional": false,
            "label": "API key",
            "hint": "Type in an API key generated using the security configuration page, on the <b>OutSystems Workato Connector</b>. If you don't have the <b>OutSystems Workato Connector</b> installed on your server, please get it from the <a href='https://www.outsystems.com/forge/' target='_blank'>OutSystems Forge</a>."
        },
        {
            "name": "EnvironmentURL",
            "type": "string",
            "optional": false,
            "label": "Environment URL",
            "hint": "Your OutSystems environment URL (eg: YOUR_PERSONAL.outsystemscloud.com)."
        }
    ]
}
```

--------------------------------

### Retrieve Project Build by ID (Shell)

Source: https://api-docs.workato.com/workato-api/resources/projects/get-project-builds-id.mdx

This example demonstrates how to retrieve a project build using its unique identifier via a curl command. It requires an authorization token for authentication. The input is the project build ID, and the output is the project build data.

```shell
curl https://www.workato.com/api/project_builds/1 \n     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/project_builds/0 \n     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/project_builds/0 \n     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/project_builds/0 \n     -H "Authorization: Bearer <token>"
```

```shell
curl https://www.workato.com/api/project_builds/0 \n     -H "Authorization: Bearer <token>"
```

--------------------------------

### Salesforce Marketing Cloud Connection Parameters

Source: https://api-docs.workato.com/oem-api/resources/connections/connections-parameters.mdx

Details on how to connect to Salesforce Marketing Cloud, including required parameters and their types.

```APIDOC
## Salesforce Marketing Cloud Connection Parameters

### Description
This section details the connection parameters required to authenticate and interact with the Salesforce Marketing Cloud API.

### Method
N/A (Connection Parameters)

### Endpoint
N/A (Connection Parameters)

### Parameters
#### Input Parameters
- **flag** (boolean) - Optional - Are you using a new installed package? Legacy packages (created before 1st August 2019) uses a different set of fields to connect. Default: `false`
- **instance** (string) - Required - Select the instance of your account. Eg. Select `s7`, if the instance URL is `https://mc.s7.exacttarget.com`.
  - Pick List: `s1`, `s4`, `s6`, `s7`, `s10`, `test`
- **instance_name** (string) - Required - Enter the instance of your account. Eg. Enter `s7`, if the instance URL is `https://mc.s7.exacttarget.com`.
- **subdomain** (string) - Required - Enter the sub-domain of your account.
- **client_id** (string) - Required - Create client credentials with read and write access for channels, assets, contacts, data. To access shared content, use credentials of business unit where content belongs. Refer <a href="https://developer.salesforce.com/docs/atlas.en-us.mc-getting-started.meta/mc-getting-started/app-center-types.htm" target="_blank">here</a> for more details.
- **client_secret** (string) - Required - Your Salesforce Marketing Cloud client secret.

### Request Example
```json
{
  "provider": "salesforce_marketing_cloud",
  "flag": false,
  "instance": "s7",
  "instance_name": "s7",
  "subdomain": "your_subdomain",
  "client_id": "your_client_id",
  "client_secret": "your_client_secret"
}
```

### Response
#### Success Response (200)
N/A (Connection Parameters)

#### Response Example
N/A (Connection Parameters)
```