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

# Get users

> List the people in the API key's workspace: admins and members, whether or not they send from an identity. Enginy staff, organization (agency) staff with access to the workspace, CRM owners, pending invitations and removed users are not listed. A user is not an identity: the workspace capacity counts identities (see `GET /v1/workspace`), so the number of users can differ from it. Only workspace admins can call it.

    > **Required scope:** `USERS_READ`
    >
    > **Rate limit:** 100 requests per minute



## OpenAPI

````yaml https://openapi.enginy.ai/definitions.json get /v1/users
openapi: 3.1.0
info:
  title: Enginy API
  version: 1.0.0
  description: Public API for Enginy platform
servers:
  - url: https://openapi.enginy.ai
    description: Configured server
security: []
tags:
  - name: AI Variables
    description: >-
      Manage AI variables and discover the entity fields you can reference in
      prompts and entity requests.
  - name: Inbox
    description: >-
      Inbox endpoints for listing contact threads, reading thread messages,
      managing tags, and sending manual replies.
  - name: Workspace
    description: >-
      The API key's workspace: its capacity, its organization, where its users
      open the app and where an admin buys more.
  - name: Organization
    description: >-
      For organizations (agencies, resellers, white-label partners, enterprises)
      and their client workspaces only. Create client workspaces, distribute
      credits and identity slots between them, and buy or request more capacity.
      Upsell and management only: no endpoint lowers the contracted quota.
      Clients billed through self-serve billing keep their own plan. Requires an
      organization role.
  - name: Workflows
    description: >-
      Build, validate, publish, run, and inspect advanced (graph) workflows,
      plus the block/condition catalog needed to author a workflow plan.
paths:
  /v1/users:
    get:
      tags:
        - Users
      summary: Get users
      description: >-
        List the people in the API key's workspace: admins and members, whether
        or not they send from an identity. Enginy staff, organization (agency)
        staff with access to the workspace, CRM owners, pending invitations and
        removed users are not listed. A user is not an identity: the workspace
        capacity counts identities (see `GET /v1/workspace`), so the number of
        users can differ from it. Only workspace admins can call it.

            > **Required scope:** `USERS_READ`
            >
            > **Rate limit:** 100 requests per minute
      parameters:
        - schema:
            type: string
            default: '1'
            description: Page number for pagination. Minimum value is 1. Defaults to 1.
          required: false
          description: Page number for pagination. Minimum value is 1. Defaults to 1.
          name: page
          in: query
        - schema:
            type: string
            default: '25'
            description: >-
              Number of users per page. Minimum is 1, maximum is 100. Defaults
              to 25.
          required: false
          description: >-
            Number of users per page. Minimum is 1, maximum is 100. Defaults to
            25.
          name: pageSize
          in: query
        - schema:
            type: string
            description: Case-insensitive match on the user name or email.
          required: false
          description: Case-insensitive match on the user name or email.
          name: search
          in: query
        - schema:
            type: string
            enum:
              - admin
              - member
            description: >-
              Only workspace admins (`admin`) or only the other members
              (`member`).
          required: false
          description: >-
            Only workspace admins (`admin`) or only the other members
            (`member`).
          name: role
          in: query
      responses:
        '200':
          description: Users retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WorkspaceUser'
                  meta:
                    type: object
                    properties:
                      page:
                        type: number
                      pageSize:
                        type: number
                      total:
                        type: number
                    required:
                      - page
                      - pageSize
                      - total
                required:
                  - data
                  - meta
        '403':
          description: >-
            Missing the `USERS_READ` scope, or: Only workspace admins can list
            the workspace users. With an API key, the key must have been created
            by a workspace admin; over MCP, connect as a workspace admin.
      security:
        - apiKey: []
components:
  schemas:
    WorkspaceUser:
      type: object
      properties:
        id:
          type: number
          description: The user ID.
        name:
          type: string
          description: Full name.
        email:
          type: string
          description: Login email.
        role:
          type: string
          enum:
            - admin
            - member
          description: >-
            `admin` manages members, roles and billing in Enginy. `member` is
            everyone else, whatever access their role gives them.
        status:
          type: string
          enum:
            - active
          description: >-
            Always `active`: the list holds the current members. Pending
            invitations and removed users are not listed.
        createdAt:
          type: string
          description: When the user joined the workspace, in ISO 8601.
        lastActiveAt:
          type:
            - string
            - 'null'
          description: >-
            The last day the user was active in Enginy, in ISO 8601 (UTC), or
            null if never.
      required:
        - id
        - name
        - email
        - role
        - status
        - createdAt
        - lastActiveAt
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.