Get custom fields categories

This section, though brief, is essential for effectively creating, updating, and retrieving custom fields.

In Connecteam, custom fields are organized into various categories based on the specific needs of your organization. This categorization allows for better management and streamlined access to relevant data.

When retrieving custom fields, you have the ability to filter based on the category IDs associated with those custom fields. This makes it easier to locate specific fields that are relevant to your ongoing projects or operational requirements.

When creating a new custom field, it is important to specify the category ID to which the new field will belong. This ensures that the custom field is properly aligned with your organizational structure and data management practices.

Similarly, when updating an existing custom field, you have the option to assign a new category ID. This allows for flexibility in reorganizing your custom fields to better reflect any changes in your organizational needs or processes.

Following the above, when retrieving category results you also have the option to filter your results by the category name. This feature enhances the search functionality, allowing you to quickly locate specific custom fields that meet your criteria.

URL with query params example for retrieving custom field categories request

http GET 'https://api.connecteam.com/users/v1/custom-field-categories?limit=20' 

Payload example for the response

{
  "requestId": "5d1d4303-95ca-220c-ce4d-94336366bbf5",
  "data": {
    "categories": [
      {
        "id": 1929550,
        "name": "Personal Details"
      },
      {
        "id": 1929551,
        "name": "Company Related Info"
      }
    ]
  },
  "paging": {
    "offset": 2
  }
}