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

# List duplicate groups

> Returns groups of records that match a custom duplicate rule. Records are grouped when they share identical values for the properties defined in the rule. Supports three lookup modes: list all groups for a rule (ruleId), retrieve a specific group (ruleId + groupId), or find all groups containing a specific record (objectId).

> **Supported products**


## OpenAPI

````yaml specs/2027-03-beta/crm-data-quality-v2027-03-beta.json GET /crm/data-quality/objects/2027-03-beta/duplicates/custom-rules/groups
openapi: 3.0.1
info:
  title: CRM Data Quality
  description: Basepom for all HubSpot Projects
  version: 2027-03-beta
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
paths:
  /crm/data-quality/objects/2027-03-beta/duplicates/custom-rules/groups:
    get:
      tags:
        - Basic
      summary: List duplicate groups
      description: >-
        Returns groups of records that match a custom duplicate rule. Records
        are grouped when they share identical values for the properties defined
        in the rule. Supports three lookup modes: list all groups for a rule
        (ruleId), retrieve a specific group (ruleId + groupId), or find all
        groups containing a specific record (objectId).
      operationId: >-
        get-/crm/data-quality/objects/2027-03-beta/duplicates/custom-rules/groups
      parameters:
        - name: after
          in: query
          description: >-
            A pagination cursor returned in a previous response. Pass this value
            to retrieve the next page of results.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: groupId
          in: query
          description: The ID of a specific group to retrieve. Requires ruleId.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int64
        - name: limit
          in: query
          description: >-
            The maximum number of groups to return per page. Defaults to 10,
            maximum 100. Only applies when listing groups by ruleId.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int32
            default: 10
        - name: objectId
          in: query
          description: Returns all groups that contain this record.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int64
        - name: objectsPerGroup
          in: query
          description: >-
            The maximum number of records to return per group. Defaults to 10,
            maximum 100.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int32
            default: 10
        - name: objectType
          in: query
          description: >-
            The type of records to retrieve groups for, such as contacts or
            companies. Required.
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: ruleId
          in: query
          description: >-
            The ID of the custom duplicate rule to retrieve groups for. Required
            when using groupId.
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int64
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/CollectionResponsePublicDuplicateGroupForwardPaging
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security: []
components:
  schemas:
    CollectionResponsePublicDuplicateGroupForwardPaging:
      required:
        - results
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/ForwardPaging'
        results:
          type: array
          description: >-
            An array of PublicDuplicateGroup objects, each representing a group
            of duplicates identified by a custom rule.
          items:
            $ref: '#/components/schemas/PublicDuplicateGroup'
    ForwardPaging:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/NextPage'
      description: >-
        Paging information for forward-only pagination. Contains the next page
        reference when more results are available; omitted or empty on the last
        page.
    PublicDuplicateGroup:
      required:
        - id
        - matchedPropertyValues
        - objectIds
        - objectType
        - ruleId
      type: object
      properties:
        id:
          type: integer
          description: The unique ID of this group.
          format: int64
          example: 2150857577
        matchedPropertyValues:
          type: object
          additionalProperties:
            type: string
          description: >-
            An object containing key-value pairs where keys are property names
            and values are the matched values that caused these objects to be
            considered duplicates.
          example: '{"email": "test@example.com"}'
        objectIds:
          type: array
          description: The IDs of the records identified as potential duplicates.
          example: '["1641843072", "1641846129"]'
          items:
            type: string
        objectType:
          type: string
          description: >-
            The type of records in this group, such as contacts (0-1) or
            companies (0-2).
          example: contacts
        ruleId:
          type: integer
          description: The ID of the custom duplicate rule that produced this group.
          format: int64
          example: 179716
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: The error category, represented as a string.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Context about the error condition, represented as an object with
            additional properties. Each property is an array of strings.
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            A unique identifier for the request, formatted as a UUID. Include
            this value with any error reports or support tickets.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: >-
            Further information about the error, provided as an array of
            ErrorDetail objects.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            A map of link names to associated URIs containing documentation
            about the error or recommended remediation steps, represented as an
            object with string properties.
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate. It is a string.
          example: An error occurred
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error, represented as a string.
      description: >-
        Represents an error response returned by the API when an operation
        fails. This component is used in various endpoints to provide detailed
        information about the error encountered.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    NextPage:
      required:
        - after
      type: object
      properties:
        after:
          type: string
          description: A paging cursor token for retrieving subsequent pages.
        link:
          type: string
          description: A URL that can be used to retrieve the next page results.
      description: >-
        Specifies the paging information needed to retrieve the next set of
        results in a paginated API response
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: >-
            The status code associated with the error detail, indicating the
            type of error that occurred.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Context about the error condition, represented as an object with
            additional properties. Each property is an array of strings
            providing more details, such as missing scopes.
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: >-
            The name of the field or parameter in which the error was found. It
            provides context about the location of the error.
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate. This is a required property.
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error, offering further classification.
      description: >-
        Represents detailed information about an error that occurred in the API.
        This component is used to provide additional context and specifics about
        errors, typically as part of an error response.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'

````