Get custom field by ID

This API allows you to retrieve custom field details using custom field ID.

๐Ÿ‘

Note

For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .

Prerequisites

  • Authentication: Basic or OAuth authentication
  • Default access group

Resource information

URI/api_gateway/v1/badges/customField/{customFieldId}
HTTP methodGET
Pagination supportedNo
Rate limitNA
Batch supportNA

API endpoint example

https://eucrm.cc.capillarytech.com/api_gateway/v1/badges/customField/65bb3daffd3e324f2cac883c

Request path parameter

Parameter NameData TypeDescription
customFieldId*StringUnique ID of the custom field.

Response parameters

Parameter NameData TypeDescription
idStringThe unique identifier of the custom field.
orgIdIntegerThe org ID the custom field belongs to.
nameStringThe name of the custom field.
isMandatoryBooleanIndicates if the custom field is mandatory.
defaultValueStringThe default value of the custom field.
isActiveBooleanIndicates if the custom field is active.
dataTypeEnumThe data type of the custom field's value.
createdOnDateThe timestamp when the custom field was created. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ.
createdByIntegerThe identifier of the user who created the custom field.
lastUpdatedOnDateThe timestamp when the custom field was last updated. Timestamp in the ISO 8601 standard format format YYYY-MM-DDTHH:MM:SS.SSSZ.
lastUpdatedByIntegerThe identifier of the user who last updated the custom field.
errorsObjectA list of errors if any occurred during the operation.
warningsObjectA list of warnings if any occurred during the operation.
{
    "data": {
        "id": "65bb3daffd3e324f2cac883c",
        "orgId": 100606,
        "name": "CF3 date",
        "isMandatory": true,
        "defaultValue": "2001-01-18T09:09:09Z",
        "isActive": true,
        "dataType": "DATE",
        "createdOn": 1706769839.918000000,
        "createdBy": 75097962,
        "lastUpdatedOn": 1706769839.918000000,
        "lastUpdatedBy": 75097962
    },
    "errors": [],
    "warnings": []
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!