---
title: "Find a form instance by ID"
method: GET
path: "/form-instances/{id}"
tags: ["Form Instances"]
---

# Find a form instance by ID

`GET /form-instances/{id}`

## Request

- Base URL: `https://api.intellihr.io`
- URL: `https://api.intellihr.io/form-instances/{id}`
- Auth: API key in header `Authorization`

Returns a single form instance.

## Parameters

- `#/parameters/resourceId` (unresolved $ref)

## Response `200`

Success

- FormInstances
  - `data` object
    - `type` string: The name of the data model that is being returned
    - `id` ResourceId (unresolved $ref)
    - `attributes` object
      - `accessCode` string: Secret code used to complete form without requiring a login
      - `formDesignId` ResourceId (unresolved $ref)
      - `formDesignVersion` integer: Version of the form design this [Form Instance](#tag/Form-Instances) was completed against
      - `issueDate` RfcDateTime (unresolved $ref)
      - `dueDate` RfcDateTime (unresolved $ref)
      - `subjectPersonId` ResourceId (unresolved $ref)
      - `subjectJobId` ResourceId (unresolved $ref)
      - `respondentPersonId` ResourceId (unresolved $ref)
      - `hasBeenOpened` boolean: A flag to say if the [Form Instnace](#tag/Form-Instances) has been opened
      - `openedAt` RfcDateTime (unresolved $ref)
      - `hasBeenCompleted` boolean: A flag to say if the [Form Instnace](#tag/Form-Instances) has been completed
      - `completedAt` RfcDateTime (unresolved $ref)
      - `isIgnored` boolean: A flag to say if the [Form Instnace](#tag/Form-Instances) was ignored
      - `ignoredAt` RfcDateTime (unresolved $ref)
      - `visibleToSubject` boolean: A flag to say if the [Form Instnace](#tag/Form-Instances) should be viewable by the subject
      - `shouldNotifyRespondent` boolean: A flag to say if the [Form Instnace](#tag/Form-Instances) will notify the respondent when completed
      - `createdAt` RfcDateTime (unresolved $ref)
      - `updatedAt` RfcDateTime (unresolved $ref)

## Other responses

- `500` (unresolved $ref)

---

[API](https://skmtc.dev/intellihr/apis/intellihr-public-api.md) · [All operations](https://skmtc.dev/intellihr/apis/intellihr-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/intellihr/apis/intellihr-public-api/revisions/6529279c999b?raw)