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

# List users

> Retrieve a paginated list of tenant users (internal staff/team members). Supports filtering by status, role, company, and search.



## OpenAPI

````yaml /openapi.json get /api/public/v1/users
openapi: 3.0.3
info:
  title: MSPortal Public API
  version: 1.0.0
  description: >-
    Public API for MSPortal - provides programmatic access to tenant data.


    ## Authentication


    All endpoints require authentication via API key passed as a Bearer token:


    ```

    Authorization: Bearer <your-api-key>

    ```


    API keys can be created in the MSPortal dashboard under Settings →
    Integrations → API Access.


    **Important:** Do not include cookies in API requests. The public API uses
    stateless authentication only.


    ## Scopes


    API keys are granted specific scopes that determine what operations they can
    perform. Each endpoint documents its required scope(s).


    ## Rate Limiting


    API calls are rate limited per API key. Rate limit information is returned
    in response headers:


    - `X-RateLimit-Limit`: Maximum requests per minute

    - `X-RateLimit-Remaining`: Remaining requests in current window

    - `X-RateLimit-Reset`: When the rate limit resets (ISO 8601)


    ## Request ID


    All responses include an `X-Request-Id` header for debugging and support.
    You can also pass your own `X-Request-Id` header to correlate requests.
  contact:
    name: MSPortal Support
    email: support@msportal.ai
  license:
    name: Proprietary
servers:
  - url: https://app.msportal.ai
    description: Production environment
security:
  - BearerAuth: []
tags:
  - name: Budgets
    description: >-
      Budget management - create, track, and forecast budgets with line items,
      categories, and products
  - name: Calendar
    description: Calendar and meeting management - events, participants, and meeting types
  - name: Companies
    description: Company management endpoints
  - name: Company Users
    description: Company user management - client portal contacts (read-only, paginated)
  - name: Compliance
    description: Compliance check management - runs, assigned checks, and status updates
  - name: Dashboards
    description: Dashboard management - external iframe resources and internal dashboards
  - name: Devices
    description: Device management - inventory, types, and locations
  - name: Goals
    description: Goal management - create, track, and manage goals with tasks and updates
  - name: NPS Surveys
    description: >-
      NPS survey management - Net Promoter Score surveys, responses, and
      analytics
  - name: Reports
    description: >-
      Report management - create, manage, and schedule reports with templates
      and types
  - name: Planner
    description: >-
      Planner item management - tasks, roadmap items, and project planning with
      linked goals, compliance, and projects
  - name: Surveys
    description: >-
      General survey management - multi-question surveys, responses, and
      statistics
  - name: Tickets
    description: Ticket management - view and filter tickets from PSA integrations
  - name: Training
    description: >-
      Training management - courses, enrollments, certificates, and progress
      tracking
  - name: Users
    description: Tenant user management - internal staff and team members (read-only)
  - name: Automation Rules
    description: >-
      Automation rule management - create, configure, and monitor automation
      rules with triggers, conditions, and actions
  - name: Analytics
    description: >-
      Analytics and reporting - company audit data, training analytics, user
      activity, and portfolio metrics
paths:
  /api/public/v1/users:
    get:
      tags:
        - Users
      summary: List users
      description: >-
        Retrieve a paginated list of tenant users (internal staff/team members).
        Supports filtering by status, role, company, and search.
      parameters:
        - schema:
            type: number
            minimum: 1
            default: 1
            description: Page number
          required: false
          description: Page number
          name: page
          in: query
        - schema:
            type: number
            minimum: 1
            maximum: 100
            default: 25
            description: Items per page
          required: false
          description: Items per page
          name: limit
          in: query
        - schema:
            type: string
            enum:
              - full_name
              - email
              - status
              - created_at
              - last_login
            default: full_name
            description: Field to sort by
          required: false
          description: Field to sort by
          name: sortColumn
          in: query
        - schema:
            type: boolean
            nullable: true
            default: false
            description: Sort descending
          required: false
          description: Sort descending
          name: sortDesc
          in: query
        - schema:
            type: string
            maxLength: 255
            description: Search in name and email
          required: false
          description: Search in name and email
          name: search
          in: query
        - schema:
            type: string
            enum:
              - active
              - disabled
              - pending
              - imported
            description: Filter by user status
          required: false
          description: Filter by user status
          name: status
          in: query
        - schema:
            type: string
            format: uuid
            description: Filter by role ID
          required: false
          description: Filter by role ID
          name: roleId
          in: query
        - schema:
            type: string
            format: uuid
            description: Filter by company ID
          required: false
          description: Filter by company ID
          name: companyId
          in: query
        - schema:
            type: boolean
            nullable: true
            description: Filter by primary admin status
          required: false
          description: Filter by primary admin status
          name: isPrimaryAdmin
          in: query
      responses:
        '200':
          description: List of users
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: Rate limit ceiling
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Remaining requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserListResponse'
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - Missing required scope (tenant-users.read)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    UserListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/User'
          description: Array of users
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - data
        - pagination
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message
        requestId:
          type: string
          description: Request correlation ID
        details:
          nullable: true
          description: Additional error details
        code:
          type: string
          description: Error code
      required:
        - error
    User:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: User ID
        email:
          type: string
          format: email
          description: Email address
        fullName:
          type: string
          description: Full name
        avatarUrl:
          type: string
          nullable: true
          description: Avatar URL
        status:
          type: string
          enum:
            - active
            - disabled
            - pending
            - imported
          description: User status
        isPrimaryAdmin:
          type: boolean
          description: Whether the user is the primary administrator
        lastLogin:
          type: string
          nullable: true
          format: date-time
          description: Last login timestamp (ISO 8601)
        createdAt:
          type: string
          format: date-time
          description: Creation timestamp (ISO 8601)
        updatedAt:
          type: string
          format: date-time
          description: Last update timestamp (ISO 8601)
        role:
          type: object
          nullable: true
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
          required:
            - id
            - name
          description: Assigned role
        company:
          type: object
          nullable: true
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
          required:
            - id
            - name
          description: Assigned company (if scoped to a company)
      required:
        - id
        - email
        - fullName
        - avatarUrl
        - status
        - isPrimaryAdmin
        - lastLogin
        - createdAt
        - updatedAt
        - role
        - company
    Pagination:
      type: object
      properties:
        page:
          type: integer
          minimum: 1
          description: Current page number
        limit:
          type: integer
          minimum: 1
          maximum: 100
          description: Items per page
        totalCount:
          type: integer
          description: Total number of items
        totalPages:
          type: integer
          description: Total number of pages
        hasNextPage:
          type: boolean
          description: Whether there is a next page
        hasPrevPage:
          type: boolean
          description: Whether there is a previous page
      required:
        - page
        - limit
        - totalCount
        - totalPages
        - hasNextPage
        - hasPrevPage
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Use your API key as a Bearer token. API keys can be generated in
        Settings → Integrations → API Access.

````