Users

Read All Users

Changed on

Retrieve a list of users from the database with pagination.

get/api/v1/users/

Request

  • The document declares no server URL.
  • Auth
    • OAuth 2
      Password
      Token URL: api/v1/login
    • or API key in query parameter x-api-key
    • or API key in header x-api-key

Query parameters

skipinteger
limitinteger
searchstring nullable
usernamestring nullable

Exact username match

role_namestring nullable

Exact assigned role-name match

deletion_requestedboolean nullable

Only users with an open account deletion request

Headers

X-Langflow-Operation-IDstring nullable

Response

Successful Response

deletion_requestsobject

Status of each listed user's open account deletion request, keyed by user id.

total_countinteger required

Changes

  • 4349fbe90c64Revision changes
    • warning

      for the query request parameter limit, the max was set to 200.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • warning

      for the query request parameter skip, the min was set to 0.00

    • info

      added the new optional header request parameter X-Langflow-Operation-ID

    • info

      added the new optional query request parameter deletion_requested

    • info

      added the new optional query request parameter role_name

    • info

      added the new optional query request parameter username

    • info

      added the optional property to the response with the status

  • acd160326a88Revision changes
    • info

      added the new optional query request parameter search