---
title: "The published contract: names, labels, types, rules — what a caller sends"
method: GET
path: "/api/v1/custom-forms/{id}/parameters"
tags: ["Custom forms"]
---

# The published contract: names, labels, types, rules — what a caller sends

`GET /api/v1/custom-forms/{id}/parameters`

## Request

- Base URL: `https://philforms.com`
- URL: `https://philforms.com/api/v1/custom-forms/{id}/parameters`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-PDFPhile-Embed`

## Path parameters

- `id` string, required

## Response `200`

Contract

- Contract
  - `form_id` string
  - `name` string
  - `page_count` integer
  - `parameter` Parameter[]
    - `name` string
    - `label` string
    - `type` 'text' | 'name' | 'address' | 'tin' | 'date' | 'year' | 'month' | 'amount' | 'number' | 'percent' | 'zip' | 'phone' | 'email' | 'code' | 'checkbox' | 'choice' | 'signature' | 'table'
    - `format` string
    - `id_kind` string: tin, sss_no, philhealth_pin, pagibig_mid, gsis_bp, sss_or_crn, sss_gsis_no, employer_no, rdo_code, sec_reg_no
    - `expected` string
    - `is_core` boolean: part of the filer identity a filing cannot do without
    - `option` object[]
      - `value` string
      - `label` string
    - `cell_count` integer
  - `fill` string: The fill endpoint

## Other responses

- `404`: No such custom form
- `409`: Not published yet

---

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