---
title: "Get custom field categories"
method: GET
path: "/users/v1/custom-field-categories"
tags: ["Users:v1:Custom Field Categories"]
---

# Get custom field categories

`GET /users/v1/custom-field-categories`

Retrieves all custom fields categories associated with the account. Optionally, filter the results by category IDs and/or names.

## Query parameters

- `limit` integer — The maximum number of results to display per page
- `offset` integer — The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results
- `categoryIds` integer[] — Custom field category ids to filter by
- `categoryNames` string[] — Custom field category names to filter by
- `sort` 'id' | 'name' — An enumeration.
- `order` 'asc' | 'desc'

## Response `200`

Successful Response

- PaginatedBaseResponseCustomFieldCategoriesResponse
  - `requestId` string
  - `data` CustomFieldCategoriesResponse, required
    - `categories` CustomFieldCategory[], required — The custom fields categories
      - `id` integer, required — The category's id
      - `name` string, required — The category's name
  - `paging` PagingResponseModel, required
    - `offset` integer, required — The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results
    - `total` integer — Total number of resources matching the request, ignoring pagination. Use this to retrieve the full count without paginating through every page. Only populated by endpoints that compute it.

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/connecteam/apis/connecteam-api-documentation.md) · [All operations](https://skmtc.dev/connecteam/apis/connecteam-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/connecteam/connecteam-api-documentation/revisions/d8f7f302222e/schema)