---
title: "GET /api/v1/provider-types"
method: GET
path: "/api/v1/provider-types"
tags: ["ProviderTypes"]
---

# GET /api/v1/provider-types

`GET /api/v1/provider-types`

## Request

- Base URL: `https://api.immy.bot` (the document declares no server; this is the origin it was published from)
- URL: `https://api.immy.bot/api/v1/provider-types`
- Auth: none declared

## Query parameters

- `includeLinkFormSchemas` boolean

## Response `200`

OK

- ProviderTypeDto[]
  - `providerTypeId` string, uuid
  - `source` 'BuiltIn' | 'Local' | 'Global': The string or integer value may be used. BuiltIn = 1, Local = 2, Global = 3
  - `isDynamic` boolean
  - `tag` string, nullable
  - `displayName` string, nullable
  - `configurationForm` DynamicFormBindResultWithConvertedParameters
    - `bindErrors` object, nullable
    - `showCommandInfo` ShowCommandInfo
      - `definition` string, nullable
      - `parameterSets` ParameterSet[], nullable
        - `name` string, nullable, required
        - `isDefault` boolean
        - `parameters` Parameter[], nullable
          - `name` string, nullable, required
          - `displayName` string, nullable
          - `helpText` string, nullable
          - `showRawHelpText` boolean
          - `onlyForHelpText` boolean
          - `defaultValue` unknown
          - `defaultValueText` string, nullable
          - `hidden` boolean
          - `isMandatory` boolean
          - `valueFromPipeline` boolean
          - `isValueStripped` boolean
          - `position` integer
          - `allowNull` boolean
          - `parameterType` ParameterType, required
            - `fullName` string, nullable
            - `name` string, nullable
            - `isEnum` boolean
            - `isArray` boolean
            - `enumValues` unknown
            - `hasFlagAttribute` boolean
            - `elementType` unknown
            - `implementsDictionary` boolean
          - `hasParameterSet` boolean
          - `validParamSetValues` string[], nullable
          - `hasDropdownParameterSet` boolean
          - `dateOnly` boolean
          - `useUtc` boolean
          - `validDropdownValues` ParameterDropdownTextValue[], nullable
            - `text` string, nullable
            - `value` string, nullable
          - `showDropdownAsRadioButtons` boolean
          - `oauthConsentParameterData` OauthConsentData
            - `authorizationEndpoint` string, uri, nullable
            - `tokenEndpoint` string, uri, nullable
            - `resource` string, nullable
            - `scopes` string, nullable
            - `clientId` string, nullable
            - `extraQueryParameters` object, nullable
            - `usePkce` boolean
    - `parameterSetName` string, nullable
    - `hasErrors` boolean
    - `convertedParameters` object, nullable
  - `logoSrc` string, nullable
  - `docsUrl` string, nullable
  - `screenShareLogoSrc` string, nullable
  - `canManage` boolean
  - `deviceGroupTypes` DeviceGroupTypeDto[], nullable
    - `deviceGroupTypeId` string, uuid
    - `providerTypeId` string, uuid
    - `displayName` string, nullable
    - `description` string, nullable
    - `targetScope` 'CrossTenant' | 'SingleTenant' | 'Individual': The string or integer value may be used. CrossTenant = 0, SingleTenant = 1, Individual = 2
  - `clientGroupTypes` ClientGroupTypeDto[], nullable
    - `clientGroupTypeId` string, uuid
    - `providerTypeId` string, uuid
    - `displayName` string, nullable
    - `description` string, nullable
  - `supportsDeviceUpdating` boolean
  - `providerCapabilities` string[], nullable
  - `agentUpdateFormSchema` AgentUpdateFormSchema
    - `inputs` AgentUpdateFormSchemaInput[], nullable
      - `name` string, nullable, required
      - `type` string, nullable, required
      - `required` boolean, required
      - `label` string, nullable, required
      - `description` string, nullable, required
      - `default` unknown, required
      - `deviceGroupTypeId` string, uuid, nullable, required
  - `supportedCrossProviderClientLinkages` SupportedCrossProviderLinkage[], nullable
    - `providerTypeId` string, uuid
    - `description` string, nullable
  - `supportedCrossProviderInitializationLinkages` SupportedCrossProviderLinkage[], nullable
    - `providerTypeId` string, uuid
    - `description` string, nullable

---

[API](https://skmtc.dev/immy/apis/immy-bot-api-2.md) · [All operations](https://skmtc.dev/immy/apis/immy-bot-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/immy/apis/immy-bot-api-2/revisions/75b50268fa51?raw)