Skip to main content
ZStack
Recently Deleted/Recently Deleted

ListGroups

List all user groups within the specified tenant organization.

GET/api/v1/tenants/{tenantUuid}/org/groups

Operation ID

ListGroups

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • tenantUuid
    StringRequired

    UUID of the tenant to list groups for

Query Parameters

  • keyword
    String

    Keyword to filter groups by name Keyword to filter groups by name

  • page
    Integer

    Page number (1-based) for pagination Page number (1-based) for pagination

    Example: 0

  • size
    Integer

    Number of records per page Number of records per page

    Example: 0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

  • total
    Integer

    Total number of matching org units

    Example: 10

  • limit
    Integer

    Maximum number of records returned per page

    Example: 20

  • offset
    Integer

    Number of records skipped from the start

    Example: 20