> ## Documentation Index > Fetch the complete documentation index at: https://docs.leapfinancial.com/llms.txt > Use this file to discover all available pages before exploring further. # List users > Returns a paginated list of users associated with the authenticated partner. Filter by referenceId, CIP verification status, blocked status, and date range. ## OpenAPI ````yaml /raas-widgets/openapi.json get /partner/users openapi: 3.0.0 info: title: RaaS Widgets Partner API description: > REST API for RaaS Widgets partner integrations. Create magic links for embeddable flows, manage end users, track transfer operations, handle CIP verification, and configure webhooks for real-time event notifications. This specification covers the **Partner-accessible API** only (`X-API-Key` against `/partner/*`). Widget and Superadmin APIs are out of scope. ## Authentication All endpoints require an API key passed in the `X-API-Key` header. Use `raas_sandbox_*` keys for the sandbox environment and `raas_live_*` keys for production. ## Environments | Environment | Base URL | |---|---| | Sandbox | `https://raas-widgets-backend-sandbox.up.railway.app` | version: 1.18.0 contact: {} servers: - url: https://raas-widgets-backend-sandbox.up.railway.app description: Sandbox security: [] tags: - name: Partner - Magic Links description: Create, list, and manage magic links for flows - name: Partner - Flows description: List enabled flows and the full flow catalog - name: Partner - Users description: View and manage end users associated with your partner account - name: Partner - Operations description: Track money transfer operations and their statuses - name: Partner - Requests description: List and inspect money-request records - name: Partner - Deferred Payouts description: List, inspect, and cancel deferred payout remittances - name: Partner - CIP description: Customer Identification Program (CIP) verification management - name: Partner - Data Requests description: Fulfill data requests for additional user information - name: Partner - Settings description: Configure partner-level settings (redirect URLs, logo, etc.) - name: Partner - Webhooks description: Configure webhook endpoints and inspect delivery history - name: Partner - Pricing description: >- Indicative pre-quote summaries (best / worst / averages) for partner integrations paths: /partner/users: get: tags: - Partner - Users summary: List users description: >- Returns a paginated list of users associated with the authenticated partner. Filter by referenceId, CIP verification status, blocked status, and date range. operationId: UsersController_listUsers parameters: - name: page required: false in: query description: Page number (1-indexed) schema: minimum: 1 default: 1 example: 1 type: number - name: limit required: false in: query description: Number of items per page schema: minimum: 1 maximum: 100 default: 20 example: 20 type: number - name: from required: false in: query description: Filter records created on or after this date (ISO 8601) schema: example: '2026-01-01T00:00:00.000Z' type: string - name: to required: false in: query description: Filter records created on or before this date (ISO 8601) schema: example: '2026-02-28T23:59:59.999Z' type: string - name: referenceId required: false in: query description: >- Filter users by the partner reference ID assigned during link creation schema: example: user-12345 type: string - name: cipStatus required: false in: query description: >- Filter by CIP verification status. "pending" = verification not started or in progress. "verified" = identity successfully verified. "failed" = verification failed. schema: example: verified enum: - pending - verified - failed type: string - name: blocked required: false in: query description: >- Filter by blocked status. "true" returns only blocked users, "false" returns only unblocked users. schema: example: 'false' enum: - 'true' - 'false' type: string - name: suspended required: false in: query description: >- Filter by suspended status. "true" returns only suspended users, "false" returns only non-suspended users. schema: example: 'false' enum: - 'true' - 'false' type: string responses: '200': description: Paginated list of users content: application/json: schema: $ref: '#/components/schemas/ListUsersResponseDto' '401': description: Unauthorized — invalid or missing API key / bearer token security: - api-key: [] components: schemas: ListUsersResponseDto: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/ListUsersDataDto' required: - success - data ListUsersDataDto: type: object properties: items: description: Array of users type: array items: $ref: '#/components/schemas/UserListItemDto' pagination: $ref: '#/components/schemas/PaginationMetaDto' required: - items - pagination UserListItemDto: type: object properties: userId: type: string description: M2M user ID example: user_acme_x1y2z3 referenceId: type: string description: Partner reference ID example: user-12345 name: description: User name allOf: - $ref: '#/components/schemas/UserNameDto' cipStatus: type: string description: CIP verification status example: verified enum: - pending - verified - failed blocked: type: boolean description: Whether the user is blocked example: false suspended: type: boolean description: Whether the user is suspended (view-only, cannot create operations) example: false createdAt: type: string description: User creation timestamp (ISO 8601) example: '2026-02-10T12:00:00.000Z' required: - userId - referenceId - name - cipStatus - blocked - suspended - createdAt PaginationMetaDto: type: object properties: page: type: number description: Current page number example: 1 limit: type: number description: Number of items per page example: 20 total: type: number description: Total number of items matching the query example: 85 totalPages: type: number description: Total number of pages example: 5 required: - page - limit - total - totalPages UserNameDto: type: object properties: firstName: type: string description: First name example: Juan secondName: type: string description: Second name example: Carlos lastName: type: string description: Last name example: Pérez secondLastName: type: string description: Second last name example: García securitySchemes: api-key: type: apiKey in: header name: X-API-Key description: >- Your partner API key. Use `raas_sandbox_*` keys for the sandbox environment and `raas_live_*` keys for production. ````