Skip to main content
POST
Search Credentials

Description

This endpoint allows you to search and filter credentials based on recipient details, group key, credential key, custom attributes, date range, and pagination.

Headers

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

Body Parameters

object
required
Filter by recipient details. Can include:
  • name — recipient’s name (partial match)
  • email — recipient’s email (partial match)
string
required
Filter credentials by credential group key (partial match).
string
required
Filter by a specific credential key (partial match).
object
required
Filter by custom attributes stored with the credentials.
string
required
Filter credentials issued on or after this date. Format: YYYY/MM/DD.
string
required
Filter credentials issued on or before this date. Format: YYYY/MM/DD. Must be used together with start_date.
number
required
The page number for pagination (default is 1).
number
required
The number of credentials to return per page (default is 50).

Success Response Fields

boolean
Indicates whether the credential search was successful.
array[object]
An array of credential objects matching the search criteria. Each object contains the same fields as the View Credential response.
number
Total number of credentials matching the search criteria.
number
Current page number.
number
Number of credentials returned per page.

Responses

Last modified on February 22, 2026