---
updatedAt: 2026-09-22T18:45:18.000Z
---

# (Beta) Get a Micro-Integration type

Get the details of a specific Micro-Integration type using its unique identifier.<br><br><a href="https://api.solace.dev/cloud/reference/authentication">Token Permissions</a>: [ <code>micro_integrations:get:*</code> <b>or</b> <code>micro_integration_types:get:*</code> ]

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Micro-Integrations",
    "description": "REST API Concepts\nMicro-Integrations provide REST APIs to manage your data and services.\nThe REST APIs allow you to use cloud-managed Micro-Integrations that can connect your external systems (applications, databases, and event brokers) to event broker services.",
    "version": "2.1.0"
  },
  "servers": [
    {
      "url": "https://api.solace.cloud",
      "description": "Solace Cloud US EAST Region"
    },
    {
      "url": "https://api.solacecloud.com.au",
      "description": "Solace Cloud AU Region"
    },
    {
      "url": "https://api.solacecloud.eu",
      "description": "Solace Cloud EU Region"
    },
    {
      "url": "https://api.solacecloud.sg",
      "description": "Solace Cloud SG Region"
    }
  ],
  "security": [
    {
      "APIToken": []
    }
  ],
  "tags": [
    {
      "name": "Micro-Integration Types"
    }
  ],
  "paths": {
    "/api/v2/integration/microIntegrationTypes/{id}": {
      "get": {
        "tags": [
          "Micro-Integration Types"
        ],
        "summary": "(Beta) Get a Micro-Integration type",
        "description": "Get the details of a specific Micro-Integration type using its unique identifier.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>micro_integrations:get:*</code> <b>or</b> <code>micro_integration_types:get:*</code> ]",
        "operationId": "getMicroIntegrationType",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique identifier of the Micro-Integration type, such as <code>awssns-target</code>.",
            "required": true,
            "schema": {
              "type": "string",
              "default": ""
            },
            "example": "awssns-target"
          },
          {
            "name": "version",
            "in": "query",
            "description": "The version of the Micro-Integration type to get, such as <code>1.0.0</code>. When omitted, the latest version of the Micro-Integration type is returned.",
            "required": false,
            "schema": {
              "type": "string",
              "default": ""
            },
            "example": "1.0.0"
          }
        ],
        "responses": {
          "200": {
            "description": "OK.",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/MicroIntegrationTypeResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                }
              }
            }
          },
          "400": {
            "description": "Bad Request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                }
              },
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                }
              }
            }
          },
          "403": {
            "description": "Forbidden.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                }
              }
            }
          },
          "404": {
            "description": "Not Found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "default": null,
        "discriminator": {
          "propertyName": "errorType"
        },
        "properties": {
          "message": {
            "type": "string",
            "default": "",
            "description": "A user-friendly message that describes the error.",
            "example": "An error occurred."
          },
          "errorId": {
            "type": "string",
            "default": "",
            "description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.",
            "example": "123e4567-e89b-12d3-a456-426655440000"
          },
          "meta": {
            "type": "object",
            "additionalProperties": {},
            "default": "",
            "example": "'object': { 'field': 'description' }"
          },
          "validationDetails": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "default": "",
            "description": "When applicable, these are the details of issues with the fields provided for the REST call.",
            "example": "'name': ['Not unique']"
          },
          "errorType": {
            "type": "string",
            "writeOnly": true
          }
        }
      },
      "KeyField": {
        "type": "object",
        "default": null,
        "description": "The list of key fields that can be found in the Micro-Integration templates associated to this type. These fields can help you to identify necessary information that you must provide.",
        "properties": {
          "name": {
            "type": "string",
            "default": "",
            "description": "The name of the key field.",
            "example": "AWS Region",
            "readOnly": true
          },
          "templateType": {
            "type": "string",
            "default": "",
            "description": "The type of Micro-Integration template that this key field can be found within.",
            "example": "vendor",
            "readOnly": true
          },
          "path": {
            "type": "string",
            "default": "",
            "description": "The path in a Micro-Integration's <code>configurationValues</code> property at which the key field's value can be found for the given template type.",
            "example": "region",
            "readOnly": true
          },
          "defaultDescription": {
            "type": "string",
            "default": "",
            "description": "The description or value of the field when no value is provided in the Micro-Integration's <code>configurationValues</code> property.",
            "example": "us/east1",
            "readOnly": true
          }
        },
        "readOnly": true
      },
      "MicroIntegrationType": {
        "type": "object",
        "default": null,
        "properties": {
          "id": {
            "type": "string",
            "default": "",
            "description": "The unique identifier of the Micro-Integration type.",
            "example": "awssns-target",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "default": "",
            "description": "The name of the Micro-Integration type.",
            "example": "Amazon SNS",
            "readOnly": true
          },
          "version": {
            "type": "string",
            "default": "",
            "description": "The version of the Micro-Integration type.",
            "example": "6.0.1",
            "readOnly": true
          },
          "description": {
            "type": "string",
            "default": "",
            "description": "The description of the Micro-Integration type.",
            "example": "The Amazon SNS-Target publishes events from an event broker service to an SNS Topic with message acknowledgement.",
            "readOnly": true
          },
          "microIntegrationType": {
            "type": "string",
            "default": "",
            "description": "The unique identifier of the vendor or system associated with the Micro-Integration type.",
            "example": "awssns",
            "readOnly": true
          },
          "integrationHubUrl": {
            "type": "string",
            "default": "",
            "description": "The Integration Hub URL associated with the Micro-Integration Type. Configuration details, examples, download links, and more information can be found in the Integration Hub.",
            "example": "https://solace.com/integration-hub/aws-sns/",
            "readOnly": true
          },
          "category": {
            "type": "string",
            "default": "",
            "description": "The category that the Micro-Integration type belongs to, such as \"Messaging/Eventing\".",
            "example": "Messaging/Eventing",
            "readOnly": true
          },
          "direction": {
            "type": "string",
            "default": "",
            "description": "<p>The direction specifies the flow of data for the Micro-Integration. The directions are:</p><ul><li><code>source</code>-A source Micro-Integration is where data flows from the event broker service through the Micro-Integration to the external system.</li><li><code>target</code>-A target Micro-Integration is where data flows from the  external system through the Micro-Integration to the event broker service.</li></ul>.",
            "example": "target",
            "readOnly": true
          },
          "acceptedVendorContentTypes": {
            "type": "array",
            "default": "",
            "description": "List of supported vendor payload content-types for this Micro-Integration type. For source types this is derived from sourceContentTypes, for target types from targetContentTypes. Values are API-friendly terms: json and/or xml.",
            "example": [
              "json",
              "xml"
            ],
            "items": {
              "type": "string"
            },
            "readOnly": true
          },
          "keyFields": {
            "type": "array",
            "default": "",
            "description": "The list of key fields that can be found in the Micro-Integration templates associated to this type. These fields can help you to identify necessary information that you must provide.",
            "items": {
              "$ref": "#/components/schemas/KeyField"
            },
            "readOnly": true
          },
          "maximumFlowCountPerDeployment": {
            "type": "integer",
            "format": "int32",
            "default": "",
            "description": "The maximum number of flows that this Micro-Integration type can support",
            "readOnly": true
          },
          "type": {
            "type": "string",
            "default": "",
            "description": "The type of object for informational purposes.",
            "example": "microIntegrationType",
            "readOnly": true
          }
        }
      },
      "MicroIntegrationTypeResponse": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/MicroIntegrationType"
          }
        }
      }
    },
    "securitySchemes": {
      "APIToken": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}
```