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

# List users

> Returns a paginated list of users who belong to the API key's team. Supports cursor pagination, search, and filtering by active membership status.



## OpenAPI

````yaml /openapi.v2.json get /users
openapi: 3.1.1
info:
  title: Heffl API v2 (Beta)
  version: 2.0.0
  description: >-
    Heffl REST API v2 (beta) — resource-oriented endpoints with consistent
    response envelopes. Endpoints, schemas, and behavior may change until GA.
    See Agent workflows and ID prefixes guides for automation.
  contact:
    name: Heffl Support
    url: https://heffl.com/support
    email: support@heffl.com
servers:
  - url: https://api.heffl.com/api/v2
    description: Production API Server
security:
  - ApiKeyAuth: []
paths:
  /users:
    get:
      tags:
        - Reference Data
      summary: List users
      description: >-
        Returns a paginated list of users who belong to the API key's team.
        Supports cursor pagination, search, and filtering by active membership
        status.
      operationId: reference.users.list
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Cursor for pagination. Pass the previous response meta.nextCursor
            value to fetch the next page.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Number of items to return (max 100)
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Search by first name, last name, or email
        - name: active
          in: query
          required: false
          schema:
            type: boolean
          description: Filter by active team membership status
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  meta:
                    $ref: '#/components/schemas/ListMeta'
                required:
                  - data
                  - meta
        '400':
          description: Validation error or bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '403':
          description: Insufficient permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ApiError'
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
          description: User ID
        firstName:
          type: string
          description: First name
        lastName:
          anyOf:
            - type: string
            - type: 'null'
          description: Last name
        email:
          type: string
          description: Email address
        jobTitle:
          anyOf:
            - type: string
            - type: 'null'
          description: Job title
        role:
          type: string
          description: Team role
        createdAt:
          type: string
          format: date-time
          description: When the user was created
      required:
        - id
        - firstName
        - email
        - role
        - createdAt
    ListMeta:
      type: object
      properties:
        nextCursor:
          type:
            - string
            - 'null'
          description: Cursor to fetch the next page. Null if there are no more results.
        hasMore:
          type: boolean
          description: Whether additional results are available
      required:
        - hasMore
    V2ApiError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Get yours at
        app.heffl.com/settings/developers

````