Get Custom Field Groups

Changed on
get/settings/custom_fields/group

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/settings/custom_fields/group
  • Auth
    API key in header x-api-key

Query parameters

sort'ASC' | 'DESC'
sort_by'order_no'
filter.keywordstring

search by group name

filter.module_name'JOB' | 'CUSTOMER' | 'EMPLOYEE' | 'ESTIMATE' | 'INVOICE' | 'PRODUCT' | 'PURCHASE_ORDER' | 'SERVICE_CONTRACT' | 'ASSET' | 'PROPERTY' | 'ORGANIZATION' | 'TEAM' | 'REQUEST' | 'PROJECT' required

Response

200

typestring

Example response

{
  "type": "success",
  "data": [
    {
      "module_name": "JOB",
      "group_name": "test doc",
      "group_uid": "dc8b378b-b11b-4bfe-aebf-841bf6cc022f",
      "order_no": 3,
      "created_at": "2025-05-09T12:45:54.174Z",
      "updated_at": "2025-05-09T12:45:54.174Z"
    }
  ]
}

Changes