> ## Documentation Index
> Fetch the complete documentation index at: https://docs.riseworks.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get team users

> Retrieves a list of users associated with the specified team identified by its nanoid. This endpoint is useful for obtaining user details for a specific team, including their names, email addresses, onboarding status, and payment eligibility. Supports an optional `emails` filter to look up one or many users in a single request (repeated keys or a comma-separated list, up to 100), and optional offset pagination via page/offset/count query params; without them the full list is returned. Emails that match no team member are simply absent from the response — compare the returned `email` values against what you sent to detect them.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v2/teams/{team_nanoid}/users
openapi: 3.0.3
info:
  title: Rise
  description: Web3-enabled payroll and compliance for the modern workforce
  version: 2.0.0
servers:
  - url: https://b2b-api.dev-riseworks.io
    description: Development
  - url: https://integrations-api.staging-riseworks.io
    description: Staging
  - url: https://integrations-api.riseworks.io
    description: Production
security: []
paths:
  /v2/teams/{team_nanoid}/users:
    get:
      tags:
        - Teams
      summary: Get team users
      description: >-
        Retrieves a list of users associated with the specified team identified
        by its nanoid. This endpoint is useful for obtaining user details for a
        specific team, including their names, email addresses, onboarding
        status, and payment eligibility. Supports an optional `emails` filter to
        look up one or many users in a single request (repeated keys or a
        comma-separated list, up to 100), and optional offset pagination via
        page/offset/count query params; without them the full list is returned.
        Emails that match no team member are simply absent from the response —
        compare the returned `email` values against what you sent to detect
        them.
      parameters:
        - schema:
            anyOf:
              - type: array
                items:
                  type: string
              - type: string
          in: query
          name: emails
          required: false
          description: >-
            Filter to specific users by email. Accepts repeated keys or a
            comma-separated list, up to 100 emails.
        - schema:
            type: string
          in: query
          name: page
          required: false
          description: 1-indexed page number.
        - schema:
            type: string
          in: query
          name: offset
          required: false
          description: Row offset (alternative to page).
        - schema:
            type: string
          in: query
          name: count
          required: false
          description: >-
            Page size, 1-500 (default 100). Pagination only activates when page
            or offset is set.
        - schema:
            type: string
            minLength: 15
            maxLength: 15
            format: starts_with
            pattern: ^te-.*
          in: path
          name: team_nanoid
          required: true
          description: Unique identifier of the team for which to retrieve users.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      users:
                        type: array
                        items:
                          type: object
                          properties:
                            nanoid:
                              type: string
                              minLength: 15
                              maxLength: 15
                              format: starts_with
                              pattern: ^us-.*
                              description: Unique identifier for the user.
                            first_name:
                              type: string
                              description: User's first name.
                            middle_name:
                              type: string
                              description: User's middle name.
                            last_name:
                              type: string
                              description: User's last name.
                            email:
                              type: string
                              description: User's email address.
                            role:
                              type: string
                              description: User's team role.
                            rise_account:
                              type: string
                              pattern: ^0x(?!0{40}$)[a-fA-F0-9]{40}$
                              description: User's rise account.
                            riseid:
                              type: string
                              minLength: 42
                              maxLength: 42
                              description: User's riseid.
                            avatar:
                              type: string
                              description: User's avatar URL.
                            address:
                              type: object
                              properties:
                                line_1:
                                  type: string
                                  description: Primary address line
                                line_2:
                                  type: string
                                  description: Secondary address line
                                city:
                                  type: string
                                  description: City of the company
                                state:
                                  type: string
                                  description: State or region
                                country:
                                  type: string
                                  description: Country of the company
                                zip_code:
                                  type: string
                                  description: Postal code
                              required:
                                - line_1
                                - line_2
                                - city
                                - state
                                - country
                                - zip_code
                              additionalProperties: false
                            onboarding:
                              type: object
                              properties:
                                onboarded:
                                  description: Indicates whether the user is onboarded
                                  type: boolean
                                step:
                                  description: Current onboarding step, nullable
                                  type: string
                                  enum:
                                    - initial
                                    - details
                                    - compliance_process
                                    - security
                                    - signing
                                    - complete
                                    - riseid
                                    - signer
                                    - v1_migration_in_progress
                                    - v1_migration_need_rsk
                                    - v1_migration_need_kyc
                                  nullable: true
                                role:
                                  description: User's role during onboarding, nullable
                                  type: string
                                  enum:
                                    - payer
                                    - payee
                                    - viewer
                                    - admin
                                    - delegate_admin
                                    - non_delegate_admin
                                  nullable: true
                                moderation_status:
                                  description: >-
                                    Moderation status during onboarding,
                                    nullable
                                  type: string
                                  enum:
                                    - pending
                                    - submitted
                                    - approved
                                    - rejected
                                  nullable: true
                              required:
                                - onboarded
                                - step
                                - role
                                - moderation_status
                              additionalProperties: false
                            payable:
                              description: >-
                                Whether the user currently passes all payment
                                eligibility gates (onboarding complete, KYC
                                approved, and signed PSA if required)
                              type: boolean
                          required:
                            - nanoid
                            - first_name
                            - middle_name
                            - last_name
                            - email
                            - role
                            - rise_account
                            - riseid
                            - avatar
                            - address
                            - onboarding
                            - payable
                          additionalProperties: false
                      pagination:
                        description: >-
                          Present only when pagination was requested via
                          page/offset query params.
                        type: object
                        properties:
                          page:
                            type: number
                          count:
                            type: number
                          offset:
                            type: number
                          has_more:
                            type: boolean
                          next_page:
                            type: number
                            nullable: true
                          next_offset:
                            type: number
                            nullable: true
                        required:
                          - page
                          - count
                          - offset
                          - has_more
                          - next_page
                          - next_offset
                        additionalProperties: false
                    required:
                      - users
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  data:
                    type: string
                  error_code:
                    type: string
                required:
                  - success
                  - data
                additionalProperties: false
                description: Bad Request
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  data:
                    type: string
                  error_code:
                    type: string
                required:
                  - success
                  - data
                additionalProperties: false
                description: Unauthorized
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  data:
                    type: string
                  error_code:
                    type: string
                required:
                  - success
                  - data
                additionalProperties: false
                description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  data:
                    type: string
                  error_code:
                    type: string
                required:
                  - success
                  - data
                additionalProperties: false
                description: Not Found
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  data:
                    type: string
                  error_code:
                    type: string
                required:
                  - success
                  - data
                additionalProperties: false
                description: Internal Server Error
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  data:
                    type: string
                  error_code:
                    type: string
                required:
                  - success
                  - data
                additionalProperties: false
                description: Bad Gateway
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.