minimusdocs
Help center

Users

List staff users

GET/auth/staff-users/

read Read: looks, changes nothing. Scopes

Accounts with dashboard access (staff and resellers) you can see, by username.

Query parameters

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • scopestring

    mine: accounts you created; subtree (default): those and everyone below them; all: every account (for those who may see all).

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

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
    • usernamestringrequiredread-only
    • emailstring (email)requiredread-onlycan be null
    • first_namestringrequiredread-only
    • last_namestringrequiredread-only
    • is_activebooleanrequiredread-only
    • is_staffbooleanrequiredread-only

      Designates whether the user can log into this admin site.

    • is_superuserbooleanrequiredread-only

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

    • groupsstring[]requiredread-only
    • ownerstringrequiredread-onlycan be null
    • direct_permissions_countintegerrequiredread-only
    • last_loginstring (date-time)requiredread-onlycan be null
    • created_atstring (date-time)requiredread-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