Skip to main content
POST
/
v1
/
groups
/
search
Search Groups
curl --request POST \
  --url https://api.thehyperstack.com/v1/groups/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "keyword": "<string>",
  "title": "<string>",
  "strict": true,
  "page": 123,
  "page_size": 123
}
'
{
  "success": true,
  "total": 2,
  "page": 1,
  "page_size": 50,
  "groups": [
    {
      "title": "Certificate of Security Course Completion",
      "group_key": "Zvw1xPIqF7J7",
      "group_code": "SCC-2023",
      "last_modified": "2023-08-21T08:25:25.930Z",
      "created_at": "2022-08-07T14:09:43.311Z"
    },
    {
      "title": "Certificate of Cloud Management",
      "group_key": "l2DdnE614Fs2",
      "group_code": "CM-1",
      "last_modified": "2023-08-21T08:25:25.930Z",
      "created_at": "2022-08-07T14:09:43.311Z"
    }
  ]
}

​
Description

This endpoint allows you to list all credential groups or filter them based on title and pagination.

​
Headers

​
Authorization
string
required
Bearer YOUR_API_TOKEN — obtainable from Hyperstack Dashboard → Settings → API Access

​
Body Parameters

​
keyword
string
required
Search keyword matched against group titles. Takes precedence over title if both are provided. Partial word matches are supported unless strict is enabled.
​
title
string
required
Alias for keyword. Filter groups by title.
​
strict
boolean
required
When true, the entire keyword must appear as a contiguous phrase in the title. When false (default), any word in the keyword can match independently.
​
page
number
required
The page number for pagination (default is 1).
​
page_size
number
required
The number of groups to return per page (default is 50).

​
Success Response Fields

​
success
boolean
Indicates whether the group search was successful.
​
groups
array[object]
An array of credential group objects matching the search criteria.
​
page
number
Current page number in the results.
​
page_size
number
Number of groups returned per page.
​
total
number
Total number of groups matching the search.

​
Responses

{
  "success": true,
  "total": 2,
  "page": 1,
  "page_size": 50,
  "groups": [
    {
      "title": "Certificate of Security Course Completion",
      "group_key": "Zvw1xPIqF7J7",
      "group_code": "SCC-2023",
      "last_modified": "2023-08-21T08:25:25.930Z",
      "created_at": "2022-08-07T14:09:43.311Z"
    },
    {
      "title": "Certificate of Cloud Management",
      "group_key": "l2DdnE614Fs2",
      "group_code": "CM-1",
      "last_modified": "2023-08-21T08:25:25.930Z",
      "created_at": "2022-08-07T14:09:43.311Z"
    }
  ]
}
Last modified on February 22, 2026