---
title: "Find user groups"
method: GET
path: "/userGroups"
tags: ["User Groups"]
---

# Find user groups

`GET /userGroups`

Returns user groups matching the given search criteria. Only parameters that are specified in this request and have not <code>null</code> values are used for filtering. All other parameters are ignored. By default a result containing 1000 user groups is returned.

## Query parameters

- `offset` integer
- `limit` integer
- `countLimit` integer
- `name` string
- `nameMatchMode` 'START' | 'END' | 'ANYWHERE' | 'EXACT'
- `userId` string, uuid
- `includeEveryone` boolean

## Response `200`

Search completed

- UserGroupPagedResponse
  - `total` integer — The total number of results.
  - `offset` integer — The offset for the results.
  - `limit` integer — The maximum number of results to be returned.
  - `results` UserGroupImpl[] — The list of results.
    - `id` string, uuid, required — The id of the represented object (entity).
    - `createdBy` string, uuid — The id of the user that created this resource.
    - `createdOn` integer — The timestamp (in UTC time standard) of the creation of this resource.
    - `lastModifiedBy` string, uuid — The id of the user who modified this resource the last time.
    - `lastModifiedOn` integer — The timestamp (in UTC time standard) of the last modification of this resource.
    - `system` boolean — Whether this is a system resource or not.
    - `resourceType` 'View' | 'Asset' | 'Community' | 'Domain' | 'AssetType' | 'DomainType' | 'Status' | 'User' | 'ClassificationMatch' | 'UserGroup' | 'Attribute' | 'StringAttribute' | 'ScriptAttribute' | 'BooleanAttribute' | 'DateAttribute' | 'NumericAttribute' | 'SingleValueListAttribute' | 'MultiValueListAttribute' | 'Comment' | 'Attachment' | 'Responsibility' | 'Workflow' | 'Job' | 'Relation' | 'RelationType' | 'ComplexRelation' | 'ComplexRelationType' | 'ArticulationRule' | 'Assignment' | 'Scope' | 'RelationTrace' | 'ValidationRule' | 'DataQualityRule' | 'DataQualityMetric' | 'Address' | 'InstantMessagingAccount' | 'Email' | 'PhoneNumber' | 'Website' | 'Activity' | 'FormProperty' | 'WorkflowTask' | 'ActivityChange' | 'WorkflowInstance' | 'Role' | 'AttributeType' | 'BooleanAttributeType' | 'DateAttributeType' | 'DateTimeAttributeType' | 'MultiValueListAttributeType' | 'NumericAttributeType' | 'ScriptAttributeType' | 'SingleValueListAttributeType' | 'StringAttributeType' | 'ViewSharingRule' | 'ViewAssignmentRule' | 'JdbcDriverFile' | 'JdbcDriver' | 'JdbcIngestionProperties' | 'CsvIngestionProperties' | 'ExcelIngestionProperties' | 'ConnectionStringParameter' | 'AssignedCharacteristicType' | 'Notification' | 'Tag' | 'ComplexRelationLegType' | 'ComplexRelationAttributeType' | 'ComplexRelationLeg' | 'BaseDataType' | 'AdvancedDataType' | 'DiagramPicture' | 'DiagramPictureSharingRule' | 'DiagramPictureAssignmentRule' | 'Rating' | 'Classification' | 'PhysicalDataConnector' | 'Context', required — The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.
    - `name` string — The name of the resource.
    - `locallyManaged` boolean

---

[API](https://skmtc.net/collibra/apis/collibra-data-governance-center-core-api.md) · [All operations](https://skmtc.net/collibra/apis/collibra-data-governance-center-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/collibra/collibra-data-governance-center-core-api/revisions/6d091bc86a33/schema)