Skip to main content
GET
/
transform
/
v1
/
workflows
cURL
curl --request GET \
  --url https://api.invopop.com/transform/v1/workflows \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.invopop.com/transform/v1/workflows"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.invopop.com/transform/v1/workflows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.invopop.com/transform/v1/workflows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.invopop.com/transform/v1/workflows"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.invopop.com/transform/v1/workflows")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.invopop.com/transform/v1/workflows")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "created_at": "<string>",
  "limit": 123,
  "list": [
    {
      "country": "<string>",
      "created_at": "<string>",
      "description": "<string>",
      "disabled": true,
      "draft": true,
      "hash": "<string>",
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "name": "<string>",
      "rescue": [
        {
          "action": "email.send",
          "config": {},
          "id": "186522a6-e697-4e34-8498-eee961bcb845",
          "name": "<string>",
          "next": [
            {
              "code": "<string>",
              "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
              "steps": "<array>",
              "stop": true
            }
          ],
          "notes": "<string>",
          "summary": "<string>"
        }
      ],
      "schema": "<string>",
      "steps": [
        {
          "action": "email.send",
          "config": {},
          "id": "186522a6-e697-4e34-8498-eee961bcb845",
          "name": "<string>",
          "next": [
            {
              "code": "<string>",
              "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
              "steps": "<array>",
              "stop": true
            }
          ],
          "notes": "<string>",
          "summary": "<string>"
        }
      ],
      "updated_at": "<string>",
      "version": "<string>",
      "versions": [
        {
          "created_at": "<string>",
          "hash": "<string>",
          "name": "<string>",
          "src": "<string>",
          "src_id": "<string>",
          "version": "<string>"
        }
      ]
    }
  ],
  "next_created_at": "<string>",
  "schema": "bill/invoice"
}

Authorizations

Authorization
string
header
required

Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>

Query Parameters

limit
integer

Maximum number of workflows to return.

Example:

100

created_at
string

Date from which results are provided.

Example:

"2023-08-02T00:00:00.000Z"

schema
string

Short schema name that the workflow will be allowed to process.

Example:

"bill/invoice"

Response

200 - application/json

OK

created_at
string

First or queried timestamp when the first entry in the page was created.

limit
integer

Maximum number of objects returned in a page.

list
List · object[] | null

List of workflows.

next_created_at
string

Timestamp that indicates the start of the next page of results, if any.

schema
string

Short schema name that the workflows have been filtered by.

Example:

"bill/invoice"