List workflows
Returns the workflows available to your account.
curl -X GET "https://api.deepvue.link/v1/workflows?limit=50&offset=0" \
-H "Content-Type: application/json" \
-H "client-id: YOUR_API_KEY" \
-H "x-api-key: YOUR_API_KEY"
import requests
import json
url = "https://api.deepvue.link/v1/workflows?limit=50&offset=0"
headers = {
"Content-Type": "application/json",
"client-id": "YOUR_API_KEY",
"x-api-key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.deepvue.link/v1/workflows?limit=50&offset=0", {
method: "GET",
headers: {
"Content-Type": "application/json",
"client-id": "YOUR_API_KEY",
"x-api-key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.deepvue.link/v1/workflows?limit=50&offset=0", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("client-id", "YOUR_API_KEY")
req.Header.Set("x-api-key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.deepvue.link/v1/workflows?limit=50&offset=0')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['client-id'] = 'YOUR_API_KEY'
request['x-api-key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"data": [
{
"id": "e97e7d78-4ceb-4283-8080-5c5e0b72ddac",
"name": "Individual KYC",
"description": "PAN, e-Aadhaar and face match",
"published": true,
"run_ttl_seconds": 86400,
"abandon_timeout_seconds": 3600,
"created_at": "2026-06-01T10:00:00Z"
}
],
"total": 128,
"limit": 50,
"offset": 0
}
{
"error": "invalid limit"
}
{
"error": "missing credentials: send client-id + x-api-key headers"
}
{
"error": "invalid Deepvue credentials"
}
{
"error": "account_disabled"
}
{
"error": "Deepvue account not authorized for this surface"
}
GET
/v1/workflows
GET
Base URLstring
Target server for requests. Edit to use your own host.
API Key (header: client-id)
client-idstring
RequiredYour Deepvue client identifier.
Your Deepvue client identifier.
API Key (header: x-api-key)
x-api-keystring
RequiredYour Deepvue API key. Secret - keep it server-side.
Your Deepvue API key. Secret - keep it server-side.
query
limitinteger
Page size, 1–200.
Min: 1 • Max: 200
query
offsetinteger
Number of records to skip.
Min: 0
Request Preview
Response
Response will appear here after sending the request
Authentication
header
client-idstring
RequiredAPI Key for authentication. Your Deepvue client identifier.
header
x-api-keystring
RequiredAPI Key for authentication. Your Deepvue API key. Secret - keep it server-side.
Query Parameters
limitinteger
Page size, 1–200.
offsetinteger
Number of records to skip.
Responses
dataarray
Requiredtotalinteger
Requiredlimitinteger
Requiredoffsetinteger
RequiredWas this page helpful?