Get Groups

Retrieve a paginated list of resource groups (saved groups) for your organization. Resource groups allow you to organize multiple resources together. You can filter groups by active status, search by group name or resource name, filter by resource types, and paginate through results. Each group includes its associated resources.

GET /v1/resource/group

Get Groups

cURL

curl --request GET \
  --url https://api.example.com/v1/resource/group

200

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Onboarding Resources",
      "active": true,
      "resources": [
        {
          "id": "507f1f77bcf86cd799439011",
          "name": "Identity Document",
          "type": "DOCUMENT",
          "active": true,
          "required": true,
          "internalId": "internal-resource-123"
        }
      ],
      "updatedAt": "2025-01-15T10:30:00Z",
      "description": "Resources required for employee onboarding"
    }
  ],
  "totalPages": 5
}

Query Parameters

pageIndex · number

Page number (0-indexed). Default is 0.

Example:

0

pageSize · number

Number of items per page. Minimum 5, maximum 100. Default is 20.

Required range: 5 <= x <= 100

Example:

20

active · boolean

Filter groups by active status. Accepts true/false as string or boolean.

Example:

true

search · string

Search query to filter groups by name or by resource names within groups. Case-insensitive partial match.

Example:

"onboarding"

types · enum<string>

Filter groups that contain resources of the specified type(s). Can be a single value or array. Valid values: CONSENT, FORM, DOCUMENT, PRODUCT.

Available options: CONSENT, FORM, DOCUMENT, PRODUCT

Response

200 - application/json

Successfully retrieved resource groups. Returns a paginated result with an array of group items (each containing its resources) and the total number of pages.

data · object[] · required

Array of resource groups matching the query parameters

Show child attributes

totalPages · number · required

Total number of pages available based on the page size and total count

Example:

5