minimusdocs
Help center

Groups and permissions

List groups

GET/auth/groups/

read Read: looks, changes nothing. Scopes

Groups you can see, a page at a time, by name: those you manage and your own.

Query parameters

  • orderingstring

    Which field to use when ordering the results.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • scopestring

    mine: groups you created; subtree: the groups below yours; all: every group (for those who may see all).

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

  • searchstring

    Matches the name, or the name of a permission it gives.

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
    • idintegerrequiredread-only
    • namestringrequired
    • permissionsinteger[]
    • permissions_countintegerrequiredread-only

      Get count of permissions in this group

    • users_countintegerrequiredread-only

      Get count of users in this group

    • parentintegerrequiredread-onlycan be null
    • parent_namestringrequiredread-onlycan be null
    • created_by_usernamestringrequiredread-onlycan be null
    • created_atstring (date-time)requiredread-only
    • is_resellerbooleanrequiredread-only
    • can_customize_packagesbooleanrequiredread-only
    • can_customize_bouquetsbooleanrequiredread-only
    • trials_limitintegerrequiredread-only
    • trials_periodstringrequiredread-only

      Default: "day"

    • trials_min_balancestring (decimal)requiredread-only
    • refund_window_hoursintegerrequiredread-only

      Default: 0

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