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}}"

const page = {{page}};
const response = await fetch(`https://api.hookpulse.io/v1/api/get_workflow_template_paginated/?page=${page}`, {
  method: 'GET',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}'
  }
});

const data = await response.json();
console.log(data);

import requests

url = 'https://api.hookpulse.io/v1/api/get_workflow_template_paginated/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}'
}
params = {
    'page': {{page}}
}

response = requests.get(url, headers=headers, params=params)
print(response.json())

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.hookpulse.io/v1/api/get_workflow_template_paginated/')
uri.query = URI.encode_www_form({ page: {{page}} })
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'

response = http.request(request)
puts JSON.parse(response.body)

<?php

$page = {{page}};
$url = "https://api.hookpulse.io/v1/api/get_workflow_template_paginated/?page=" . urlencode($page);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
    'x-brand-uuid: {{x-brand-uuid}}'
]);

$response = curl_exec($ch);
curl_close($ch);

echo $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}}"
}

GET

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}}"

const page = {{page}};
const response = await fetch(`https://api.hookpulse.io/v1/api/get_workflow_template_paginated/?page=${page}`, {
  method: 'GET',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}'
  }
});

const data = await response.json();
console.log(data);

import requests

url = 'https://api.hookpulse.io/v1/api/get_workflow_template_paginated/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}'
}
params = {
    'page': {{page}}
}

response = requests.get(url, headers=headers, params=params)
print(response.json())

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.hookpulse.io/v1/api/get_workflow_template_paginated/')
uri.query = URI.encode_www_form({ page: {{page}} })
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'

response = http.request(request)
puts JSON.parse(response.body)

<?php

$page = {{page}};
$url = "https://api.hookpulse.io/v1/api/get_workflow_template_paginated/?page=" . urlencode($page);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
    'x-brand-uuid: {{x-brand-uuid}}'
]);

$response = curl_exec($ch);
curl_close($ch);

echo $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}}"
}

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}}"

const page = {{page}};
const response = await fetch(`https://api.hookpulse.io/v1/api/get_workflow_template_paginated/?page=${page}`, {
  method: 'GET',
  headers: {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}'
  }
});

const data = await response.json();
console.log(data);

import requests

url = 'https://api.hookpulse.io/v1/api/get_workflow_template_paginated/'
headers = {
    'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
    'x-brand-uuid': '{{x-brand-uuid}}'
}
params = {
    'page': {{page}}
}

response = requests.get(url, headers=headers, params=params)
print(response.json())

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.hookpulse.io/v1/api/get_workflow_template_paginated/')
uri.query = URI.encode_www_form({ page: {{page}} })
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'

response = http.request(request)
puts JSON.parse(response.body)

<?php

$page = {{page}};
$url = "https://api.hookpulse.io/v1/api/get_workflow_template_paginated/?page=" . urlencode($page);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
    'x-brand-uuid: {{x-brand-uuid}}'
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Query parameters

Parameter	Type	Required	Description
`page`	integer	Yes	Page 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

Field	Type	Description
`inserted_at`	string	ISO 8601 timestamp when the workflow template was created (in your brand’s selected timezone with offset)
`workflow_name`	string	Name of the workflow template
`workflow_uuid`	string	Unique identifier for the workflow template
`workflow_description`	string	Description of the workflow template
`runtype`	string	Execution mode: `"fifo_sequential"` for strict sequential order, or `"concurrently"` for parallel execution
`total_workflow_steps`	integer	Total number of steps configured in the workflow

Meta object

Field	Type	Description
`page`	integer	Current page number
`total_count`	integer	Total number of workflow templates
`per_page`	integer	Number of items per page
`total_pages`	integer	Total number of pages
`has_next`	boolean	Whether there is a next page
`has_prev`	boolean	Whether there is a previous page

Root fields

Field	Type	Description
`success`	boolean	Indicates if the request was successful
`data`	array	Array of workflow template objects
`meta`	object	Pagination metadata
`timezone`	string	IANA 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.

Workflow Template Overview - Learn about workflow templates, execution modes, and features
Add Workflow Template - Create a new workflow template

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

Show child attributes

About HookPulse

API Reference

System Secret Vault

Domain Setup

Webhook Template

Workflow Template

Scheduling

Human Approval

Get Workflow Template (Paginated)

Base URL

Example request

Query parameters

Example response

Response fields

Data array

Meta object

Root fields

Error Responses

Execution Modes

Authorizations

Query Parameters

Response

​Base URL

​Example request

​Query parameters

​Example response

​Response fields

​Data array

​Meta object

​Root fields

​Error Responses

​Execution Modes

​Related Documentation

Authorizations

Query Parameters

Response

Base URL

Example request

Query parameters

Example response

Response fields

Data array

Meta object

Root fields

Error Responses

Execution Modes

Related Documentation