Test Type

Defines what test you want to perform on the candidates.

Index

Get a list of all test types

Request

GET /api/test-types
Host:          api.happyrmatch.com
Authorization: Bearer eyJ0eXAi1QiLCJ...
Accept:        application/vnd.api+json

Response

HTTP/1.0 200 OK
Cache-Control: no-cache, private
Content-Type:  application/vnd.api+json
Date:          Wed, 14 Sep 2022 05:38:55 GMT

{
    "data": [
        {
            "type": "test-type",
            "id": "cb3745b7-6d00-440e-aab8-bdb8b4be3174",
            "attributes": {
                "name": "Screening - Recommended",
                "visibility": "public"
            }
        },
        {
            "type": "test-type",
            "id": "6935c229-f665-4cf8-b575-d400565ea9eb",
            "attributes": {
                "name": "Screening - Culture",
                "visibility": "public"
            }
        }
    ]
}

The visibility parameter is either public or private. The private test type are test configurations the organization created themselves. They are not part of the "standard set" of tests.