Skip to main content
POST
/
v1
/
credentials
/
search
Search Credentials
curl --request POST \
  --url https://api.thehyperstack.com/v1/credentials/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipient": {},
  "group_key": "<string>",
  "credential_key": "<string>",
  "custom_attributes": {},
  "start_date": "<string>",
  "end_date": "<string>",
  "page": 123,
  "page_size": 123
}
'
{
  "success": true,
  "total": 1,
  "page": 1,
  "page_size": 50,
  "credentials": [
    {
      "document_id": "j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
      "document_url": "https://hyperstack.id/credential/j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
      "recipient": { "name": "John Doe", "email": "john@example.com" },
      "group": { "title": "Cloud Certification", "key": "GcI6H5b66a3v", "code": "CC-2024" },
      "issued_on": "2024-03-15T10:30:00Z",
      "valid_until": null,
      "metadata": { "custom_location": "Mars" },
      "status": "active",
      "privacy": "public"
    }
  ]
}

​
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

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

​
Body Parameters

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

​
Success Response Fields

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

​
Responses

{
  "success": true,
  "total": 1,
  "page": 1,
  "page_size": 50,
  "credentials": [
    {
      "document_id": "j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
      "document_url": "https://hyperstack.id/credential/j4nDvaxF6ehodPXI84p4X1yhQe7lrYgx",
      "recipient": { "name": "John Doe", "email": "john@example.com" },
      "group": { "title": "Cloud Certification", "key": "GcI6H5b66a3v", "code": "CC-2024" },
      "issued_on": "2024-03-15T10:30:00Z",
      "valid_until": null,
      "metadata": { "custom_location": "Mars" },
      "status": "active",
      "privacy": "public"
    }
  ]
}
Last modified on February 22, 2026