Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Referral Form

referralForm.info

Fetches the default referral form or creates a default referral form if none exists.

Requires the hiringProcessMetadataRead permission.

post/referralForm.info

Request body

ReferralFormInfoRequest required

Response

Responses from the referralForm.info endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "ec0a6c43-c1f3-4d4e-92f9-9d9c7e6c8e8d",
    "organizationId": "5d3b8d24-2f4f-4f3a-8f3a-6c4b7d2e5b1a",
    "title": "Default Referral Form",
    "isArchived": false,
    "isDefaultForm": true,
    "formDefinition": {
      "sections": [
        {
          "fields": [
            {
              "isRequired": true,
              "field": {
                "id": "5c5d9b9e-5b3a-4f5b-9b7c-7e9c8a2d3e4f",
                "type": "String",
                "path": "_systemfield_name",
                "humanReadablePath": "Name",
                "title": "Name",
                "isNullable": false
              }
            },
            {
              "isRequired": true,
              "field": {
                "id": "a7b6c5d4-e3f2-4a1b-9c8d-7e6f5a4b3c2d",
                "type": "Email",
                "path": "_systemfield_email",
                "humanReadablePath": "Email",
                "title": "Email",
                "isNullable": false
              }
            }
          ]
        }
      ]
    }
  }
}