> ## 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. # Get entitled users > Get a page of all users entitled to a step or record. Operation Type (READ or WRITE) and query are available as additional parameters to filter results. ## OpenAPI ````yaml GET /api/v1/users/entitled 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/users/entitled: get: tags: - User summary: Get entitled users description: >- Get a page of all users entitled to a step or record. Operation Type (READ or WRITE) and query are available as additional parameters to filter results. operationId: findEntitled parameters: - name: recordId in: query description: An optional Record ID to additionally validate user access to. required: false schema: type: string example: recordId=a1b2c3d4 - name: stepId in: query description: The Step ID to validate user access to. required: true schema: type: string example: stepId=a1b2c3d4 - name: request in: query required: true schema: $ref: '#/components/schemas/UserRequest_UserSummary' - name: pageable in: query required: true schema: $ref: '#/components/schemas/Pageable_UserSummary' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PageUser_UserSummary' components: schemas: UserRequest_UserSummary: type: object properties: assigneeId: type: string operationType: type: string enum: - READ - EDIT search-type: type: string writeOnly: true query: type: string searchType: type: string enum: - ALL - EMAIL - NAME - USER_ID required: - assigneeId - operationType - query - searchType Pageable_UserSummary: type: object properties: paged: type: boolean pageNumber: type: integer format: int32 pageSize: type: integer format: int32 sort: $ref: '#/components/schemas/SortObject_UserSummary' unpaged: type: boolean offset: type: integer format: int64 PageUser_UserSummary: 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_UserSummary' sort: $ref: '#/components/schemas/SortObject_UserSummary' size: type: integer format: int32 content: type: array items: $ref: '#/components/schemas/User_UserSummary' number: type: integer format: int32 empty: type: boolean SortObject_UserSummary: type: object properties: sorted: type: boolean unsorted: type: boolean empty: type: boolean User_UserSummary: allOf: - $ref: '#/components/schemas/CurrentValue_UserSummary' - 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_UserSummary' 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: - description: Circular reference to Active_UserSummary - description: >- And other types: Automated_UserSummary, Disabled_UserSummary, External_UserSummary, Locked_UserSummary, Service_UserSummary properties: status: type: string required: - status CurrentValue_UserSummary: type: object description: Entity used to manage record's field data. discriminator: propertyName: discriminator oneOf: - $ref: '#/components/schemas/CurrentCommonValue_UserSummary' - description: >- And other types: CurrentDateValue_UserSummary, CurrentDateRangeValue_UserSummary, CurrentJobValue_UserSummary, CurrentCommonValue_UserSummary, CurrentDateValue_UserSummary, CurrentDateRangeValue_UserSummary, LabelValue_UserSummary, CleanAttachment_UserSummary, DirtyAttachment_UserSummary, PendingAttachment_UserSummary, CurrentGoogleAttachmentValue_UserSummary, CurrentSharepointAttachmentValue_UserSummary, Active_UserSummary, Automated_UserSummary, Disabled_UserSummary, External_UserSummary, Locked_UserSummary, Service_UserSummary, CurrentNumericRangeValue_UserSummary, CurrentJobValue_UserSummary properties: id: type: string discriminator: type: string idOrTransientId: type: string transientIdOrId: type: string textOrNumericValue: type: string empty: type: boolean required: - discriminator - id AccessAudit_UserSummary: type: object description: Entity used to track authentication attempts. discriminator: propertyName: accessType oneOf: - $ref: '#/components/schemas/LogIn_UserSummary' - description: >- And other types: LogOut_UserSummary, LogInFail_UserSummary, CredentialsRolled_UserSummary, TokenRolled_UserSummary, LogIn_UserSummary, LogOut_UserSummary, LogInFail_UserSummary, CredentialsRolled_UserSummary, TokenRolled_UserSummary properties: id: type: string accessType: type: string required: - accessType - id CurrentCommonValue_UserSummary: allOf: - description: Circular reference to CurrentValue_UserSummary required: - description LogIn_UserSummary: allOf: - description: Circular reference to AccessAudit_UserSummary 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.