List workflows

Returns a paginated list of all automation workflows for the authenticated account. Each workflow includes a condensed index_report with engagement statistics.

Endpoint

HTTP method: GET

https://api.sender.net/v2/workflows

---

Parameters

Parameter	Type	Description
page	integer	Page number for pagination. Defaults to 1.
limit	integer	Number of results per page (1–100). Defaults to 10.
status	string	Filter by workflow status. Allowed values: DRAFT, ACTIVE, PAUSED.
title	string	Filter workflows whose title starts with this string.

---

Request Examples

JavaScript

const url = new URL("https://api.sender.net/v2/workflows");

let headers = {
    "Authorization": "Bearer [your-token]",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

PHP

$client = new \GuzzleHttp\Client();
$response = $client->get(
    'https://api.sender.net/v2/workflows',
    [
        'headers' => [
            'Authorization' => 'Bearer [your-token]',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);

$body = $response->getBody()->getContents();
$data = json_decode($body, true);
print_r($data);

Python

import requests
import json

url = "https://api.sender.net/v2/workflows"

headers = {
    "Authorization": "Bearer [your-token]",
    "Content-Type": "application/json",
    "Accept": "application/json",
}

response = requests.request('GET', url, headers=headers)

print(response.json())

Bash

curl -X GET \
-G "https://api.sender.net/v2/workflows" \
-H "Authorization: Bearer [your-token]" \
-H "Content-Type: application/json" \
-H "Accept: application/json"

---

Response

Example Response

{
  "data": [
    {
      "id": "abc123XY",
      "user_id": 42,
      "account_id": 7,
      "title": "Welcome Series",
      "status": "ACTIVE",
      "created": "2025-01-15 10:00:00",
      "modified": "2025-03-20 14:30:00",
      "emails_sent": 1200,
      "type": "automation",
      "description": "Onboarding sequence for new subscribers",
      "thumbnail": null,
      "workflow_category_id": 3,
      "index_report": {
        "sent": 1200,
        "opened": 480,
        "clicked": 96,
        "open_rate": 40,
        "click_rate": 8
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 3,
    "per_page": 10,
    "total": 25,
    "from": 1,
    "to": 10
  },
  "links": {
    "first": "https://app.sender.net/api/workflows?page=1",
    "last": "https://app.sender.net/api/workflows?page=3",
    "prev": null,
    "next": "https://app.sender.net/api/workflows?page=2"
  },
  "has_more_resources": true
}