Get Org Extended Fields

get

https://{host}/v2/extendedFields

Retrieves the details of all extended fields configured for the organization. You can see the extended fields for each category.

You can view the list of extended fields enabled for an organization.

👍
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 .

API endpoint example

curl -L 'https://eu.api.capillarytech.com/v2/extendedFields' \
-H 'Authorization: Basic ZmM2YjZlY2I2MmEy' \
-H 'Cookie: _cfuvid=u0sVGw6HhMi4jrkaxDC9PW4aHy3U6fR1KVVhPJa5TXc-1767768873378-0.0.1.1-604800000'

Response parameters

Parameter	Description
entity	The entity or category of the extended field.
.id	Unique identifier of the extended field.
.name	Name of the field or attribute.
.createdBy	User ID who created the extended field. Value of -1 indicates system-created.
.createdOn	Date when the extended field was created, formatted as "YYYY-MM-DD". Note: This field will be deprecated in the future and is being replaced by createdOnISO.
.createdOnISO	Indicates the date and time when the extended field was created in ISO 8601 format, returned in the server timezone. 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)
.modifiedBy	User ID who last modified the extended field. Value of -1 indicates system-modified.
.modifiedOn	Date when the extended field was last modified, formatted as "YYYY-MM-DD". Note: This field will be deprecated in the future and is being replaced by modifiedOnISO.
.modifiedOnISO	Indicates the date and time when the extended field was modified in ISO 8601 format, returned in the server timezone. 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)
.label	Display label for the extended field (e.g., "Gender").
.baseEntityType	The entity or category of the extended field. Possible values: `customer`, `transaction`, `lineitem`, `profile`, `lead`, `company`, `card`, `usergroup2`.
.dataType	Data type of the extended field. Possible values: "INTEGER", "STRING", "DOUBLE", "DATETIME", "STANDARD_STRING", "STANDARD_ENUM", "CUSTOM_ENUM", "ASSOCIATE_USER", "COUNTRY", "CURRENCY", "LANGUAGE", "ORG_ENTITY", "DATE", "CARD", "STRING_SET".
.verticalId	Vertical/industry ID this extended field belongs to. Default value is -1 (applies to all verticals).
.parentId	Parent extended field ID if this field is a child field. Default value is -1 (no parent).
.possibleValues	List of possible values for enum-type extended fields.
warnings	List of warnings associated with the response.
errors	List of errors associated with the response.
success	Boolean indicating if the operation was successful (`true` or `false`).

{
    "entity": {
        "card": [
            {
                "id": 513,
                "name": "custom_card_name",
                "createdBy": 0,
                "createdOn": "2021-07-02",
                "createdOnISO": "2021-07-02T06:27:27Z",
                "modifiedBy": 0,
                "modifiedOn": "2021-07-02",
                "modifiedOnISO": "2021-07-02T06:27:27Z",
                "label": "Custom Card Name",
                "baseEntityType": "card",
                "dataType": "STRING",
                "verticalId": -1,
                "parentId": -1
            }
        ],
        "customer": [
            {
                "id": 7,
                "name": "gender",
                "createdBy": -1,
                "createdOn": "2017-04-14",
                "createdOnISO": "2017-04-14T16:46:07Z",
                "modifiedBy": -1,
                "modifiedOn": "2017-04-14",
                "modifiedOnISO": "2017-04-14T16:46:07Z",
                "label": "Gender",
                "baseEntityType": "customer",
                "dataType": "STANDARD_ENUM",
                "verticalId": -1,
                "parentId": -1,
                "possibleValues": ["Female", "Male", "Other"]
            }
        ],
        "transaction": [
            {
                "id": 14,
                "name": "ship_first_name",
                "createdBy": -1,
                "createdOn": "2017-04-14",
                "createdOnISO": "2017-04-14T16:46:07Z",
                "modifiedBy": -1,
                "modifiedOn": "2017-05-19",
                "modifiedOnISO": "2017-05-19T17:04:40Z",
                "label": "Shipping First Name",
                "baseEntityType": "transaction",
                "dataType": "STRING",
                "verticalId": 2,
                "parentId": -1
            }
        ],
        "lineitem": [
            {
                "id": 1,
                "name": "MetalRate",
                "createdBy": -1,
                "createdOn": "2017-04-14",
                "createdOnISO": "2017-04-14T16:46:07Z",
                "modifiedBy": -1,
                "modifiedOn": "2017-04-14",
                "modifiedOnISO": "2017-04-14T16:46:07Z",
                "label": "Metal Rate",
                "baseEntityType": "lineitem",
                "dataType": "DOUBLE",
                "verticalId": 1,
                "parentId": -1
            }
        ],
        "usergroup2": [
            {
                "id": 695,
                "name": "ug_status",
                "createdBy": 0,
                "createdOn": "2025-12-13",
                "createdOnISO": "2025-12-13T02:12:36Z",
                "modifiedBy": 0,
                "modifiedOn": "2025-12-13",
                "modifiedOnISO": "2025-12-13T02:12:36Z",
                "label": "Ug Status",
                "baseEntityType": "usergroup2",
                "dataType": "STRING",
                "verticalId": -1,
                "parentId": -1
            }
        ]
    },
    "warnings": [],
    "errors": [],
    "success": true
}

Language

Credentials

Basic

base64

URL

Click Try It! to start a request and see the response here!