# (NEW!) List Security User Groups (Paginated)

Retrieve a paginated, searchable list of the security user groups configured for the authenticated customer. This endpoint only ever operates on type: security groups — there is no way to request channel groups through it.

Defaults:
- sortField defaults to groupName.
- order defaults to asc.
- from defaults to 0.
- limit defaults to 100 (clamped to 100 if a higher value is supplied).

Business Rules:
- searchTerm is a case-insensitive substring match on group name. Special LIKE characters (%, _, \) are treated as literal text, not wildcards.
- There is no type query parameter. Every group returned is type: security. Sending a type parameter of any value — including security — is rejected with 400; it is not silently ignored, and it never changes what's returned. Channel groups are created and managed exclusively by the Publishing flow under a separate privilege, never through this API.

The user submitting the request must have the User Management privilege.

Endpoint: GET /security/user-groups
Version: 1.5
Security: ApiKeyAuth, BasicAuth

## Header parameters:

  - `X-API-Key` (string, required)
    Customer-specific API key required to invoke API.

  - `Authorization` (string, required)
    Provided by Authentication Token creation operation.

## Query parameters:

  - `searchTerm` (string)
    Case-insensitive substring match on group name. Special LIKE characters (%, _, \) are treated as literal text.

  - `sortField` (string)
    Field to sort results by. Defaults to groupName.
    Enum: "groupName", "userCount", "createdEpoch", "lastUpdatedEpoch"

  - `order` (string)
    Sort direction. Defaults to asc.
    Enum: "asc", "desc"

  - `from` (integer)
    Result offset from which to start. Defaults to 0.

  - `limit` (integer)
    Number of results to return per page. Defaults to 100, maximum 100 (values above 100 are silently clamped).
    Example: 100

## Response 200 fields (application/json):

  - `groups` (array)
    Groups on this page.

  - `groups.id` (string)
    Unique ID of the group.
    Example: "group-hooli-corporate"

  - `groups.name` (string)
    Display name of the group.
    Example: "Hooli Corporate"

  - `groups.type` (string)
    Enum: "security"

  - `groups.userCount` (integer)
    Number of users currently in this group.
    Example: 24

  - `groups.createdBy` (string,null)
    User-profile id of the group's creator.
    Example: "dc63db1b-1e63-43bc-877e-418931b6895c"

  - `groups.createdEpoch` (integer)
    Unix timestamp (ms) of creation.
    Example: 1734000000000

  - `groups.createdDate` (string,null)
    ISO 8601 creation date.
    Example: "2024-12-12T12:00:00.000Z"

  - `groups.lastUpdatedBy` (string,null)
    User-profile id of the last user to update the group.
    Example: "a5ae4577-8940-4ca9-bf2c-b1b65b4306ec"

  - `groups.lastUpdatedEpoch` (integer)
    Unix timestamp (ms) of the last update.
    Example: 1755600000000

  - `groups.lastUpdatedDate` (string,null)
    ISO 8601 last-updated date.
    Example: "2025-08-19T12:00:00.000Z"

  - `pageInfo` (object)

  - `pageInfo.from` (integer)
    Offset of the first result on this page.

  - `pageInfo.limit` (integer)
    Maximum number of results requested per page.

  - `pageInfo.total` (integer)
    Total number of groups matching the query.

  - `pageInfo.hasNextPage` (boolean)
    Whether more groups exist beyond this page (from +  < total).

## Response 400 fields (application/json):

  - `status` (string)
    Example: "error"

  - `message` (string)

## Response 401 fields (application/json):

  - `status` (string)
    Example: "error"

  - `message` (string)

## Response 403 fields (application/json):

  - `status` (string)
    Example: "error"

  - `message` (string)