> ## Documentation Index
> Fetch the complete documentation index at: https://docs.versori.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List End User Integrations

> ListEndUserIntegrations returns all integrations which are available to the given End User.

This API should be used to populate the embedded UI with the integrations that the end user can activate.

If the `user_id` is referencing the external ID of the user, then the `hub` query parameter is required in order
to identify the correct Hub to retrieve the integrations from.




## OpenAPI

````yaml get /embed/{hub_id}/users/{user_id}/integrations
openapi: 3.1.0
info:
  title: Versori Embedded API
  version: 0.0.1
  license:
    name: UNLICENSED
    identifier: UNLICENSED
  description: V1 API for managing embedded integrations
servers:
  - description: Production
    url: https://platform.versori.com/api/embedded/v1
  - description: Staging
    url: https://platform-staging.versori.com/api/embedded/v1/
  - description: Development
    url: http://localhost:8950/embedded/v1
security: []
tags:
  - name: Hubs
  - name: End Users
  - name: Connectors
  - name: Integrations
  - name: Connections
  - name: Embedded
  - name: Miscellaneous
  - name: Internal
paths:
  /embed/{hub_id}/users/{user_id}/integrations:
    parameters:
      - $ref: '#/components/parameters/hub_id'
      - $ref: '#/components/parameters/user_id'
      - $ref: '#/components/parameters/identifier_type'
    get:
      tags:
        - Embedded
      summary: List End User Integrations
      description: >
        ListEndUserIntegrations returns all integrations which are available to
        the given End User.


        This API should be used to populate the embedded UI with the
        integrations that the end user can activate.


        If the `user_id` is referencing the external ID of the user, then the
        `hub` query parameter is required in order

        to identify the correct Hub to retrieve the integrations from.
      operationId: ListEndUserIntegrations
      parameters:
        - name: deployed
          in: query
          description: >
            Deployed allowing filtering integrations to only return either
            deployed (`true`) or not deployed (`false`) 

            integrations. 


            If not set, all integrations are returned.
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmbeddedIntegrationPage'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    hub_id:
      name: hub_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/ULID'
    user_id:
      description: >
        UserID references an End User in the Hub. 


        Most APIs support setting this value to either the internal Versori
        identifier or their external ID as 

        determined by the organisation. The `identifier_type` query parameter is
        used to indicate which type of ID is

        being used.
      name: user_id
      in: path
      required: true
      schema:
        type: string
    identifier_type:
      name: identifier_type
      in: query
      description: >
        IdentifierType indicates whether the `user_id` path parameter is a
        internal identifier created by Versori, or an 

        external identifier. If the value is `external`, some endpoints also
        require the `hub` query parameter to

        identify the correct Hub.
      required: false
      schema:
        type: string
        enum:
          - internal
          - external
        default: external
  schemas:
    EmbeddedIntegrationPage:
      description: >
        EndUserIntegrationPage is a paginated list of integrations to be
        displayed to the user when embedding the

        integration hub.
      type: object
      allOf:
        - $ref: '#/components/schemas/PageInfo'
        - type: object
          properties:
            integrations:
              type: array
              items:
                $ref: '#/components/schemas/EmbeddedIntegrationSummary'
            totalConnected:
              description: >
                TotalConnected is the total number of integrations that are
                connected for the end user. This can be used

                to display a badge on the embedded integration hub to show the
                user how many integrations they have

                connected.
              type: integer
          required:
            - integrations
    Error:
      type: object
      properties:
        code:
          type: string
          description: Code is a machine-readable error code.
        message:
          type: string
          description: Message is a human-readable error message.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/ErrorField'
          x-go-type-skip-optional-pointer: true
        details:
          type: string
          x-go-type-skip-optional-pointer: true
      required:
        - code
        - message
    ULID:
      type: string
      format: ulid
      x-go-type: ulid.ULID
      x-go-type-skip-optional-pointer: true
      x-go-type-import:
        path: versori.dev/vergo/ulid
    PageInfo:
      type: object
      properties:
        totalCount:
          type: integer
        next:
          type: string
          x-go-type-skip-optional-pointer: true
        prev:
          type: string
          x-go-type-skip-optional-pointer: true
      required:
        - totalCount
    EmbeddedIntegrationSummary:
      description: >
        EndUserIntegration represents an integration that is available to an end
        user.


        This object is only a summary of the integration and does not contain
        all the information to enable the user

        to activate it. The GetEmbeddedIntegration endpoint should be used to
        retrieve the full integration details.
      type: object
      properties:
        id:
          $ref: '#/components/schemas/ULID'
        name:
          description: >
            Name is a short name for the integration, this is typically the name
            of the Connector being integrated to.
          type: string
        imageUrl:
          description: >
            ImageURL is a URL to an image/icon that represents the integration.
            This image is used within the 

            integration tile displayed in the embedded UI.
          type: string
          format: uri
          x-go-name: ImageURL
        description:
          description: >
            Description can be used to provide a longer description of the
            integration. This can be shown to end users

            in the embedded integration hub UI.
          type: string
        variablesSchema:
          description: >
            VariablesSchema is the JSON schema for the variables defined for
            this integration.
          type: object
          x-go-type-skip-optional-pointer: true
          x-go-type: json.RawMessage
        isDeployed:
          description: >
            IsDeployed indicates whether the integration is deployed and
            available to end users. If not deployed, the

            integration cannot be activated.
          type: boolean
        isActivated:
          description: >
            IsActivated indicates whether the integration is activated for the
            end user. If the integration is not

            activated, the user can activate it from the embedded integration
            hub.
          type: boolean
      required:
        - id
        - name
        - imageUrl
        - description
        - isDeployed
        - isActivated
    ErrorField:
      description: ErrorField denotes a field which has an error.
      type: object
      properties:
        field:
          type: string
          description: >
            Field is the name of the field which has an error, this may be a
            path to a nested field, including array

            elements. The format of this field is of the form:
            "field1.field2[0].field3"
        message:
          type: string
          description: Message is the error message for this specific field.
      required:
        - field
        - message

````