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

# List members

> Lists the people who can sign in to the Kintra CMS for your tenant, one row per membership carrying `id`, `user_id`, `email`, `username`, `status`, `roles`, `created_at` and `updated_at`. Each entry in `roles` carries a `role_id`. Filter with `email`, which matches part of an address without regard to case, and with `role`. Page with `page` and `limit`. The response `data` carries `items` alongside `total_count`, `page`, `limit`, `total_pages` and `has_next_page`. A member you have removed is not listed.



## OpenAPI

````yaml /openapi/kintra-app.json get /tenant/{tenantId}/members
openapi: 3.0.0
info:
  description: >-
    Tenant portal API for the Kintra loyalty platform. Requests are
    authenticated with an Auth0 bearer token and address a tenant by id in the
    path.
  title: Kintra Portal API
  version: 1.0.0
servers:
  - description: Production environment
    url: https://api.kintra.io/api/v1
security: []
paths:
  /tenant/{tenantId}/members:
    get:
      tags:
        - Members
      summary: List members
      description: >-
        Lists the people who can sign in to the Kintra CMS for your tenant, one
        row per membership carrying `id`, `user_id`, `email`, `username`,
        `status`, `roles`, `created_at` and `updated_at`. Each entry in `roles`
        carries a `role_id`. Filter with `email`, which matches part of an
        address without regard to case, and with `role`. Page with `page` and
        `limit`. The response `data` carries `items` alongside `total_count`,
        `page`, `limit`, `total_pages` and `has_next_page`. A member you have
        removed is not listed.
      operationId: TenantListMembers
      parameters:
        - in: path
          name: tenantId
          required: true
          schema:
            type: string
        - in: query
          name: email
          required: false
          schema:
            type: string
        - in: query
          name: role
          required: false
          schema:
            $ref: '#/components/schemas/TenantMemberRole'
        - in: query
          name: page
          required: false
          schema:
            default: 1
            format: double
            type: number
        - in: query
          name: limit
          required: false
          schema:
            default: 10
            format: double
            type: number
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ApiResponse_IPaginationResponse_ITenantMemberResponseDto__
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Tenant not found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Internal server error
      security:
        - auth0_jwt: []
components:
  schemas:
    TenantMemberRole:
      description: >-
        Portal operator roles that can be assigned to tenant members (not
        loyalty `user`).
      enum:
        - super_admin
        - read_only
      type: string
    ApiResponse_IPaginationResponse_ITenantMemberResponseDto__:
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/IPaginationResponse_ITenantMemberResponseDto_'
        errors:
          items:
            properties:
              message:
                type: string
              path:
                type: string
            required:
              - path
              - message
            type: object
          type: array
        message:
          type: string
        success:
          type: boolean
      required:
        - success
      type: object
    ApiResponse_null_:
      additionalProperties: false
      properties:
        data:
          enum:
            - null
          nullable: true
          type: number
        errors:
          items:
            properties:
              message:
                type: string
              path:
                type: string
            required:
              - path
              - message
            type: object
          type: array
        message:
          type: string
        success:
          type: boolean
      required:
        - success
      type: object
    IPaginationResponse_ITenantMemberResponseDto_:
      additionalProperties: false
      properties:
        has_next_page:
          type: boolean
        items:
          items:
            $ref: '#/components/schemas/ITenantMemberResponseDto'
          type: array
        limit:
          format: double
          type: number
        page:
          format: double
          type: number
        total_count:
          format: double
          type: number
        total_pages:
          format: double
          type: number
      required:
        - total_count
        - page
        - limit
        - has_next_page
        - total_pages
        - items
      type: object
    ITenantMemberResponseDto:
      additionalProperties: false
      properties:
        created_at:
          format: date-time
          type: string
        email:
          type: string
        id:
          type: string
        roles:
          items:
            $ref: '#/components/schemas/ITenantMemberRoleDto'
          type: array
        status:
          type: string
        tenant_id:
          type: string
        updated_at:
          format: date-time
          type: string
        user_id:
          type: string
        username:
          type: string
      required:
        - id
        - tenant_id
        - user_id
        - email
        - username
        - status
        - roles
        - created_at
        - updated_at
      type: object
    ITenantMemberRoleDto:
      additionalProperties: false
      properties:
        created_at:
          format: date-time
          type: string
        role_id:
          type: string
      required:
        - role_id
      type: object
  securitySchemes:
    auth0_jwt:
      bearerFormat: JWT
      description: Auth0 access token
      scheme: bearer
      type: http

````