# Get All User Groups

Returns user groups accessible to the requesting tenant. Supports pagination
and optional redirect handling for large payloads.

Endpoint: GET /api/v1/user-groups
Version: 1.0.0
Security: x-api-key

## Query parameters:

  - `page[number]` (integer)
    The page number to return. If not specified, defaults to the first page.
    Example: 1

  - `page[size]` (integer)
    The number of items to return per page. Defaults to 25.
    Example: 25

  - `allowRedirect` (boolean)
    If set to true, the API may return a 303 redirect response when the payload is too large. The field body.data.url includes the URL to the resource.
    Example: true

## Response 200 fields (application/json):

  - `data` (array, required)
    Collection of user groups.

  - `data.groupId` (string, required)
    Unique identifier for the user group.
    Example: "5e94d5b63f557b001420bbe3"

  - `data.name` (string, required)
    Name of the user group.
    Example: "Finance Team"

  - `data.groupOwner` (string,null)
    Identifier of the user who owns the group.
    Example: "5e94d5b63f557b001420bbe4"

  - `meta` (object, required)
    Pagination metadata for the response.

  - `meta.totalCount` (integer)
    Total number of user groups matching the query.
    Example: 120

  - `meta.page` (integer)
    Current page number.
    Example: 1

  - `meta.limit` (integer)
    Number of items per page.
    Example: 25

  - `meta.totalPages` (integer)
    Total number of pages available.
    Example: 5

  - `meta.hasNextPage` (boolean)
    Indicates if there is another page available.
    Example: true

  - `meta.hasPreviousPage` (boolean)
    Indicates if a previous page exists.

## Response 303 fields (application/json):

  - `data` (object)

  - `data.url` (string)
    The URL to the new location of the resource.

## Response 400 fields (application/json):

  - `message` (object)
    Reason for the errors related to incorrect query keys or values that are out of bound

  - `message.errors` (array)
    Array of errors

  - `message.errors.field` (string)
    The query key that is incorrect
    Example: "page[size]"

  - `message.errors.message` (string)
    Reason for the error
    Example: "page[size] must be a number"

  - `name` (string)
    BadRequest
    Example: "BadRequest"

  - `status` (integer)
    The HTTP status code.
    Example: 400

## Response 401 fields (application/json):

  - `message` (string)
    Reason for the error such as incorrect service access, malformed, expired or deactivated token.
    Example: "Invalid token"

  - `name` (string)
    Unauthorized
    Example: "Unauthorized"

  - `status` (integer)
    The HTTP status code.
    Example: 401