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.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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 .
Prerequisites
- Authentication: Basic or OAuth authentication
- Default access group
Resource information
| URI | v2/extendedFields |
| HTTP method | GET |
| Pagination supported | No |
| Rate limit | NA |
| Batch support | No |
Example request
curl -L 'https://eu.api.capillarytech.com/v2/extendedFields' \
-H 'Authorization: Basic ZmM2YjZlY2I2MmEy'Response parameters
| Field | Type | Description |
|---|---|---|
entity | object | The extended fields grouped by entity type. |
.id | integer | Unique identifier of the extended field. |
.name | string | Name of the field or attribute. |
.createdBy | integer | User ID who created the extended field. Value of -1 indicates system-created. |
.createdOn | string | Date when the extended field was created, in YYYY-MM-DD format. Deprecated — use createdOnISO instead. |
.createdOnISO | string | Date and time when the extended field was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ), returned in the server time zone. |
.modifiedBy | integer | User ID who last modified the extended field. Value of -1 indicates system-modified. |
.modifiedOn | string | Date when the extended field was last modified, in YYYY-MM-DD format. Deprecated — use modifiedOnISO instead. |
.modifiedOnISO | string | Date and time when the extended field was last modified in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ), returned in the server time zone. |
.label | string | Display label for the extended field (for example, Gender). |
.baseEntityType | string | The entity type the extended field belongs to. Possible values: customer, transaction, lineitem, profile, lead, company, card, usergroup2. |
.dataType | string | 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, LIST. |
.verticalId | integer | Vertical/industry ID this extended field belongs to. Default value is -1 (applies to all verticals). |
.parentId | integer | Parent extended field ID if this field is a child field. Default value is -1 (no parent). |
.possibleValues | array | List of possible values for enum-type and LIST-type extended fields. For LIST fields, this returns the allowed values configured in the field's metadata. |
.metadata | object | Metadata for the extended field. Returned for LIST type fields only; null for all other data types. |
..elementType | string | The data type for each element in the list. Possible values: TEXT, INTEGER, DECIMAL. |
..allowedValues | array | The allowed values for this list field. When set, only values in this list are accepted. Returns null if no constraint is configured. |
..minItems | integer | Minimum number of items required in the list. Returns null if no minimum is configured. |
..maxItems | integer | Maximum number of items allowed in the list. Returns null if no maximum is configured. |
warnings | array | List of warnings associated with the response. |
errors | array | List of errors associated with the response. |
success | boolean | Indicates if the operation was successful. |
Example response
{
"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
}Error and warning codes
| Code | Error number | Type | Description |
|---|---|---|---|
INVALID_ORG | — | error | The organization ID in the request is invalid. HTTP 400. |