---
updatedAt: 2026-04-27T15:52:51.000Z
agentTools:
  siteIndex: https://developer.paylocity.com/llms.txt
  projectIndex: https://developer.paylocity.com/integrations/llms.txt
---

# Get All Custom Fields

> :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

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "WebLink API",
    "description": "For documentation about this API, please visit https://developer.paylocity.com/integrations/reference/weblink-overview",
    "contact": {
      "email": "webservices@paylocity.com"
    },
    "version": "v2"
  },
  "servers": [
    {
      "url": "https://dc1demogw.paylocity.com/api"
    }
  ],
  "paths": {
    "/v2/companies/{companyId}/customfields/{category}": {
      "get": {
        "tags": [
          "Custom Fields"
        ],
        "summary": "Get All Custom Fields",
        "description": "> :construction: IMPORTANT!\n> 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) \n\n**Summary Description**\n\nGet All Custom Fields for the selected company",
        "x-explorer-enabled": false,
        "operationId": "Get All Custom Fields by category",
        "parameters": [
          {
            "name": "companyId",
            "in": "path",
            "description": "The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity.\r\n                **Allowable Values:**\r\n                9 char max",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "category",
            "in": "path",
            "description": "Custom Fields Category",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/customFieldDefinition"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {}
          },
          "403": {
            "description": "Forbidden",
            "content": {}
          },
          "404": {
            "description": "Invalid Category",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/error"
                  }
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests",
            "content": {}
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/error"
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "paylocity_auth": [
              "WebLinkAPI"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "error": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "The name of the field, or property in the request message that contains an error."
          },
          "message": {
            "type": "string",
            "description": "The error message."
          },
          "options": {
            "type": "array",
            "description": "A list of options associated with this error. These options may indicate valid values for the field, or property that contains an error.",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "The code associated with this option."
                },
                "description": {
                  "type": "string",
                  "description": "The description of the option."
                }
              },
              "description": "The error option model"
            }
          },
          "path": {
            "type": "string",
            "description": "The JSON path of the field, or property, that contains an error in the request message."
          }
        },
        "description": "The error model"
      },
      "customFieldDefinition": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string",
            "description": "The custom field category."
          },
          "defaultValue": {
            "type": "string",
            "description": "Specifies the default value of the custom field."
          },
          "isRequired": {
            "type": "boolean",
            "description": "Indicates whether the custom field is required."
          },
          "label": {
            "type": "string",
            "description": "The custom field label."
          },
          "type": {
            "type": "string",
            "description": "The custom field type."
          },
          "values": {
            "type": "array",
            "description": "A set of values that are applicable to the custom field.",
            "items": {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string",
                  "description": "The custom field code."
                },
                "description": {
                  "type": "string",
                  "description": "The custom field description."
                }
              },
              "description": ""
            }
          }
        },
        "description": ""
      }
    },
    "securitySchemes": {
      "paylocity_auth": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://api.paylocity.com/IdentityServer/connect/token",
            "scopes": {
              "WebLinkAPI": "Web Link Api"
            }
          }
        }
      }
    }
  },
  "x-original-swagger-version": "2.0"
}
```