Get submission list

GET

/submissions

Maintainer:Not configured

The endpoint provides a method to retrieve a list of candidate form submissions in the last 90 days.
If the request is successful, the response message is HTTP 200 OK, If there are no submissions to report the API should send an HTTP 204 No Content response.

Request

Authorization

Add parameter in header

API-Key

Example:

API-Key: ********************

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff '/submissions?API-Version={{api_version}}' \
--header 'API-Version: {{api_version}}' \
--header 'API-Key: <api-key>'

Responses

⚪0Get submission list

application/json

Bodyapplication/json

Example

{
    "submissions": [
        {
            "candidate_ref":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "submission_ref":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "date_submitted":"ISO-8601_date",
            "form_type":"form_type"
        }
    ]
}

Modified at 2024-08-09 12:15:15

Make final form submission (after uploading documents)

Retrieve submission result details