Get all custom fields

This API allows you to retrieve all custom field details for the org.

๐Ÿ‘

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
HTTP methodGET
Pagination supportedYes
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.

Request query parameters

Parameter NameData TypeDescription
sizeIntegerSize of the page
pageIntegerThe maximum number of results that should be displayed.
orderEnumOrder of the results in ascending or decending order. Supported values: ASC, DESC
sortOnEnumSorting based on LAST_UPDATED_DATE. Supported value: LAST_UPDATED_DATE.
isActiveBooleanFilter to sort active 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. Supported values: STRING, INTEGER, BOOLEAN, DATE.
createdOnDateThe timestamp when the custom field was created.
createdByIntegerThe identifier of the user who created the custom field.
lastUpdatedOnDateThe timestamp when the custom field was last updated.
lastUpdatedByIntegerThe identifier of the user who last updated the custom field.
{
    "data": {
        "customFieldROList": [
            {
                "id": "65bb3d6afd3e324f2cac8839",
                "orgId": 100606,
                "name": "CF1",
                "isMandatory": true,
                "defaultValue": "CF1 value",
                "isActive": true,
                "dataType": "STRING",
                "createdOn": 1706769770.082000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1706769770.082000000,
                "lastUpdatedBy": 75097962
            },
            {
                "id": "65bb3d8afd3e324f2cac883a",
                "orgId": 100606,
                "name": "CF2 INTEGER",
                "isMandatory": true,
                "defaultValue": "1",
                "isActive": true,
                "dataType": "INTEGER",
                "createdOn": 1706769802.754000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1706769802.754000000,
                "lastUpdatedBy": 75097962
            },
            {
                "id": "65bb3d9bfd3e324f2cac883b",
                "orgId": 100606,
                "name": "CF3 boolean",
                "isMandatory": true,
                "defaultValue": "true",
                "isActive": true,
                "dataType": "BOOLEAN",
                "createdOn": 1706769819.236000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1706769819.236000000,
                "lastUpdatedBy": 75097962
            },
            {
                "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
            },
            {
                "id": "65cda4fda888ce70acd29378",
                "orgId": 100606,
                "name": "CF15 date",
                "isMandatory": false,
                "defaultValue": "",
                "isActive": true,
                "dataType": "STRING",
                "createdOn": 1707975933.629000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1707975933.629000000,
                "lastUpdatedBy": 75097962
            },
            {
                "id": "65bb446bfd3e324f2cac8871",
                "orgId": 100606,
                "name": "CF31 date",
                "isMandatory": false,
                "defaultValue": "cgvhjb",
                "isActive": true,
                "dataType": "STRING",
                "createdOn": 1706771563.483000000,
                "createdBy": 75097962,
                "lastUpdatedOn": 1707979249.788000000,
                "lastUpdatedBy": 75097962
            }
        ],
        "pagination": {
            "page": 0,
            "size": 50,
            "total": 6,
            "totalPages": 1
        }
    },
    "errors": [],
    "warnings": []
}
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!