Skip to main content
GET
/
v1
/
api
/
get_secrets_paginated
curl -X GET "https://api.hookpulse.io/v1/api/get_secrets_paginated/?page={{page}}" \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}"

{
  "data": [
    {
      "key": "{{key}}",
      "inserted_at": "{{inserted_at}}",
      "secret_uuid": "{{secret_uuid}}",
      "call_key": "{{ #key }}"
    },
    {
      "key": "{{key}}",
      "inserted_at": "{{inserted_at}}",
      "secret_uuid": "{{secret_uuid}}",
      "call_key": "{{ #key }}"
    }
  ],
  "meta": {
    "page": {{page}},
    "total_count": {{total_count}},
    "per_page": {{per_page}},
    "total_pages": {{total_pages}},
    "has_next": {{has_next}},
    "has_prev": {{has_prev}}
  },
  "success": true,
  "timezone": "{{timezone}}"
}
Retrieve a paginated list of all system secrets stored in your vault.

​
Base URL

All API requests should be made to: 
https://api.hookpulse.io

​
Example request

curl -X GET "https://api.hookpulse.io/v1/api/get_secrets_paginated/?page={{page}}" \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}"

​
Query parameters

ParameterTypeRequiredDescription
pageintegerYesPage number to retrieve (starts from 1)

​
Example response

{
  "data": [
    {
      "key": "{{key}}",
      "inserted_at": "{{inserted_at}}",
      "secret_uuid": "{{secret_uuid}}",
      "call_key": "{{ #key }}"
    },
    {
      "key": "{{key}}",
      "inserted_at": "{{inserted_at}}",
      "secret_uuid": "{{secret_uuid}}",
      "call_key": "{{ #key }}"
    }
  ],
  "meta": {
    "page": {{page}},
    "total_count": {{total_count}},
    "per_page": {{per_page}},
    "total_pages": {{total_pages}},
    "has_next": {{has_next}},
    "has_prev": {{has_prev}}
  },
  "success": true,
  "timezone": "{{timezone}}"
}

​
Response fields

​
Data array

FieldTypeDescription
keystringThe secret key name
inserted_atstringISO 8601 timestamp when the secret was created (in your brand’s selected timezone with offset)
call_keystringTemplate syntax to use this secret in webhooks (e.g., {{ #key }})
secret_uuidstringUnique identifier for the secret

​
Meta object

FieldTypeDescription
pageintegerCurrent page number
total_countintegerTotal number of secrets
per_pageintegerNumber of items per page
total_pagesintegerTotal number of pages
has_nextbooleanWhether there is a next page
has_prevbooleanWhether there is a previous page

​
Root fields

FieldTypeDescription
successbooleanIndicates if the request was successful
dataarrayArray of secret objects
metaobjectPagination metadata
timezonestringIANA timezone identifier indicating the timezone used for all timestamps in the response (matches your brand’s selected timezone)

​
Error Responses

If the page is out of range, you will receive: 
{
  "success": false,
  "timezone": "{{timezone}}",
  "error": "Page out of range",
  "meta": {
    "page": {{page}},
    "total_count": {{total_count}},
    "per_page": {{per_page}},
    "total_pages": {{total_pages}},
    "has_next": {{has_next}},
    "has_prev": {{has_prev}}
  }
}

Authorizations

​
x-hookpulse-api-key
string
header
required

API key for authentication. Get this from your dashboard by selecting a brand and going to API Keys section.

​
x-brand-uuid
string
header
required

Brand UUID for authentication. Get this from your dashboard after adding a brand - it will be displayed in the UI.

Query Parameters

​
page
integer<int32>
required

Page number to retrieve (starts from 1)

Required range: x >= 1

Response

Successful response

​
success
boolean

Indicates if the request was successful

​
data
object[]
​
meta
object
​
timezone
string

IANA timezone identifier indicating the timezone used for all timestamps in the response (matches your brand's selected timezone)