List archived submission documents

curl --request GET \
  --url https://api.ctrl-hub.com/v3/form-submission-artefacts \
  --header 'X-Session-Token: <api-key>'

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

fetch('https://api.ctrl-hub.com/v3/form-submission-artefacts', 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/form-submission-artefacts",
  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/form-submission-artefacts"

	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/form-submission-artefacts")

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": "<string>",
      "attributes": {
        "content_type": "<string>",
        "size": 1,
        "error": "<string>"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "generated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "version": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "submission": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "form": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "counts": {
        "pages": 123,
        "resources": 123
      },
      "current_page": 123,
      "offsets": {
        "next": 123,
        "previous": 123
      },
      "requested": {
        "limit": 123,
        "offset": 123
      }
    },
    "features": {
      "include": {
        "options": [
          "<string>"
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

{
  "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."
}

Submissions

List archived submission documents

Retrieve the archived PDFs of submitted form submission versions.

Every submitted version gets one automatically, so this reports which versions have a document and whether it is ready yet. Filter by eq(submission,<id>) to answer that for a whole version list in one request, or by eq(version,<id>) for a single version.

A version with no record here has no document. That is the normal state for anything submitted before archiving was switched on, and it is distinguishable from a document that is still generating, which has a record with a pending status.

Authorised by the same view grants that govern reading the submissions themselves. An artefact carries no permissions of its own: it is the same information, in a different format.

Never paginated, and nothing is sideloaded. The response is the whole scoped set: a filter names one submission or one version, which bounds it to a handful of records, so there is nothing to page through and nothing is ever truncated. included is absent for the same reason a caller cannot ask for it: every relationship on an artefact is a resource the caller already had in hand when it named the scope.

GET

form-submission-artefacts

List archived submission documents

curl --request GET \
  --url https://api.ctrl-hub.com/v3/form-submission-artefacts \
  --header 'X-Session-Token: <api-key>'

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

fetch('https://api.ctrl-hub.com/v3/form-submission-artefacts', 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/form-submission-artefacts",
  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/form-submission-artefacts"

	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/form-submission-artefacts")

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": "<string>",
      "attributes": {
        "content_type": "<string>",
        "size": 1,
        "error": "<string>"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "generated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "organisation": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "version": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "submission": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "form": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "counts": {
        "pages": 123,
        "resources": 123
      },
      "current_page": 123,
      "offsets": {
        "next": 123,
        "previous": 123
      },
      "requested": {
        "limit": 123,
        "offset": 123
      }
    },
    "features": {
      "include": {
        "options": [
          "<string>"
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

{
  "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

sort

enum<string>[]

A comma separated list of fields to sort by. Defaults to newest first.

Available options:

created_at,

-created_at,

generated_at,

-generated_at

filter

string

default:""

Filters the response data based on the value provided.

Available filters:

version: Filter by the version the document is of, e.g. eq(version,<id>).
submission: Filter by submission, e.g. eq(submission,<id>). This is how a version list shows which of its versions have a document, in one request rather than one per version.
organisation: Filter by organisation, e.g. eq(organisation,<id>).
form: Filter by form, e.g. eq(form,<id>).
status: Filter by where generation has got to, e.g. eq(status,ready).
generated_at: Filter by when the document was written, e.g. ge(generated_at,2026-08-01T00:00:00Z).
created_at: Filter by when the record was first written, e.g. ge(created_at,2026-08-01T00:00:00Z).

For more information on using named filters, see the docs

Response

List of archived submission documents.

JSON API response object

data

A list of archived submission documents · object[]

required

Show child attributes