---
title: "Custom Fields Categories"
method: GET
path: "/companies/{companyId}/customfieldscategories"
tags: ["Company"]
---

# Custom Fields Categories

`GET /companies/{companyId}/customfieldscategories`

## Request

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

Array of CustomFieldsCategories Configured at the company level

## Path parameters

- `companyId` string, required

## Response `200`

successful operation

- object
  - `metadata` MetadataResource
    - `contentItemCount` integer
    - `pagination` PaginationMetadataResource
      - `offset` integer
      - `limit` integer
      - `itemCount` integer
      - `total` integer
  - `content` CustomFieldsCategoryResource
    - `categoryId` string: The unique identifier that is autogenerated when creating a category
    - `categoryName` string: The name of the Category
    - `links` Link[]
      - `rel` string
      - `href` string
      - `hreflang` string
      - `media` string
      - `title` string
      - `type` string
      - `deprecation` string
      - `profile` string
      - `name` string
  - `links` Link[]
    - `rel` string
    - `href` string
    - `hreflang` string
    - `media` string
    - `title` string
    - `type` string
    - `deprecation` string
    - `profile` string
    - `name` string

## Other responses

- `401`: Unauthorized
- `403`: User doesn't have access to this endpoint (API-2), Client has been end dated (API-68)
- `404`: Invalid resource ID (API-7)
- `405`: Unsupported method type (API-59)
- `406`: Unsupported Accept header
- `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)