minimusdocs
Help center

Users

List users

GET/auth/users/

read Read: looks, changes nothing. Scopes

Accounts you can see (staff, resellers and lines), a page at a time, by username.

Query parameters

  • groupinteger

    Only members of this group.

  • orderingstring

    Which field to use when ordering the results.

  • ownerstring (uuid)

    Only accounts this account created.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • scopestring

    mine: accounts you created; subtree: those and everyone below them; all: every account (for those who may see all, otherwise the same as subtree).

    One of: "all" "mine" "subtree"

  • searchstring

    Matches the username, email, first or last name.

  • user_typestring

    panel: every dashboard account (superusers and staff).

    One of: "line" "panel" "staff" "superuser"

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]required
    • idstring (uuid)requiredread-only
    • usernamestringrequired
    • emailstring (email)can be null
    • first_namestring
    • last_namestring
    • is_staffboolean

      Designates whether the user can log into this admin site.

    • is_superuserboolean

      Designates that this user has all permissions without explicitly assigning them.

    • is_activeboolean
    • user_typestringrequiredread-only
    • ownerstringrequiredread-onlycan be null
    • groupsstring[]requiredread-only
    • created_atstring (date-time)requiredread-only
    • last_loginstring (date-time)requiredread-onlycan be null
    • credit_balancestringrequiredread-onlycan be null
    • credits_unlimitedbooleanrequiredread-only
    • two_stepbooleanrequiredread-only
    • passkeysintegerrequiredread-only

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means