Skip to main content
POST
https://api.thehyperstack.com
/
v1
/
credentials
/
all
List All Credentials
curl --request POST \
  --url https://api.thehyperstack.com/v1/credentials/all \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": "[email protected]" },
      "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 retrieve all credentials issued by your organization, ordered by most recently published, with support for pagination.

Headers

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

Body Parameters

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 request was successful.
total
number
Total number of credentials issued by your organization.
credentials
array[object]
Array of credential objects. Each object contains:
  • document_id — unique credential ID
  • document_url — public URL of the credential
  • recipient — object with name and email
  • group — object with title, key, and code
  • issued_on — ISO 8601 timestamp
  • valid_until — ISO 8601 expiry timestamp, or null
  • metadata — custom attribute values
  • status"active", "suspended", "expired", "revoked", or "unpublished"
  • privacy"public" or "private"
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": "[email protected]" },
      "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"
    }
  ]
}
curl -X POST "https://api.thehyperstack.com/v1/credentials/all" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "page": 1,
    "page_size": 50
  }'
Last modified on February 22, 2026