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

{
  "data": [
    {
      "inserted_at": "{{inserted_at}}",
      "workflow_name": "{{workflow_name}}",
      "workflow_uuid": "{{workflow_uuid}}",
      "workflow_description": "{{workflow_description}}",
      "runtype": "{{runtype}}",
      "total_workflow_steps": {{total_workflow_steps}}
    },
    {
      "inserted_at": "{{inserted_at}}",
      "workflow_name": "{{workflow_name}}",
      "workflow_uuid": "{{workflow_uuid}}",
      "workflow_description": "{{workflow_description}}",
      "runtype": "{{runtype}}",
      "total_workflow_steps": {{total_workflow_steps}}
    }
  ],
  "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 workflow templates in your HookPulse account.

​
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_workflow_template_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": [
    {
      "inserted_at": "{{inserted_at}}",
      "workflow_name": "{{workflow_name}}",
      "workflow_uuid": "{{workflow_uuid}}",
      "workflow_description": "{{workflow_description}}",
      "runtype": "{{runtype}}",
      "total_workflow_steps": {{total_workflow_steps}}
    },
    {
      "inserted_at": "{{inserted_at}}",
      "workflow_name": "{{workflow_name}}",
      "workflow_uuid": "{{workflow_uuid}}",
      "workflow_description": "{{workflow_description}}",
      "runtype": "{{runtype}}",
      "total_workflow_steps": {{total_workflow_steps}}
    }
  ],
  "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
inserted_atstringISO 8601 timestamp when the workflow template was created (in your brand’s selected timezone with offset)
workflow_namestringName of the workflow template
workflow_uuidstringUnique identifier for the workflow template
workflow_descriptionstringDescription of the workflow template
runtypestringExecution mode: "fifo_sequential" for strict sequential order, or "concurrently" for parallel execution
total_workflow_stepsintegerTotal number of steps configured in the workflow

​
Meta object

FieldTypeDescription
pageintegerCurrent page number
total_countintegerTotal number of workflow templates
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 workflow template 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}}
  }
}

​
Execution Modes

The runtype field indicates the execution mode of each workflow:
  • fifo_sequential: Steps execute in strict sequential order, with full support for all template variables
  • concurrently: Steps execute in parallel, with limited variable support (only system secrets are evaluated)
For more details about execution modes, see the Workflow Template Overview.

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

​
data
object[]

Array of workflow template 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)