PApaylocity
Custom Fields

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

Summary Description

Get All Custom Fields for the selected company

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

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max

categorystring required

Custom Fields Category

Response

Successfully retrieved

categorystring

The custom field category.

defaultValuestring

Specifies the default value of the custom field.

isRequiredboolean

Indicates whether the custom field is required.

labelstring

The custom field label.

typestring

The custom field type.

Changes

No recorded changes to this operation across all 1 revision of this API.