---
title: "Get employee creation form schema"
method: GET
path: "/v1/employees/dynamic-details/schema"
tags: ["Global Payroll Employee"]
---

# Get employee creation form schema

`GET /v1/employees/dynamic-details/schema`

## Request

- Base URL: `https://api.usemultiplier.com`
- URL: `https://api.usemultiplier.com/v1/employees/dynamic-details/schema`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/usemultiplier/apis/multiplier-public-rest-api/docs/v1/employees/dynamic-details/schema/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the form schema (field definitions and validation rules) needed to create an employee
under a specific employment context.

The schema describes required and optional fields, their types, validation constraints,
and allowed values for the given context.

**Context Types:**
- **GP Employment**: Provide `entity` to get the schema for a Global Payroll employee creation.

## Query parameters

- `employmentType` 'GLOBAL_PAYROLL', required: Type of employment context
- `entity` string

## Response `200`

Form schema retrieved successfully

- V1GetEmployeeDynamicDetailsSchemaResponse
  - `legalDetails` EmployeeSchemaSection, required
    - `required` boolean, required: Whether the section is required
    - `fields` FieldDefinition[], required: List of fields in the section
      - `key` string, required: Machine-readable field key
      - `label` string: Human-readable field label
      - `type` string, required: Definition type
      - `required` boolean, required: Whether the Definition is required
  - `customFields` EmployeeSchemaSection, required
    - `required` boolean, required: Whether the section is required
    - `fields` FieldDefinition[], required: List of fields in the section
      - `key` string, required: Machine-readable field key
      - `label` string: Human-readable field label
      - `type` string, required: Definition type
      - `required` boolean, required: Whether the Definition is required

## Other responses

- `400`: Invalid request parameters
- `401`: Authentication required
- `403`: Forbidden - insufficient permissions
- `422`: Unprocessable entity - validation error
- `500`: Internal server error

## Changes

- **2026-10-07** `1b78ff9be1d1`: 2 info
  - api tag `Global Payroll Employee` added
  - api tag `Create GP Employment` removed

[Operation history](https://skmtc.dev/usemultiplier/apis/multiplier-public-rest-api/changes/v1/employees/dynamic-details/schema/get.md)

---

[API](https://skmtc.dev/usemultiplier/apis/multiplier-public-rest-api.md) - [All operations](https://skmtc.dev/usemultiplier/apis/multiplier-public-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/usemultiplier/apis/multiplier-public-rest-api/revisions/da31bb6ec00d?raw)