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

{
  "data": [
    {
      "execution_plan_uuid": "{{execution_plan_uuid}}",
      "workflow_uuid": "{{workflow_uuid}}",
      "workflow_name": "{{workflow_name}}",
      "step_identifier": "{{step_identifier}}",
      "workflow_index": {{workflow_index}},
      "status": "waiting_approval",
      "human_approval_required": true,
      "delay_to_next_step": {{delay_to_next_step}},
      "inserted_at": "{{inserted_at}}"
    }
  ],
  "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}}"
}

Documentation Index

Fetch the complete documentation index at: https://docs.hookpulse.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a paginated list of all pending approvals for workflows that are waiting for human approval. Use this endpoint to view all execution plans that require manual approval before proceeding.

​
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_all_pending_approvals_paginated/?page=1" \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}"

​
Query parameters

ParameterTypeRequiredDescription
pageintegerNoPage number to retrieve (starts from 1, default: 1)

​
Example response

{
  "data": [
    {
      "execution_plan_uuid": "{{execution_plan_uuid}}",
      "workflow_uuid": "{{workflow_uuid}}",
      "workflow_name": "{{workflow_name}}",
      "step_identifier": "{{step_identifier}}",
      "workflow_index": {{workflow_index}},
      "status": "waiting_approval",
      "human_approval_required": true,
      "delay_to_next_step": {{delay_to_next_step}},
      "inserted_at": "{{inserted_at}}"
    }
  ],
  "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
execution_plan_uuidstringUnique identifier (UUID) for the execution plan
workflow_uuidstringUUID of the workflow template being executed
workflow_namestringName of the workflow template
step_identifierstringIdentifier of the current workflow step waiting for approval
workflow_indexintegerIndex/position of the workflow step
statusstringExecution status (always "waiting_approval" for pending approvals)
human_approval_requiredbooleanWhether human approval is required for this step
delay_to_next_stepintegerDelay in seconds before proceeding to the next step after approval
inserted_atstringISO 8601 timestamp when the execution plan was created (in your brand’s selected timezone with offset)

​
Meta object

FieldTypeDescription
pageintegerCurrent page number
total_countintegerTotal number of pending approvals
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 pending approval 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}}
  }
}

​
Use Cases

  • Review Pending Approvals: View all workflows waiting for human approval
  • Approval Dashboard: Build a dashboard to manage all pending approvals
  • Workflow Monitoring: Track which workflows are paused waiting for approval
  • Audit Trail: Review approval requests by creation date
  • Bulk Operations: Process multiple approvals efficiently

​
Sorting

Results are sorted by inserted_at in descending order, showing the most recently created pending approvals first.

​
Important Notes

  • Execution Plan UUID: Use the execution_plan_uuid field when calling the Human Approval Action endpoint
  • Workflow UUID: The workflow_uuid field identifies the workflow template that contains this execution plan
  • Sorted by Date: Results are sorted by inserted_at in descending order (newest first)

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>
default:1

Page number to retrieve (starts from 1)

Required range: x >= 1

Response

Successful response

​
data
object[]

Array of pending approval objects

​
meta
object
​
success
boolean

Indicates if the request was successful

​
timezone
string

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