ZUzuper

Get Custom Fields

Changed on
get/settings/custom_fields

Request

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

Query parameters

module_name'JOB' | 'CUSTOMER' | 'EMPLOYEE' | 'ESTIMATE' | 'INVOICE' | 'PRODUCT' | 'PURCHASE_ORDER' | 'MATERIAL_REQUESTS' | 'VENDOR' | 'SERVICE_CONTRACT' | 'ASSET' | 'PROPERTY' | 'ORGANIZATION' | 'TEAM' | 'REQUEST' | 'PROJECT' required
include_original_templateboolean
sort'ASC' | 'DESC'
sort_by'display_order'

Response

200

typestring

Example response

{
  "type": "success",
  "data": [
    {
      "_id": "681e0368ec079d70d3fe87ab",
      "custom_field_uid": "b91e9a4e-2870-4e74-9484-37c252a035d6",
      "field_name": "test old custom fields",
      "field_type": "SINGLE_ITEM",
      "field_options": [
        "option 1"
      ],
      "internal_key": "job_test_old_custom_fields_1",
      "display_order": 1,
      "min_value": "2",
      "max_value": "4",
      "is_required": true
    }
  ]
}

Changes