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

# Retrieve a list of users

> Returns a paginated list of users in your organization with their profile, license, and integration status.



## OpenAPI

````yaml /api/openapi-spec.yaml get /v1/users
openapi: 3.1.0
info:
  title: Momentum API
  description: >-
    API for managing meetings with attendee and transcript details, and
    retrieving AI signal executions.
  version: 2.0.0
servers:
  - url: https://api.momentum.io
security:
  - ApiKeyAuth: []
tags:
  - name: Meetings
    description: Endpoints for retrieving and managing meetings.
  - name: Users
    description: Endpoints for retrieving organization users.
  - name: Signals V1
    description: AI signal prompts and executions (v1).
  - name: Signals V2
    description: AI signal definitions and executions (v2).
paths:
  /v1/users:
    get:
      tags:
        - Users
      summary: Retrieve a list of users
      description: >-
        Returns a paginated list of users in your organization with their
        profile, license, and integration status.
      parameters:
        - name: pageNumber
          in: query
          description: >-
            The page number to retrieve (1-based indexing). Defaults to 1 if not
            specified.
          required: false
          schema:
            type: integer
            format: int32
            minimum: 1
            default: 1
        - name: pageSize
          in: query
          description: >-
            The maximum number of users to return per page. Must be between 1
            and 50. Defaults to 10 if not specified.
          required: false
          schema:
            type: integer
            format: int32
            minimum: 1
            maximum: 50
            default: 10
        - name: licenseAdded
          in: query
          description: >-
            Filter users by license status. Use 'true' for licensed users,
            'false' for unlicensed users.
          required: false
          schema:
            type: boolean
        - name: role
          in: query
          description: Filter users by role.
          required: false
          schema:
            type: string
            enum:
              - VIEWER
              - EDITOR
              - ORGANIZATION_ADMIN
              - USER_ADMIN
              - USER
      responses:
        '200':
          description: A paginated list of users.
          content:
            application/json:
              schema:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  pageCount:
                    type: integer
                    format: int32
                    description: Total number of pages available for the current query.
                required:
                  - users
                  - pageCount
        '400':
          description: Bad request due to validation errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message describing the validation failure
                required:
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                    example: Internal server error
                required:
                  - error
      x-codeSamples:
        - lang: curl
          label: cURL
          source: |
            curl --request GET \
              --url 'https://api.momentum.io/v1/users?pageSize=50&licenseAdded=true' \
              --header 'X-API-Key: YOUR_API_KEY'
        - lang: javascript
          label: JavaScript
          source: |
            const response = await fetch(
              "https://api.momentum.io/v1/users?pageSize=50&licenseAdded=true",
              {
                headers: { "X-API-Key": "YOUR_API_KEY" },
              }
            );
            const data = await response.json();
        - lang: python
          label: Python
          source: |
            import requests

            response = requests.get(
                "https://api.momentum.io/v1/users",
                headers={"X-API-Key": "YOUR_API_KEY"},
                params={
                    "pageSize": 50,
                    "licenseAdded": "true",
                },
            )
            data = response.json()
components:
  schemas:
    User:
      type: object
      properties:
        email:
          type: string
          format: email
          description: User's email address
        name:
          type: string
          description: User's full name
        role:
          type: string
          description: >-
            User's role in the organization. Note: the role filter query
            parameter accepts uppercase values (e.g. VIEWER), but the response
            returns the stored lowercase form.
          enum:
            - viewer
            - editor
            - organization-admin
            - user-admin
            - user
        type:
          type: string
          description: User type
        slackUserId:
          type: string
          nullable: true
          description: User's Slack user ID, if connected
        title:
          type: string
          nullable: true
          description: User's job title from Slack profile
        salesforceDepartment:
          type: string
          nullable: true
          description: User's department from Salesforce
        salesforceUserRole:
          type: string
          nullable: true
          description: User's role name from Salesforce
        licenseAdded:
          type: boolean
          description: Whether the user has an active AI license
        licenseAssignedAt:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when the license was assigned
        salesforceAuthStatus:
          type: string
          description: Salesforce authentication status
          enum:
            - AUTHENTICATED
            - NOT_AUTHENTICATED
        gcalAuthStatus:
          type: string
          description: Google Calendar authentication status
          enum:
            - AUTHENTICATED
            - NOT_AUTHENTICATED
      required:
        - email
        - name
        - role
        - type
        - licenseAdded
        - salesforceAuthStatus
        - gcalAuthStatus
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authenticating requests

````