List workflow transition records

cURL

curl --request GET \
  --url https://api.ctrl-hub.com/v3/workflow-transition-records \
  --header 'X-Session-Token: <api-key>'

const options = {method: 'GET', headers: {'X-Session-Token': '<api-key>'}};

fetch('https://api.ctrl-hub.com/v3/workflow-transition-records', 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.ctrl-hub.com/v3/workflow-transition-records",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Session-Token: <api-key>"
  ],
]);

$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.ctrl-hub.com/v3/workflow-transition-records"

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

	req.Header.Add("X-Session-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ctrl-hub.com/v3/workflow-transition-records")

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

request = Net::HTTP::Get.new(url)
request["X-Session-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "workflow-transition-records",
      "attributes": {
        "revert": true,
        "note": "<string>",
        "from": {
          "id": "<string>",
          "name": "<string>",
          "status": "<string>"
        },
        "to": {
          "id": "<string>",
          "name": "<string>",
          "status": "<string>"
        }
      },
      "meta": {
        "duration": 123,
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "organisations"
          }
        },
        "definition": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "workflow-definitions"
          }
        },
        "definition_version": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "workflow-definition-versions"
          }
        },
        "instance": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "workflow-instances"
          }
        },
        "submission": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "form-submissions"
          }
        },
        "user": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "users"
          }
        }
      }
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "pagination": {
      "counts": {
        "pages": 1,
        "resources": 1
      },
      "current_page": 1,
      "offsets": {
        "next": null,
        "previous": null
      },
      "requested": {
        "limit": 10,
        "offset": 0
      }
    },
    "features": {
      "include": {
        "options": [
          "related.resource"
        ]
      }
    }
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "organisations",
      "attributes": {
        "name": "Acme Construction Ltd",
        "slug": "acme-construction",
        "sandbox": false,
        "description": "Leading construction company specializing in infrastructure projects",
        "settings": {
          "teams": {
            "customer_representatives": [
              "b234c567-8901-2345-6789-abcdef012345"
            ]
          }
        }
      },
      "meta": {
        "v3": true,
        "status": "active",
        "created_at": "2023-01-15T10:30:00.000Z",
        "updated_at": "2023-02-20T14:45:00.000Z",
        "features": [
          {
            "name": "advanced_reporting",
            "enabled": true,
            "limit": 1000
          }
        ]
      },
      "relationships": {
        "users": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "users"
            }
          ]
        },
        "service_accounts": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "service-accounts"
            }
          ]
        },
        "groups": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "groups"
            }
          ]
        },
        "teams": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "teams"
            }
          ]
        },
        "nomenclature": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "nomenclature"
          }
        }
      }
    }
  ]
}

{
  "id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
  "status": "400",
  "title": "A validation error was encountered",
  "source": {
    "parameter": "include"
  },
  "meta": {
    "resource": "wrong_value"
  }
}

{
  "id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
  "status": "401",
  "title": "You are not authorised to access this resource",
  "detail": "In order to access this resource, you need the 'admin' role.",
  "code": "AUTH.001"
}

{
  "id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
  "status": "500",
  "title": "Internal Server Error",
  "detail": "An unexpected error occurred on the server."
}

GET

workflow-transition-records

cURL

curl --request GET \
  --url https://api.ctrl-hub.com/v3/workflow-transition-records \
  --header 'X-Session-Token: <api-key>'

const options = {method: 'GET', headers: {'X-Session-Token': '<api-key>'}};

fetch('https://api.ctrl-hub.com/v3/workflow-transition-records', 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.ctrl-hub.com/v3/workflow-transition-records",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Session-Token: <api-key>"
  ],
]);

$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.ctrl-hub.com/v3/workflow-transition-records"

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

	req.Header.Add("X-Session-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ctrl-hub.com/v3/workflow-transition-records")

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

request = Net::HTTP::Get.new(url)
request["X-Session-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "workflow-transition-records",
      "attributes": {
        "revert": true,
        "note": "<string>",
        "from": {
          "id": "<string>",
          "name": "<string>",
          "status": "<string>"
        },
        "to": {
          "id": "<string>",
          "name": "<string>",
          "status": "<string>"
        }
      },
      "meta": {
        "duration": 123,
        "created_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "organisations"
          }
        },
        "definition": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "workflow-definitions"
          }
        },
        "definition_version": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "workflow-definition-versions"
          }
        },
        "instance": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "workflow-instances"
          }
        },
        "submission": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "form-submissions"
          }
        },
        "user": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "users"
          }
        }
      }
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "meta": {
    "pagination": {
      "counts": {
        "pages": 1,
        "resources": 1
      },
      "current_page": 1,
      "offsets": {
        "next": null,
        "previous": null
      },
      "requested": {
        "limit": 10,
        "offset": 0
      }
    },
    "features": {
      "include": {
        "options": [
          "related.resource"
        ]
      }
    }
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "organisations",
      "attributes": {
        "name": "Acme Construction Ltd",
        "slug": "acme-construction",
        "sandbox": false,
        "description": "Leading construction company specializing in infrastructure projects",
        "settings": {
          "teams": {
            "customer_representatives": [
              "b234c567-8901-2345-6789-abcdef012345"
            ]
          }
        }
      },
      "meta": {
        "v3": true,
        "status": "active",
        "created_at": "2023-01-15T10:30:00.000Z",
        "updated_at": "2023-02-20T14:45:00.000Z",
        "features": [
          {
            "name": "advanced_reporting",
            "enabled": true,
            "limit": 1000
          }
        ]
      },
      "relationships": {
        "users": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "users"
            }
          ]
        },
        "service_accounts": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "service-accounts"
            }
          ]
        },
        "groups": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "groups"
            }
          ]
        },
        "teams": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "teams"
            }
          ]
        },
        "nomenclature": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "nomenclature"
          }
        }
      }
    }
  ]
}

{
  "id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
  "status": "400",
  "title": "A validation error was encountered",
  "source": {
    "parameter": "include"
  },
  "meta": {
    "resource": "wrong_value"
  }
}

{
  "id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
  "status": "401",
  "title": "You are not authorised to access this resource",
  "detail": "In order to access this resource, you need the 'admin' role.",
  "code": "AUTH.001"
}

{
  "id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
  "status": "500",
  "title": "Internal Server Error",
  "detail": "An unexpected error occurred on the server."
}

Authorizations

X-Session-Token

string

header

required

Session token for authentication.

Query Parameters

limit

integer<int64>

default:100

Limit the number of resources returned by the API

Required range: x >= 1

offset

integer<int64>

default:0

Offset the resources returned by the API

Required range: x >= 0

include

enum<string>[]

A comma separated list of related resources to include.

Available options:

organisation,

user,

definition,

definition_version,

instance,

submission

filter

string

default:""

Filters the response data based on the value provided.

Available filters:

eq(id,xxx): Filter transition records by ID.
eq(organisation,xxx): Filter transition records by organisation ID.
eq(definition,xxx): Filter transition records by workflow definition ID.
eq(definition_version,xxx): Filter transition records by workflow definition version ID.
eq(instance,xxx): Filter transition records by workflow instance ID.
eq(form,xxx): Filter transition records by form ID.
eq(submission,xxx): Filter transition records by form submission ID.
eq(duration,xxx): Filter transition records by the number of minutes spent in the previous step.
eq(to.id,xxx): Filter transition records by the ID of the step transitioned to.
eq(to.name,xxx): Filter transition records by the name of the step transitioned to.
eq(to.status,xxx): Filter transition records by the status of the step transitioned to.
ge(created_at,xxx): Filter transition records created on or after a date and time.
le(created_at,xxx): Filter transition records created on or before a date and time.

The step transitioned from is not filterable.

For more information on using named filters, see the docs

sort

enum<string>[]

A comma separated list of fields to sort by.

Available options:

created_at,

-created_at,

duration,

-duration

Response

Get a list of workflow transition records

Document level meta about the resources on the server in list endpoints.

data

A list of workflow transition records · object[]

required

Show child attributes

jsonapi

object

required

Show child attributes