users

List users

Changed on

Get a list of users with optional filtering

get/api/v1/users

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-API-Key
    • or API key in header Authorization

Query parameters

limitinteger

Number of items to return

offsetinteger

Number of items to skip

querystring

Search query for username or email

role_idsstring[]

Filter by role IDs

activeboolean

Filter by active status

Response

OK

limitinteger
offsetinteger
totalinteger

Changes

  • 0bd802afff21Revision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was added to the API