---
title: "List forms"
method: GET
path: "/forms"
tags: ["Forms"]
---

# List forms

`GET /forms`

## Query parameters

- `owner_id` string
- `work_assignment_id` string
- `employee_id` string
- `form_batch_id` string
- `type` union
  - 'rl1' | 'roe' | 't4' | 't4a' | 'td1' | 'td1ab' | 'td1bc' | 'td1mb' | 'td1nb' | 'td1nl' | 'td1ns' | 'td1nt' | 'td1nu' | 'td1on' | 'td1pe' | 'td1sk' | 'td1x' | 'td1yt' | 'tp_1015_3_v' | 'tp_1015_r_13_v'
  - string[]
- `status` union
  - 'approved' | 'done' | 'draft' | 'processing' | 'rejected' | 'submitted'
  - string[]
- `owner_type` 'contractor' | 'employee' | 'work_assignment'
- `owner_name` string
- `created_at` object
- `fields` object[]
- `fields.*` string
- `fields.*.field` string, required
- `fields.*.value` string
- `sort` 'effective_date'
- `expand` string[]

## Response `200`

OK

- object
  - `object` string — The type of the object in Nmbr (`"list"`).
  - `data` object[]
    - `id` string — The unique identifier of the object in Nmbr.
    - `object` string — The type of the object in Nmbr (`"form"`).
    - `data` Form
      - `owner` object — The owner of this form. Can be a Work Assignment, Employee, or Contractor.
        - `id` string — The unique identifier of the object in Nmbr.
        - `object` string — The type of the object in Nmbr (`"work_assignment"`).
      - `form_batch` unknown
      - `stage` 'amendment' | 'cancellation' | 'original' — The lifecycle stage of this form: original, amendment, or cancellation.
      - `note` string, nullable — An optional note for this form.
      - `type` 'rl1' | 'roe' | 't4' | 't4a' | 'td1' | 'td1ab' | 'td1bc' | 'td1mb' | 'td1nb' | 'td1nl' | 'td1ns' | 'td1nt' | 'td1nu' | 'td1on' | 'td1pe' | 'td1sk' | 'td1x' | 'td1yt' | 'tp_1015_3_v' | 'tp_1015_r_13_v' — The type of form (e.g. T4, ROE, RL-1).
      - `effective_date` string, date — The effective date used to determine the form variant (e.g. the T4 tax year).
      - `version_year` string, nullable — The form variant's version year. New versions are typically released in January. Note: the version year may differ from the tax year. For example, income earned in the 2025 tax year is typically reported on a 2026 version of the T4.
      - `version_month` string, nullable — The month component of the form variant, for forms with monthly variants. `null` for annual forms.
      - `validation_error_count` number, nullable — The number of validation errors currently present in the form's fields.
      - `is_editable` boolean — Whether the form can be edited. Whether the form can currently be modified.
      - `line_1_basic_personal_amount` unknown
      - `line_2_infirm_children_caregiver_amount` unknown
      - `line_3_age_amount` unknown
      - `line_4_pension_income_amount` unknown
      - `line_5_tuition` unknown
      - `line_6_disability_amount` unknown
      - `line_7_spouse_or_common_law_partner_amount` unknown
      - `line_8_eligible_dependent_amount` unknown
      - `line_9_infirm_dependent_caregiver_amount` unknown
      - `line_10_dependent_caregiver_amount` unknown
      - `line_11_spouse_or_common_law_transfer_amount` unknown
      - `line_12_dependent_transfer_amount` unknown
      - `line_13_total_claim_amount` unknown
      - `more_than_one_employer_or_payer` unknown
      - `total_income_less_than_total_claim_amount` unknown
      - `ninety_percent_world_income_taxable_income` unknown
      - `prescribed_zone_deduction` unknown
      - `additional_tax_deduction` unknown
      - `created_at` string, dateTime — The date and time the object was created in Nmbr.
      - `updated_at` string, dateTime — The date and time the object was last updated in Nmbr.

---

[API](https://skmtc.net/nmbr/apis/nmbr-api.md) · [All operations](https://skmtc.net/nmbr/apis/nmbr-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nmbr/nmbr-api/versions/a0c7a815860f/schema)