Skip to main content
POST
Search Groups

Description

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

Headers

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

Body Parameters

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.
string
required
Alias for keyword. Filter groups by title.
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.
number
required
The page number for pagination (default is 1).
number
required
The number of groups to return per page (default is 50).

Success Response Fields

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

Responses

Last modified on February 22, 2026