> ## Documentation Index > Fetch the complete documentation index at: https://docs.reap.global/llms.txt > Use this file to discover all available pages before exploring further. # List users > Retrieves a paginated list of users. Use cursor-based pagination by passing the `nextCursor` value from the response to get subsequent pages. In `CORPORATE` mode, use `companyId` to filter users by company. ## OpenAPI ````yaml /api-reference/openapi.json get /users/ openapi: 3.1.0 info: title: Reap API version: 1.0.0 description: Reap platform API servers: - url: https://sandbox.api.reap.global description: Sandbox - url: https://prod.api.reap.global description: Production security: - bearerAuth: [] tags: - name: Accounts - name: Activities - name: Card Designs - name: Card Shipments - name: Card Transactions - name: Cards - name: Companies - name: Crypto Deposits - name: Policies - name: Simulation - name: Users - name: Virtual Asset Postings - name: Virtual Assets - name: Webhooks paths: /users/: get: tags: - Users summary: List users description: >- Retrieves a paginated list of users. Use cursor-based pagination by passing the `nextCursor` value from the response to get subsequent pages. In `CORPORATE` mode, use `companyId` to filter users by company. operationId: list_users parameters: - name: limit in: query required: false schema: default: 20 examples: - 20 - 50 - 100 description: 'Maximum number of items to return (1-100, default: 20)' type: integer exclusiveMinimum: 0 maximum: 100 - name: cursor in: query required: false schema: description: >- Opaque cursor for pagination. Pass nextCursor from previous response to get next page. type: string - name: id in: query required: false schema: description: Filter users by exact ID match type: string format: uuid - name: companyId in: query required: false schema: description: Filter users by company ID (`CORPORATE` mode only) type: string format: uuid - name: applicationStatus in: query required: false schema: description: Filter users by application status (comma-separated) type: array items: type: string enum: - NOT_STARTED - AWAITING_DOCUMENTS - IN_REVIEW - APPROVED - REJECTED - RETRY_REQUIRED description: >- - `NOT_STARTED`: KYC verification not yet initiated - `AWAITING_DOCUMENTS`: Identity data submitted; supporting documents pending upload (Universal KYC only) - `IN_REVIEW`: KYC application submitted and under review - `APPROVED`: KYC verified successfully - `REJECTED`: KYC rejected (final) - `RETRY_REQUIRED`: KYC requires resubmission example: NOT_STARTED - name: Reap-Version in: header required: true schema: type: string enum: - '2025-02-14' description: API version (YYYY-MM-DD) example: '2025-02-14' responses: '200': description: Response for status 200 content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/User' description: User resource nextCursor: anyOf: - type: string - type: 'null' description: Cursor for next page, or null if no more items required: - items - nextCursor '400': description: companyId is not allowed in Consumer program mode content: application/json: schema: type: object properties: error: type: object properties: code: type: string const: COMPANY_ID_NOT_ALLOWED message: type: string detail: anyOf: - type: object additionalProperties: {} - type: 'null' required: - code - message - detail required: - error title: CompanyIdNotAllowedError components: schemas: User: type: object properties: id: type: string format: uuid description: Unique user identifier email: type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ examples: - john.doe@example.com description: User email address phoneNumber: type: string examples: - '+14155552671' description: Phone number in E.164 format firstName: anyOf: - type: string - type: 'null' examples: - John description: >- User first name. Null until provided by the client or backfilled from the verified KYC identity on approval. lastName: anyOf: - type: string - type: 'null' examples: - Doe description: >- User last name. Null until provided by the client or backfilled from the verified KYC identity on approval. country: anyOf: - type: string minLength: 2 maxLength: 2 examples: - US - GB - DE description: ISO 3166-1 alpha-2 country code - type: 'null' dateOfBirth: anyOf: - type: string - type: 'null' examples: - '1990-05-15' description: Date of birth in YYYY-MM-DD format (populated from KYC) companyId: anyOf: - type: string format: uuid - type: 'null' description: Company ID (set in `CORPORATE` program mode) application: $ref: '#/components/schemas/UserApplication' createdAt: type: string examples: - '2024-01-15T10:30:00Z' description: ISO 8601 timestamp of creation updatedAt: type: string examples: - '2024-01-15T10:35:00Z' description: ISO 8601 timestamp of last update required: - id - email - phoneNumber - firstName - lastName - country - dateOfBirth - companyId - application - createdAt - updatedAt UserApplication: type: object properties: status: type: string enum: - NOT_STARTED - AWAITING_DOCUMENTS - IN_REVIEW - APPROVED - REJECTED - RETRY_REQUIRED description: Current KYC application status example: NOT_STARTED rejectionReason: anyOf: - type: string - type: 'null' description: >- Human-readable reason for rejection. Set when status is `REJECTED` or `RETRY_REQUIRED`, null otherwise. documents: anyOf: - type: array items: $ref: '#/components/schemas/UserApplicationDocument' - type: 'null' description: >- Supporting documents and their per-document review state. Null for applications with no supporting documents. required: - status - rejectionReason - documents description: KYC application status UserApplicationDocument: type: object properties: type: type: string enum: - IDENTITY - PROOF_OF_ADDRESS - CURP description: Supporting document category example: IDENTITY status: type: string enum: - PENDING - UPLOADED - RETRY_REQUIRED - REJECTED description: Review state of this document example: PENDING required: - type - status description: A supporting document and its review state securitySchemes: bearerAuth: type: http scheme: bearer description: API key as Bearer token ````