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

# List Users

> Browse through all the users in your workspace. Filter by organization to see who belongs to specific teams or companies. Results are paginated for easy navigation through large user bases.



## OpenAPI

````yaml https://www.greenflash.ai/api/openapi get /users
openapi: 3.1.0
info:
  title: Greenflash API Reference
  version: 1.0.0
  description: >-
    Greenflash endpoints for capturing interactions, managing prompts, and
    identifying users.
servers:
  - url: https://www.greenflash.ai/api/v1
    description: Greenflash API v1
security: []
tags:
  - name: Interactions
    description: Capture interactions between users and AI
  - name: Business Events
    description: Capture business events
  - name: Analytics
    description: Understand chat and agentic interactions analyses
  - name: Inbox
    description: Review flagged conversations
  - name: Segments
    description: Manage user segments
  - name: Prompts
    description: Manage prompts
  - name: Chat
    description: Stream chat and agentic conversations
  - name: Models
    description: Manage AI models
  - name: Products
    description: Manage products
  - name: Users
    description: Manage users
  - name: Organizations
    description: Manage organizations
paths:
  /users:
    get:
      tags:
        - Users
      summary: List Users
      description: >-
        Browse through all the users in your workspace. Filter by organization
        to see who belongs to specific teams or companies. Results are paginated
        for easy navigation through large user bases.
      parameters:
        - schema:
            type: number
            minimum: 1
            maximum: 100
            default: 50
            description: Maximum number of results to return.
          required: false
          description: Maximum number of results to return.
          name: limit
          in: query
        - schema:
            type: number
            minimum: 0
            description: Offset for pagination.
          required: false
          description: Offset for pagination.
          name: offset
          in: query
        - schema:
            type: number
            minimum: 1
            description: Page number (used to derive offset = (page-1)*limit).
          required: false
          description: Page number (used to derive offset = (page-1)*limit).
          name: page
          in: query
        - schema:
            type: string
            format: uuid
            description: Filter users by organization ID.
          required: false
          description: Filter users by organization ID.
          name: organizationId
          in: query
      responses:
        '200':
          description: Users retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUsersResponse'
              example:
                - id: part-001
                  externalId: user-123
                  organizationId: org-001
                  externalOrganizationId: org-456
                  name: Alice Example
                  email: alice@example.com
                  phone: '+15551234567'
                  anonymized: false
                  properties:
                    plan: premium
                  createdAt: '2025-07-01T12:00:00Z'
                  updatedAt: '2025-10-01T14:30:00Z'
                - id: part-002
                  externalId: user-456
                  organizationId: org-001
                  externalOrganizationId: org-456
                  name: Bob Builder
                  email: bob@example.com
                  phone: null
                  anonymized: false
                  properties:
                    plan: free
                  createdAt: '2025-08-15T09:00:00Z'
                  updatedAt: '2025-09-20T11:00:00Z'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Whether the API call was successful (false for errors).
                  error:
                    type: string
                    description: Error message describing what went wrong.
                description: Error response for list users operations.
              example:
                success: false
                error: 'Invalid parameter: limit must be between 1 and 100'
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Greenflash from 'greenflash';

            const client = new Greenflash({
              apiKey: process.env['GREENFLASH_API_KEY'], // This is the default and can be omitted
            });

            const listUsersResponse = await client.users.list();

            console.log(listUsersResponse);
        - lang: Python
          source: |-
            import os
            from greenflash import Greenflash

            client = Greenflash(
                api_key=os.environ.get("GREENFLASH_API_KEY"),  # This is the default and can be omitted
            )
            list_users_response = client.users.list()
            print(list_users_response)
components:
  schemas:
    ListUsersResponse:
      type: array
      items:
        $ref: '#/components/schemas/Participant'
      description: Array of users.
    Participant:
      type: object
      properties:
        id:
          type: string
          description: The Greenflash participant ID.
        externalId:
          type: string
          description: Your external user ID (matches the externalUserId from the request).
        organizationId:
          type:
            - string
            - 'null'
          format: uuid
          description: The internal organization ID that the user belongs to.
        externalOrganizationId:
          type:
            - string
            - 'null'
          description: Your external identifier for the user's organization.
        name:
          type: string
          description: The participant's full name.
        email:
          type: string
          description: The participant's email address.
        phone:
          type: string
          description: The participant's phone number.
        anonymized:
          type: boolean
          description: Whether the participant's personal information is anonymized.
        properties:
          type: object
          additionalProperties: {}
          description: Additional data about the participant.
        createdAt:
          type: string
          format: date-time
          description: When the participant was first created.
        updatedAt:
          type: string
          format: date-time
          description: When the participant was last updated.
      required:
        - id
        - externalId
        - organizationId
        - externalOrganizationId
        - anonymized
        - properties
      description: The user profile.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````