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

# List Users

> List active members with their plan, included budget, and extra usage budget

List active human members, change a plan, and set the extra usage budget beyond the included allowance. Amounts are US dollars.

The calls use the workspace API key's `BILLING_API` scope. Writes run as the key's service account owner. This API does not invite or deactivate members. Use the [User Management API](https://docs.langdock.com/en/developer/user-management-api/user-management-overview.md) for that.

## Base URL

```
https://api.langdock.com/billing/v1/bring-your-own-keys/users
```

> [!WARNING]
>
> **Dedicated deployments**
>
> Replace `api.langdock.com` with `<your-deployment-url>/api/public` in all requests.

## Prerequisites

* **API key** with the `BILLING_API` scope
* The key owner is a service account that has not been deleted and has an active Admin membership
* `USER_MANAGEMENT_API` on the same key when you need `email`, `name`, or an email filter

`plan` is `standard` or `power_user`. `email` is an exact address and ignores case. `limit` defaults to 50 and cannot exceed 250. Pass `cursor` from `nextCursor`.

To look a member up by email, call `GET /users?email=jane%40example.com` with a key that also has the User Management scope, then update by the returned `id`.

> [!NOTE]
>
> Langdock intentionally blocks browser-origin requests to protect your API key and ensure your applications remain secure. For more information, please see our guide on [API Key Best Practices](https://docs.langdock.com/en/admin/ai-adoption-and-rollout/best-practices/api-key-best-practices.md).


## OpenAPI

````yaml GET /billing/v1/bring-your-own-keys/users
openapi: 3.0.0
info:
  title: Langdock API
  version: 3.0.0
servers:
  - url: https://api.langdock.com
    description: Production
security:
  - bearerAuth: []
paths:
  /billing/v1/bring-your-own-keys/users:
    get:
      tags:
        - Users
      summary: List active human members
      operationId: listByokBillingUsers
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/UuidCursor'
        - $ref: '#/components/parameters/Email'
        - in: query
          name: plan
          schema:
            $ref: '#/components/schemas/ByokPlan'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ByokUserList'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '409':
          $ref: '#/components/responses/ModeMismatch'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    Limit:
      in: query
      name: limit
      schema:
        type: integer
        minimum: 1
        maximum: 250
        default: 50
    UuidCursor:
      in: query
      name: cursor
      schema:
        type: string
        format: uuid
      description: Use nextCursor from the preceding page.
    Email:
      in: query
      name: email
      schema:
        type: string
        format: email
      description: >-
        Case-insensitive exact email lookup among active human members. Requires
        the USER_MANAGEMENT_API scope; otherwise returns 403
        USER_MANAGEMENT_API_REQUIRED.
  schemas:
    ByokPlan:
      type: string
      enum:
        - standard
        - power_user
    ByokUserList:
      type: object
      additionalProperties: false
      required:
        - users
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/ByokUser'
        nextCursor:
          type: string
          format: email
    ByokUser:
      type: object
      additionalProperties: false
      required:
        - id
        - plan
        - monthlyBudget
        - extraUsageBudget
        - extraUsagePeriodSpend
      properties:
        id:
          type: string
          format: uuid
        email:
          type: string
          format: email
          description: Present only when the key also has the USER_MANAGEMENT_API scope.
        name:
          type: string
          nullable: true
          description: Present only when the key also has the USER_MANAGEMENT_API scope.
        plan:
          $ref: '#/components/schemas/ByokPlan'
        monthlyBudget:
          type: object
          additionalProperties: false
          required:
            - effective
          properties:
            effective:
              $ref: '#/components/schemas/ByokEffectiveLimit'
        extraUsageBudget:
          $ref: '#/components/schemas/ByokExtraUsageBudget'
        extraUsagePeriodSpend:
          type: number
          minimum: 0
          nullable: true
      description: >-
        USD. The highest plan/group monthly budget configures weekly and session
        allowances. Extra usage can start when those included allowances are
        exhausted. Spend is null when private and always null in mutation
        responses.
    Error:
      type: object
      additionalProperties: false
      required:
        - message
        - code
      properties:
        message:
          type: string
        code:
          type: string
        details:
          type: object
          additionalProperties: true
          description: >-
            Optional structured details specific to the error code, such as
            userIds for invalid bulk members.
    ModeMismatchError:
      type: object
      additionalProperties: false
      required:
        - message
        - code
        - details
      properties:
        message:
          type: string
        code:
          type: string
          enum:
            - BILLING_MODE_MISMATCH
        details:
          type: object
          additionalProperties: false
          required:
            - mode
          properties:
            mode:
              type: string
              enum:
                - ai-models-included
                - bring-your-own-keys
    ByokEffectiveLimit:
      oneOf:
        - type: object
          additionalProperties: false
          required:
            - type
            - amount
            - source
          properties:
            type:
              type: string
              enum:
                - limited
            amount:
              type: number
              minimum: 0
            source:
              $ref: '#/components/schemas/ByokBudgetSource'
        - type: object
          additionalProperties: false
          required:
            - type
            - source
          properties:
            type:
              type: string
              enum:
                - unlimited
            source:
              $ref: '#/components/schemas/ByokBudgetSource'
    ByokExtraUsageBudget:
      oneOf:
        - type: object
          additionalProperties: false
          required:
            - type
            - amount
          properties:
            type:
              type: string
              enum:
                - limited
            amount:
              type: number
              minimum: 0
        - type: object
          additionalProperties: false
          required:
            - type
          properties:
            type:
              type: string
              enum:
                - unlimited
        - type: object
          additionalProperties: false
          required:
            - type
          properties:
            type:
              type: string
              enum:
                - none
    ByokBudgetSource:
      oneOf:
        - type: object
          additionalProperties: false
          required:
            - type
          properties:
            type:
              type: string
              enum:
                - plan
        - type: object
          additionalProperties: false
          required:
            - type
            - groupId
            - groupName
          properties:
            type:
              type: string
              enum:
                - group
            groupId:
              type: string
              format: uuid
            groupName:
              type: string
  responses:
    BadRequest:
      description: >-
        Invalid body/query, unknown fields, empty PATCH, invalid limit, invalid
        bulk member IDs, or a cursor outside this workspace (INVALID_CURSOR).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing or invalid authentication.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        Missing Billing scope, personal key, unavailable feature, missing active
        service-account Admin authority, or email filter without the
        USER_MANAGEMENT_API scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: >-
        Resource not in this workspace, inactive/non-human user, privacy-hidden
        agent, usage request not found for that member, or endpoint unavailable
        in this mode.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    MethodNotAllowed:
      description: Unsupported HTTP method.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ModeMismatch:
      description: >-
        Workspace mode differs from the requested mode. details.mode identifies
        the workspace mode.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ModeMismatchError'
    TooManyRequests:
      description: API rate limit exceeded.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: API key as Bearer token. Format "Bearer YOUR_API_KEY"

````

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