# Search Credentials

This endpoint allows you list all your credentials or filter through given fields

Endpoint:

https://api.thehyperstack.com/v1/credentials/search

Method: POST

Header:

Authorization: Bearer #########

Authentication token can be obtained through Hyperstack Dashboard > Settings > API Access

// Leave body empty

{
  "recipient": {
    "name": "John Doe", 
  }
}

{
  "recipient": {
    "email": "[email protected]"
  }
}

{
  "group_key": "GcI6H5b66a3v"
}

{
  "custom_attributes": {
    "custom_location": "Mars"
  }
}

{
  "page": 2,
  "page_size": 10
}

{
  "success": true,
  "credentials": [
    {
      "document_id": "f1baf2f3-2f4f-4874-93c3-e6d9d874aa39",
      "document_url": "https://hyperstack.id/credential/f1baf2f3-2f4f-4874-93c3-e6d9d874aa39",
      "recipient": {
        "name": "John Doe",
        "email": "[email protected]"
      },
      "group": {
        "title": "Certificate of Course Completion",
        "key": "l1DdnE635Fs1",
        "code": "CC-BC"
      },
      "issued_on": "2023-03-01T00:00:00Z",
      "valid_until": "2024-03-25T00:00:00Z",
      "metadata": {},
      "status": "active"
    },
    {
      "document_id": "df624515-952d-4172-93c3-e6d9d874aa40",
      "document_url": "https://hyperstack.id/credential/df624515-952d-4172-93c3-e6d9d874aa40",
      "recipient": {
        "name": "William David",
        "email": "[email protected]"
      },
      "group": {
        "title": "Certificate of Course Completion",
        "key": "l1DdnE635Fs1",
        "code": "CC-BC"
      },
      "issued_on": "2023-03-01T00:00:00Z",
      "valid_until": "2024-03-25T00:00:00Z",
      "metadata": {},
      "status": "active"
    }
  ],
  "page": 1,
  "page_size": 50,
  "total": 2
}

{
  "success": false
}