Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Eligibility

Get eligibility questionnaire schema

Returns the JSON schema for the eligibility questionnaire by type.

The schema defines the structure and validation rules for the questionnaire responses. Supports versioning to allow for schema evolution while maintaining backwards compatibility.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View employments (employment:read)Manage employments (employment:write)
get/v1/contractors/schemas/eligibility-questionnaire

Query parameters

type'contractor_of_record' required
Example:contractor_of_record

Type of eligibility questionnaire

integer

Specific version number

OR
'latest'

Use latest version

Version of the form schema

Response

Success

Example response

{
  "data": {
    "permissions": {},
    "schema": {
      "properties": {
        "question_key1": {
          "type": "string"
        },
        "question_key2": {
          "type": "string"
        }
      },
      "required": [
        "question_key1",
        "question_key2"
      ],
      "type": "object"
    },
    "version": 1
  }
}