---
title: "GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions"
method: GET
path: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions"
tags: ["Interactions"]
---

# GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions

`GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions`

## Request

- Base URL: `https://management.azure.com`
- URL: `https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/interactions`
- Auth: OAuth 2
  - Implicit: `https://login.microsoftonline.com/common/oauth2/authorize`
  - Scopes: `user_impersonation`

Gets all interactions in the hub.

## Path parameters

- `resourceGroupName` string, required
- `hubName` string, required
- `subscriptionId` string, required

## Query parameters

- `locale-code` string
- `api-version` string, required

## Response `200`

OK. Successfully get all the interactions in the hub.

- InteractionListResult: The response of list interaction operation.
  - `value` InteractionResourceFormat[]: Results of the list operation.
    - `id` string: Resource ID.
    - `name` string: Resource name.
    - `type` string: Resource type.
    - `properties` InteractionTypeDefinition: The Interaction Type Definition
      - `attributes` object: The attributes for the Type.
      - `description` object: Localized descriptions for the property.
      - `displayName` object: Localized display names for the property.
      - `localizedAttributes` object: Any custom localized attributes for the Type.
      - `smallImage` string: Small Image associated with the Property or EntityType.
      - `mediumImage` string: Medium Image associated with the Property or EntityType.
      - `largeImage` string: Large Image associated with the Property or EntityType.
      - `apiEntitySetName` string: The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
      - `entityType` 'None' | 'Profile' | 'Interaction' | 'Relationship': Type of entity.
      - `fields` PropertyDefinition[]: The properties of the Profile.
        - `arrayValueSeparator` string: Array value separator for properties with isArray set.
        - `enumValidValues` ProfileEnumValidValuesFormat[]: Describes valid values for an enum property.
          - `value` integer: The integer value of the enum member.
          - `localizedValueNames` object: Localized names of the enum member.
        - `fieldName` string, required: Name of the property.
        - `fieldType` string, required: Type of the property.
        - `isArray` boolean: Indicates if the property is actually an array of the fieldType above on the data api.
        - `isEnum` boolean: Indicates if the property is an enum.
        - `isFlagEnum` boolean: Indicates if the property is an flag enum.
        - `isImage` boolean: Whether the property is an Image.
        - `isLocalizedString` boolean: Whether the property is a localized string.
        - `isName` boolean: Whether the property is a name or a part of name.
        - `isRequired` boolean: Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.
        - `propertyId` string: The ID associated with the property.
        - `schemaItemPropLink` string: URL encoded schema.org item prop link for the property.
        - `maxLength` integer: Max length of string. Used only if type is string.
        - `isAvailableInGraph` boolean: Whether property is available in graph or not.
        - `dataSourcePrecedenceRules` DataSourcePrecedence[]: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.
          - `dataSource` DataSource: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules.
            - `name` string: The data source name
            - `dataSourceType` 'Connector' | 'LinkInteraction' | 'SystemDefault': The data source type.
            - `status` 'None' | 'Active' | 'Deleted': The data source status.
            - `id` integer: The data source ID.
            - `dataSourceReferenceId` string: The data source reference id.
          - `precedence` integer: the precedence value.
      - `instancesCount` integer: The instance count.
      - `lastChangedUtc` string, date-time: The last changed time for the type definition.
      - `provisioningState` 'Provisioning' | 'Succeeded' | 'Expiring' | 'Deleting' | 'HumanIntervention' | 'Failed': Provisioning state.
      - `schemaItemTypeLink` string: The schema org link. This helps ACI identify and suggest semantic models.
      - `tenantId` string: The hub name.
      - `timestampFieldName` string: The timestamp property name. Represents the time when the interaction or profile update happened.
      - `typeName` string: The name of the entity.
      - `idPropertyNames` string[]: The id property names. Properties which uniquely identify an interaction instance.
      - `participantProfiles` Participant[]: Profiles that participated in the interaction.
        - `profileTypeName` string, required: Profile type name.
        - `participantPropertyReferences` ParticipantPropertyReference[], required: The property references.
          - `interactionPropertyName` string, required: The interaction property that maps to the profile property.
          - `profilePropertyName` string, required: The profile property that maps to the interaction property.
        - `participantName` string, required: Participant name.
        - `displayName` object: Localized display name.
        - `description` object: Localized descriptions.
        - `role` string: The role that the participant is playing in the interaction.
      - `primaryParticipantProfilePropertyName` string: The primary participant property name for an interaction ,This is used to logically represent the agent of the interaction, Specify the participant name here from ParticipantName.
      - `dataSourcePrecedenceRules` DataSourcePrecedence[]: This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.
        - `dataSource` DataSource: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules.
          - `name` string: The data source name
          - `dataSourceType` 'Connector' | 'LinkInteraction' | 'SystemDefault': The data source type.
          - `status` 'None' | 'Active' | 'Deleted': The data source status.
          - `id` integer: The data source ID.
          - `dataSourceReferenceId` string: The data source reference id.
        - `precedence` integer: the precedence value.
      - `defaultDataSource` DataSource: Data Source is a way for us to know the source of instances. A single type can have data coming in from multiple places. In activities we use this to determine precedence rules.
        - `name` string: The data source name
        - `dataSourceType` 'Connector' | 'LinkInteraction' | 'SystemDefault': The data source type.
        - `status` 'None' | 'Active' | 'Deleted': The data source status.
        - `id` integer: The data source ID.
        - `dataSourceReferenceId` string: The data source reference id.
      - `isActivity` boolean: An interaction can be tagged as an activity only during create. This enables the interaction to be editable and can enable merging of properties from multiple data sources based on precedence, which is defined at a link level.
  - `nextLink` string: Link to the next set of results.

---

[API](https://skmtc.dev/azure/apis/customer-insights-microsoft-customerinsights-customerinsight.md) - [All operations](https://skmtc.dev/azure/apis/customer-insights-microsoft-customerinsights-customerinsight/llms.txt) - [OpenAPI document](https://skmtc.dev/azure/apis/customer-insights-microsoft-customerinsights-customerinsight/revisions/1a3e19f598e0?raw)
