---
title: "referralForm.info"
method: POST
path: "/referralForm.info"
tags: ["Referral Form"]
---

# referralForm.info

`POST /referralForm.info`

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

**Requires the [`hiringProcessMetadataRead`](authentication#permissions-referralforminfo) permission.**

## Request body

- ReferralFormInfoRequest

## Response `200`

Responses from the referralForm.info endpoint

- union
  - ReferralFormInfoSuccessResponse
    - `success` true, required
    - `results` ReferralFormDefinition, required
      - `id` string, uuid, required — The unique identifier for the referral form
      - `organizationId` string, uuid, required — The id of the organization this form belongs to
      - `title` string, required — The title of the form
      - `isArchived` boolean, required — Whether the form is archived
      - `isDefaultForm` boolean, required — Whether this is the default referral form for the organization
      - `formDefinition` FormDefinition, required
        - `sections` FormDefinitionSection[], required — The sections in the form definition
          - `title` string, nullable — The section title
          - `descriptionHtml` string, nullable — The section description formatted as HTML
          - `descriptionPlain` string, nullable — The section description as plain text
          - `fields` FormDefinitionFieldEntry[], required — The fields in this form section
            - `isRequired` boolean, required — Whether this form field is required
            - `descriptionHtml` string, nullable — The field description formatted as HTML
            - `descriptionPlain` string, nullable — The field description as plain text
            - `field` FormDefinitionField, required
              - …
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)