Get Available Forms

GET

/forms-list

Maintainer:Not configured

The endpoint provides a method to retrieve the list of forms provided by the authenticated client. The requests are HTTP GET (RFC2616) and uses api key as a resource identifier identifying the
client uniquely at HB.

If there’s no forms assigned to your account, the API should send an HTTP 204 No Content response.

Request

Authorization

Add parameter in header

API-Key

Example:

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

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/forms-list' \
--header 'API-Version: {{api_version}}' \
--header 'API-Key: <api-key>'

Responses

⚪0Get Available Forms

application/json

Body

Example

{
    "count": 3,
    "forms": [
        {
            "form_id": "XX",
            "form_type": "XX",
            "form_name": "Annual Occupational Health"
        },
        {
            "form_id": "XX",
            "form_type": "XX",
            "form_name": "Clinical Occupational Health"
        },
        {
            "form_id": "XX",
            "form_type": "XX",
            "form_name": "Non-clinical Patient Facing Occupational Health"
        }
    ]
}

Modified at 2024-08-09 12:14:13

Get Candidate Training Report - Unassigned

Get Form Fields