List Flows

GET 
https://dashboardapi.voxtelesys.net/api/v1/flows

Endpoint for retrieving flows.

Request

Query Parameters

page integer
page number starting from one. Defaults to 1.
Example: 5
page_size integer
number of batches to retrieve per page. Defaults to 10.
Example: 50

Responses

200

application/json

Schema

Schema

pageinteger
Example: 1
page_sizeinteger
Example: 10
countinteger
Example: 1
results object[]
Array [
guidstring
Example: 05bee9e6-804c-4937-b10a-c3c752024eb5"
titlestring
Example: Example Flow
descriptionstring
Example: Example Flow for the Dashboard API.
live_version_guidstring
Example: e43cb6a3-e47b-4b67-9243-5282ef18b3f6
created_atdate-time
Example: 2024-09-05T16:49:11.000Z
updated_atdate-time
Example: 2024-11-05T20:47:05.000Z
last_saved_atdate-time
Example: 2024-11-05T20:47:05.000Z
]

Example (auto)

{
  "page": 1,
  "page_size": 10,
  "count": 1,
  "results": [
    {
      "guid": "05bee9e6-804c-4937-b10a-c3c752024eb5\"",
      "title": "Example Flow",
      "description": "Example Flow for the Dashboard API.",
      "live_version_guid": "e43cb6a3-e47b-4b67-9243-5282ef18b3f6",
      "created_at": "2024-09-05T16:49:11.000Z",
      "updated_at": "2024-11-05T20:47:05.000Z",
      "last_saved_at": "2024-11-05T20:47:05.000Z"
    }
  ]
}

Authorization: http

name: BearerAuthtype: httpscheme: bearer

• python
• curl
• csharp
• go
• nodejs
• ruby
• php
• java
• powershell
• dart
• javascript
• c
• objective-c
• ocaml
• r
• swift
• kotlin
• rust

• HTTP.CLIENT
• REQUESTS

import http.client

conn = http.client.HTTPSConnection("dashboardapi.voxtelesys.net")
payload = ''
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <token>'
}
conn.request("GET", "/api/v1/flows", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Base URL

https://dashboardapi.voxtelesys.net/api/v1

Auth

Bearer Token

Parameters

page — query

page_size — query