Company

Custom Field

Information about a single CustomField.

get/companies/{companyId}/customfields/{customFieldId}

Request

Base URL
https://api.paychex.com
Auth
none declared
TypeScript
https://skmtc.dev/paychex/apis/external-api/docs/companies/:companyId/customfields/:customFieldId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

companyIdstring required

ID associated with desired company.

customFieldIdstring required

ID associated with desired custom field.

Response

successful operation

Example response

{
  "content": {
    "customFieldId": "1040014203417589",
    "customFieldName": "Hobbies",
    "categoryId": "1040014179116276",
    "type": "DROPDOWN",
    "dropdown": [
      {
        "dropdownId": "1040014203453303",
        "dropdownValue": "Basketball",
        "dropdownDefault": true
      }
    ]
  }
}

Changes

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