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.

Example request

curl --location 'https://eu.api.capillarytech.com/api_gateway/v1/badges/customField' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'Authorization: Basic bWFkaHVfMjU2YQ==' \
--header 'Cookie: _cfuvid=.WgVCi5zQoIGi4K1C9BdZuw_u5XdPxOmzWrvi.sO9xA-1771420714759-0.0.1.1-604800000'

Prerequisites

Authentication: Basic or OAuth authentication
Default access group

Resource information


URI	/api_gateway/v1/badges/customField
HTTP method	GET
Pagination supported	Yes
Batch support	NA

Request query parameters

Parameter Name	Data Type	Description
size	Integer	Size of the page
page	Integer	The maximum number of results that should be displayed.
order	Enum	Order of the results in ascending or descending order. Supported values: ASC, DESC
sortOn	Enum	Sorting based on LAST_UPDATED_DATE. Supported value: LAST_UPDATED_DATE.
isActive	Boolean	Filter to sort the active custom field.

Example response

{
    "data": {
        "customFieldROList": [
            {
                "id": "6995bc2a306bcf780036c094",
                "orgId": 100737,
                "name": "CF32 date",
                "isMandatory": false,
                "defaultValue": "cgvhjb",
                "isActive": true,
                "dataType": "STRING",
                "createdOn": 1771420714.676000000,
                "createdOnISO": "2026-02-18T13:18:34Z",
                "createdBy": 75197372,
                "lastUpdatedOn": 1771496603.009000000,
                "lastUpdatedOnISO": "2026-02-19T10:23:23Z",
                "lastUpdatedBy": 75197372
            },
            {
                "id": "6995c19691e2b31c0d2a81db",
                "orgId": 100737,
                "name": "CF19 date",
                "isMandatory": false,
                "defaultValue": "",
                "isActive": true,
                "dataType": "STRING",
                "createdOn": 1771422102.365000000,
                "createdOnISO": "2026-02-18T13:41:42Z",
                "createdBy": 75197372,
                "lastUpdatedOn": 1771422102.365000000,
                "lastUpdatedOnISO": "2026-02-18T13:41:42Z",
                "lastUpdatedBy": 75197372
            },
            {
                "id": "6995bdbc91e2b31c0d2a81da",
                "orgId": 100737,
                "name": "CF18 date",
                "isMandatory": false,
                "defaultValue": "0",
                "isActive": true,
                "dataType": "STRING",
                "createdOn": 1771421116.329000000,
                "createdOnISO": "2026-02-18T13:25:16Z",
                "createdBy": 75197372,
                "lastUpdatedOn": 1771421116.329000000,
                "lastUpdatedOnISO": "2026-02-18T13:25:16Z",
                "lastUpdatedBy": 75197372
            },
            {
                "id": "6995bd90306bcf780036c096",
                "orgId": 100737,
                "name": "CF17 date",
                "isMandatory": false,
                "defaultValue": null,
                "isActive": true,
                "dataType": "STRING",
                "createdOn": 1771421072.736000000,
                "createdOnISO": "2026-02-18T13:24:32Z",
                "createdBy": 75197372,
                "lastUpdatedOn": 1771421072.736000000,
                "lastUpdatedOnISO": "2026-02-18T13:24:32Z",
                "lastUpdatedBy": 75197372
            },
            {
                "id": "69660bb80772ad476ecf1809",
                "orgId": 100737,
                "name": "CF31 date23",
                "isMandatory": false,
                "defaultValue": "cgvhjb",
                "isActive": true,
                "dataType": "STRING",
                "createdOn": 1768295352.346000000,
                "createdOnISO": "2026-01-13T09:09:12Z",
                "createdBy": 75197941,
                "lastUpdatedOn": 1768295588.086000000,
                "lastUpdatedOnISO": "2026-01-13T09:13:08Z",
                "lastUpdatedBy": 75197941
            },
            {
                "id": "691304658cbebe157550f64d",
                "orgId": 100737,
                "name": "Test CF 01",
                "isMandatory": true,
                "defaultValue": "0",
                "isActive": true,
                "dataType": "INTEGER",
                "createdOn": 1762853989.253000000,
                "createdOnISO": "2025-11-11T09:39:49Z",
                "createdBy": 75176138,
                "lastUpdatedOn": 1762853989.253000000,
                "lastUpdatedOnISO": "2025-11-11T09:39:49Z",
                "lastUpdatedBy": 75176138
            },
            {
                "id": "691303e68cbebe157550f64c",
                "orgId": 100737,
                "name": "Test CF",
                "isMandatory": true,
                "defaultValue": "null",
                "isActive": true,
                "dataType": "STRING",
                "createdOn": 1762853862.878000000,
                "createdOnISO": "2025-11-11T09:37:42Z",
                "createdBy": 75176138,
                "lastUpdatedOn": 1762853862.878000000,
                "lastUpdatedOnISO": "2025-11-11T09:37:42Z",
                "lastUpdatedBy": 75176138
            },
            {
                "id": "68c80d2e28a4f97c042c5daa",
                "orgId": 100737,
                "name": "CF 155",
                "isMandatory": false,
                "defaultValue": null,
                "isActive": true,
                "dataType": "STRING",
                "createdOn": 1757941038.711000000,
                "createdOnISO": "2025-09-15T12:57:18Z",
                "createdBy": 75176138,
                "lastUpdatedOn": 1762843579.904000000,
                "lastUpdatedOnISO": "2025-11-11T06:46:19Z",
                "lastUpdatedBy": 75176138
            },
            {
                "id": "6912db4c2814b4096eba9531",
                "orgId": 100737,
                "name": "CF 177",
                "isMandatory": true,
                "defaultValue": "0",
                "isActive": true,
                "dataType": "INTEGER",
                "createdOn": 1762843468.247000000,
                "createdOnISO": "2025-11-11T06:44:28Z",
                "createdBy": 75176138,
                "lastUpdatedOn": 1762843468.247000000,
                "lastUpdatedOnISO": "2025-11-11T06:44:28Z",
                "lastUpdatedBy": 75176138
            },
            {
                "id": "6912cb812814b4096eba9465",
                "orgId": 100737,
                "name": "CF 09",
                "isMandatory": true,
                "defaultValue": "null",
                "isActive": true,
                "dataType": "STRING",
                "createdOn": 1762839425.753000000,
                "createdOnISO": "2025-11-11T05:37:05Z",
                "createdBy": 75176138,
                "lastUpdatedOn": 1762839425.753000000,
                "lastUpdatedOnISO": "2025-11-11T05:37:05Z",
                "lastUpdatedBy": 75176138
            }
        ],
        "pagination": {
            "page": 0,
            "size": 10,
            "total": 18,
            "totalPages": 2
        }
    },
    "errors": [],
    "warnings": []
}

Response parameters

Parameter Name	Data Type	Description
id	String	The unique identifier of the custom field.
orgId	Integer	The org ID the custom field belongs to.
name	String	The name of the custom field.
isMandatory	Boolean	Indicates if the custom field is mandatory.
defaultValue	String	The default value of the custom field.
isActive	Boolean	Indicates if the custom field is active.
dataType	Enum	The data type of the custom field's value. Supported values: STRING, INTEGER, BOOLEAN, DATE.
createdOn	Date	The timestamp when the custom field was created.
createdOnISO	String	The timestamp when the custom field was created, in ISO 8601 format, is returned in the server time zone. EU server example 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC) India server example 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request.
createdBy	Integer	The identifier of the user who created the custom field.
lastUpdatedOn	Date	The timestamp when the custom field was last updated.
lastUpdatedOnISO	String	The timestamp when the custom field was last updated, in ISO 8601 format, is returned in the server time zone. EU server example 2025-12-16T14:30:45Z → 16 December 2025, 14:30:45 (UTC) India server example 2025-12-16T14:30:45+05:30 → 16 December 2025, 14:30:45 (IST) Note: The response time zone always matches the server time zone, regardless of the time zone offset in the request.
lastUpdatedBy	Integer	The identifier of the user who last updated the custom field.