---
title: "Worker Custom Field"
method: GET
path: "/workers/{workerId}/customfields/{workerCustomFieldId}"
tags: ["Worker"]
---

# Worker Custom Field

`GET /workers/{workerId}/customfields/{workerCustomFieldId}`

## Request

- Base URL: `https://api.paychex.com`
- URL: `https://api.paychex.com/workers/{workerId}/customfields/{workerCustomFieldId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/paychex/apis/external-api/docs/workers/:workerId/customfields/:workerCustomFieldId/get.ts> (a function with typed inputs; its response is checked against the schema)

Get the worker's customFields by workerCustomFieldId

## Path parameters

- `workerId` string, required
- `workerCustomFieldId` string, required

## Query parameters

- `asof` string

## Response `200`

Worker Custom field successfully returned

- object
  - `content` WorkerCustomFieldsResource
    - `workerCustomFieldId` string: The unique identifier that is autogenerated when a custom field is created
    - `customFieldId` string: client Custom Field Id
    - `type` 'DROPDOWN' | 'TEXT' | 'BOOLEAN' | 'DATE' | 'NUMERIC, NUMERIC__0_00_ OR NUMERIC__0_0000_': The type of field the custom field is
    - `booleanValue` boolean: The value for BOOLEAN type (true/false)
    - `textValue` string: The value for TEXT type (any text, alphanumeric, special characters allowed)
    - `numericValue` number: Numeric data type can have three formats namely - whole number, second decimal place and fourth decimal place, example: 12 , 12.34 or 12.3456
    - `dateValue` string, date-time: The value for DATE type , example : 2012-02-01T05:00:00Z
    - `dropdownId` string: The unique identifier that is autogenerated when dropdown list is created
    - `dropdownValue` string: The value for dropdown list
    - `customFieldName` string: The name of the custom field. Such as: "Hobbies"
    - `required` boolean: Where to indicate if the custom field is required on the worker where true = required and false = not required
    - `checkStub` boolean: Where to indicate if the custom field is required on the workers pay stub, where true = required and false = not required.
    - `employeeEditable` boolean: Where to indicate if the custom field is able to be edited by the employee, where true = required and false = not required.
  - `links` Link1[]
    - `href` string
    - `hreflang` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string
    - `templated` boolean

## Other responses

- `400`: The value for the one of the field is invalid
- `404`: Worker Custom fields not found
- `500`: Internal Server Error.

---

[API](https://skmtc.dev/paychex/apis/external-api.md) - [All operations](https://skmtc.dev/paychex/apis/external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paychex/apis/external-api/revisions/07161d3e073f?raw)