> ## Documentation Index > Fetch the complete documentation index at: https://developers.logicgate.ai/llms.txt > Use this file to discover all available pages before exploring further. # List user-group results filtered by default flag ## OpenAPI ````yaml GET /api/v1/internal/userGroups openapi: 3.1.0 info: title: Risk Cloud API description: >- The Risk Cloud API is a collection of RESTful API endpoints that empower you and your team to directly integrate, automate, and build with the Risk Cloud. Risk Cloud API endpoint payloads are JSON based, with some endpoints supporting exports in CSV and XSLX formats for flexible integration. This API documentation showcases our Risk Cloud API v1, containing a variety of endpoints with continued support for enabling integrations with the Risk Cloud. Visit the [LogicGate Risk Cloud Developer Portal](https://www.logicgate.com/developer/) to get started with building your custom integration with quick start guides, usage guides, release notes, and more. Or download the [v1 OpenAPI specification](/legacy-openapi.json). Explore our [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html) endpoints and documentation as well. [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html) is our collection of API-First endpoints that are tailor made for our developer users, offer concise and highly documented details, are supported by a [Postman collection](https://www.postman.com/logicgate-postman/workspace/logicgate-risk-cloud-api/collection/29257227-de8d264b-6eeb-4177-bea6-2da0a8cabffc) and [v2 OpenAPI specification](https://github.com/LogicGateTech/openapi), and contain our latest API endpoint releases. contact: name: developer-relations@logicgate.com email: developer-relations@logicgate.com version: v2026.11.0 servers: - url: https://{subdomain}.logicgate.com description: Your Risk Cloud environment. variables: subdomain: description: Your Risk Cloud environment's subdomain (e.g. `qa`). default: your-instance security: - ApiToken: [] - basic: [] tags: - name: Authentication description: >- Getting Started: How to create an [API Access Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/) to begin integrating with the Risk Cloud API - name: Attachment description: Endpoints for uploading, downloading, and retrieving record attachments. - name: Field description: Endpoints for creating, updating, and querying fields. - name: Principal description: >- Endpoints for the authenticated principal to view and manage their own details. - name: Record Audit description: Endpoints for retrieving record audit history and productivity data. - name: Step description: Endpoints for retrieving steps and the steps a user can access. - name: Table Report description: Endpoints for retrieving and managing table reports. - name: User Group description: Endpoints for managing user groups and their membership. externalDocs: description: Developer Portal url: https://www.logicgate.com/developer/ paths: /api/v1/internal/userGroups: get: tags: - User Group summary: List user-group results filtered by default flag. operationId: findByWorkflow parameters: - name: workflow in: query description: ID of the workflow to filter user groups by. required: true schema: type: string - name: title in: query description: Title to check for availability. required: true schema: type: string - name: id in: query description: Optional ID of the user group to exclude from the check. required: false schema: type: string - name: record-id in: query description: ID of the record whose user groups are returned. required: true schema: type: string - name: query in: query description: Search text matched against user groups. required: true schema: type: string - name: role-id in: query description: Optional role ID to filter user groups by. required: false schema: type: string - name: non-synced-only in: query description: Whether to return only non-synced user groups. required: false schema: type: boolean default: false - name: pageable in: query required: true schema: $ref: '#/components/schemas/Pageable_ExtendedUserGroupSummary' - name: default in: query description: Whether to return only default user groups. required: true schema: type: boolean responses: '200': description: OK content: application/json: schema: oneOf: - type: boolean - type: array items: $ref: '#/components/schemas/UserGroup_UserGroupSummary' - type: array items: $ref: '#/components/schemas/UserGroup_ExtendedUserGroupSummary' - $ref: >- #/components/schemas/PageUserGroupResult_ExtendedUserGroupSummary - type: array items: $ref: >- #/components/schemas/UserGroupResult_ExtendedUserGroupSummary '401': description: Unauthorized components: schemas: Pageable_ExtendedUserGroupSummary: type: object properties: paged: type: boolean pageNumber: type: integer format: int32 pageSize: type: integer format: int32 sort: $ref: '#/components/schemas/SortObject_ExtendedUserGroupSummary' unpaged: type: boolean offset: type: integer format: int64 UserGroup_UserGroupSummary: type: object properties: id: type: string recordDefault: type: boolean title: type: string automatedUserGroup: type: boolean automatedUserGroupFieldLabel: type: string required: - automatedUserGroup - automatedUserGroupFieldLabel - id - recordDefault - title UserGroup_ExtendedUserGroupSummary: type: object properties: id: type: string recordDefault: type: boolean title: type: string automatedUserGroup: type: boolean automatedUserGroupFieldLabel: type: string users: type: array items: $ref: '#/components/schemas/User_ExtendedUserGroupSummary' currentValue: $ref: '#/components/schemas/CurrentValue_ExtendedUserGroupSummary' required: - automatedUserGroup - automatedUserGroupFieldLabel - currentValue - id - recordDefault - title - users PageUserGroupResult_ExtendedUserGroupSummary: type: object properties: totalElements: type: integer format: int64 totalPages: type: integer format: int32 first: type: boolean last: type: boolean numberOfElements: type: integer format: int32 pageable: $ref: '#/components/schemas/Pageable_ExtendedUserGroupSummary' sort: $ref: '#/components/schemas/SortObject_ExtendedUserGroupSummary' size: type: integer format: int32 content: type: array items: $ref: '#/components/schemas/UserGroupResult_ExtendedUserGroupSummary' number: type: integer format: int32 empty: type: boolean UserGroupResult_ExtendedUserGroupSummary: type: object properties: id: type: string title: type: string recordDefault: type: boolean userCount: type: integer format: int64 required: - id - recordDefault - title - userCount SortObject_ExtendedUserGroupSummary: type: object properties: sorted: type: boolean unsorted: type: boolean empty: type: boolean User_ExtendedUserGroupSummary: allOf: - $ref: '#/components/schemas/CurrentValue_ExtendedUserGroupSummary' - type: object properties: email: type: string company: type: string imageUrl: type: string status: type: string tier: type: string enum: - PRIMARY - SECONDARY - LIMITED pricingUserTier: type: string enum: - STANDARD - POWER mfaEnabled: type: boolean mfaSetup: type: boolean autoprovisioned: type: boolean scimStatus: type: string automatedUser: type: boolean automatedUserFieldLabels: type: array items: type: string lastLogin: $ref: '#/components/schemas/AccessAudit_ExtendedUserGroupSummary' lastDeactivated: type: string format: date-time external: type: boolean disabled: type: boolean serviceAccount: type: boolean superUser: type: boolean name: type: string locked: type: boolean description: Entity for storing all information pertaining to a user. discriminator: propertyName: status oneOf: - $ref: '#/components/schemas/Active_ExtendedUserGroupSummary' - description: >- And other types: Automated_ExtendedUserGroupSummary, Disabled_ExtendedUserGroupSummary, External_ExtendedUserGroupSummary, Locked_ExtendedUserGroupSummary, Service_ExtendedUserGroupSummary properties: status: type: string required: - status CurrentValue_ExtendedUserGroupSummary: type: object description: Entity used to manage record's field data. discriminator: propertyName: discriminator oneOf: - $ref: '#/components/schemas/CurrentCommonValue_ExtendedUserGroupSummary' - description: >- And other types: CurrentDateValue_ExtendedUserGroupSummary, CurrentDateRangeValue_ExtendedUserGroupSummary, CurrentJobValue_ExtendedUserGroupSummary, CurrentCommonValue_ExtendedUserGroupSummary, CurrentDateValue_ExtendedUserGroupSummary, CurrentDateRangeValue_ExtendedUserGroupSummary, LabelValue_ExtendedUserGroupSummary, CleanAttachment_ExtendedUserGroupSummary, DirtyAttachment_ExtendedUserGroupSummary, PendingAttachment_ExtendedUserGroupSummary, CurrentGoogleAttachmentValue_ExtendedUserGroupSummary, CurrentSharepointAttachmentValue_ExtendedUserGroupSummary, Active_ExtendedUserGroupSummary, Automated_ExtendedUserGroupSummary, Disabled_ExtendedUserGroupSummary, External_ExtendedUserGroupSummary, Locked_ExtendedUserGroupSummary, Service_ExtendedUserGroupSummary, CurrentNumericRangeValue_ExtendedUserGroupSummary, CurrentJobValue_ExtendedUserGroupSummary properties: id: type: string discriminator: type: string idOrTransientId: type: string transientIdOrId: type: string textOrNumericValue: type: string empty: type: boolean required: - discriminator - id AccessAudit_ExtendedUserGroupSummary: type: object description: Entity used to track authentication attempts. discriminator: propertyName: accessType oneOf: - $ref: '#/components/schemas/LogIn_ExtendedUserGroupSummary' - description: >- And other types: LogOut_ExtendedUserGroupSummary, LogInFail_ExtendedUserGroupSummary, CredentialsRolled_ExtendedUserGroupSummary, TokenRolled_ExtendedUserGroupSummary, LogIn_ExtendedUserGroupSummary, LogOut_ExtendedUserGroupSummary, LogInFail_ExtendedUserGroupSummary, CredentialsRolled_ExtendedUserGroupSummary, TokenRolled_ExtendedUserGroupSummary properties: id: type: string accessType: type: string required: - accessType - id Active_ExtendedUserGroupSummary: allOf: - $ref: '#/components/schemas/CurrentValue_ExtendedUserGroupSummary' CurrentCommonValue_ExtendedUserGroupSummary: allOf: - description: Circular reference to CurrentValue_ExtendedUserGroupSummary required: - description LogIn_ExtendedUserGroupSummary: allOf: - description: Circular reference to AccessAudit_ExtendedUserGroupSummary required: - accessType securitySchemes: ApiToken: type: http scheme: bearer bearerFormat: API Token basic: type: http scheme: basic ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.