---
title: "Get All Custom Fields"
method: GET
path: "/v2/companies/{companyId}/customfields/{category}"
tags: ["Custom Fields"]
---

# Get All Custom Fields

`GET /v2/companies/{companyId}/customfields/{category}`

## Request

- Base URL: `https://dc1demogw.paylocity.com/api`
- URL: `https://dc1demogw.paylocity.com/api/v2/companies/{companyId}/customfields/{category}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://api.paylocity.com/IdentityServer/connect/token` scopes: `WebLinkAPI`

> :construction: IMPORTANT!
> If your company is using the Unlimited Custom Fields platform, DO NOT USE THIS WEB LINK ENDPOINT.  Instead, please follow the bulk upload process described in PEAK article [PCTY-148055](https://paylocity.egain.cloud/system/templates/selfservice/pcty/help/agent/locale/en-US/portal/308600000001000/content-version/PCTY-148055/PCTY-1388429/Upload-Custom-Fields-in-Bulk) 

**Summary Description**

Get All Custom Fields for the selected company

## Path parameters

- `companyId` string, required
- `category` string, required

## Response `200`

Successfully retrieved

- CustomFieldDefinition[]
  - `category` string: The custom field category.
  - `defaultValue` string: Specifies the default value of the custom field.
  - `isRequired` boolean: Indicates whether the custom field is required.
  - `label` string: The custom field label.
  - `type` string: The custom field type.
  - `values` object[]: A set of values that are applicable to the custom field.
    - `code` string: The custom field code.
    - `description` string: The custom field description.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Invalid Category
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/paylocity/apis/weblink-api.md) - [All operations](https://skmtc.dev/paylocity/apis/weblink-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/weblink-api/revisions/8152ed40b412?raw)