UTILITY

Fetches all data necessary to sync UDF configuration.

GET/api/v2/utility/udf-sync

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Responses

UDF sync data retrieved successfully.

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

REQUEST EXAMPLE

curl --request GET \
  'https://apiv2.crmseries.com/api/v2/utility/udf-sync' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "udfs": [
      {
        "udfid": 1024,
        "recordType": "string",
        "categoryId": 1024,
        "subCategoryId": 1024,
        "category": "string",
        "categorySortOrder": 1,
        "subCategory": "string",
        "subCategorySortOrder": 1,
        "fieldName": "string",
        "displayText": "string",
        "dataType": "string",
        "editable": true,
        "visible": true,
        "required": true,
        "complete": true,
        "deleted": false,
        "editCriteria": "string",
        "editRules": "string",
        "sortOrder": 1,
        "location": "string"
      }
    ],
    "categories": [
      {
        "categoryId": 1024,
        "recordType": "string",
        "category": "string",
        "sortOrder": 1,
        "deleted": false
      }
    ],
    "subCategories": [
      {
        "subCategoryId": 1024,
        "recordType": "string",
        "categoryId": 1024,
        "subCategory": "string",
        "sortOrder": 1,
        "deleted": false
      }
    ],
    "lookups": [
      {
        "udflookupId": 1024,
        "udfid": 1024,
        "value": "string",
        "groupName": "string",
        "sortOrder": 1,
        "deleted": false
      }
    ]
  },
  "errors": []
}