Retrieve Custom Attribute List: /settings/custom_attributes
GET
https://dev-api.exsited.com/api/v3/settings/custom_attributes
Try It Out
Purpose
This endpoint retrieves a paginated list of all custom attributes configured in the system, along with their metadata, usage contexts, and configuration details. It is useful for determining what additional fields are available for various entities (example: accounts, items, sales, purchases, custom objects).
Use Case
- Administrators can view all available custom attributes for configuration and reporting purposes.
- Developers can dynamically fetch attribute definitions to build UI forms or validate data before sending it to other endpoints.
- Integration scripts can map custom attributes between systems.
Path Parameters
No path parameter is required for this endpoint.
Query Parameters
No path parameter is required for this endpoint.
Request Body
No request body is required for this endpoint.
Response
The API returns a JSON object with two main parts: custom_attributes and pagination. Custom_attributes is an array of objects, each describing a custom attribute with its uuid, status, name, display_name, type, optional limits (min_value, max_value, max_length), usage contexts in use_in, selectable options for dropdowns, and encrypt_data status. Pagination provides record count, page size, offset, and links to previous or next pages.
Response Body
JSON
{
"custom_attributes": [
{
"uuid": "9eaaed94-45b6-4711-acd7-181f1c5505cd",
"status": "ACTIVE",
"name": "CA_Quantity",
"display_name": "CA Quantity",
"type": "QUANTITY",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "account",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "customObject",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "item",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchasePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseRefund",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "salePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleRefund",
"unique": "false",
"enabled": "true"
}
],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "cf0b8d55-d183-46ea-8685-820ccc0fae53",
"status": "ACTIVE",
"name": "CA_Money",
"display_name": "CA Money",
"type": "MONEY",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "account",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "customObject",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "item",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchasePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseRefund",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "salePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleRefund",
"unique": "false",
"enabled": "true"
}
],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "114688de-211c-490d-b1c8-f61644477c1c",
"status": "ACTIVE",
"name": "CA_String",
"display_name": "CA String",
"type": "STRING",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "account",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "customObject",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "item",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchasePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseRefund",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "salePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleRefund",
"unique": "false",
"enabled": "true"
}
],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "b4a5b82d-522d-40f8-9260-7826ebcb2118",
"status": "ACTIVE",
"name": "CA_Number",
"display_name": "CA Number",
"type": "NUMBER",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "account",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "customObject",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "item",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseOrderItem",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchasePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseRefund",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleOrderItem",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "salePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleRefund",
"unique": "false",
"enabled": "true"
}
],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "fa1d9d9d-b6da-408d-8666-7ca0c08a4cae",
"status": "ACTIVE",
"name": "CA_Dropdown",
"display_name": "CA Dropdown",
"type": "DROPDOWN",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "account",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "customObject",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "item",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchasePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseRefund",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "salePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleRefund",
"unique": "false",
"enabled": "true"
}
],
"options": [
{
"display_order": 0,
"name": "ABC"
},
{
"display_order": 1,
"name": "DEF"
},
{
"display_order": 2,
"name": "GHI"
},
{
"display_order": 3,
"name": "JKL"
}
],
"encrypt_data": "true"
},
{
"uuid": "2783d3d9-1415-4486-9572-187538c53126",
"status": "ACTIVE",
"name": "CA_Date_With_Time",
"display_name": "CA Date With Time",
"type": "DATE_TIME",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "account",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "item",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchasePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseRefund",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "salePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleRefund",
"unique": "false",
"enabled": "true"
}
],
"options": [],
"encrypt_data": "true"
},
{
"uuid": "ed5d4ef4-7c93-452e-9332-3554b23c698a",
"status": "ACTIVE",
"name": "Custom_Username",
"display_name": "Custom_Username",
"type": "STRING",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "b89575d9-4514-40db-83e6-39d888e762c3",
"status": "ACTIVE",
"name": "Custom_Email",
"display_name": "Custom_Email",
"type": "STRING",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "55072c29-0921-46aa-8b5c-bbba8b1a339d",
"status": "ACTIVE",
"name": "Custom_Image",
"display_name": "Custom_Image",
"type": "FILE",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [],
"options": [],
"encrypt_data": "true"
},
{
"uuid": "e7ac17c6-2da9-4182-a268-5bbf77299ac4",
"status": "ACTIVE",
"name": "ATP_Qty",
"display_name": "ATP Qty",
"type": "QUANTITY",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "customObject",
"unique": "false",
"enabled": "true"
}
],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "15dccfe6-3852-47b0-8877-9a3bb0eb1e9d",
"status": "ACTIVE",
"name": "Customer_Name",
"display_name": "Customer Name",
"type": "STRING",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "customObject",
"unique": "false",
"enabled": "true"
}
],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "2d69284f-0dfd-40f8-ad1f-48ccd11b23c1",
"status": "ACTIVE",
"name": "Customer_ID",
"display_name": "Customer ID",
"type": "STRING",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "customObject",
"unique": "false",
"enabled": "true"
}
],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "0ad7fe9b-07fc-4879-b1e5-d156f59c8d46",
"status": "ACTIVE",
"name": "Diagnosis",
"display_name": "Diagnosis",
"type": "STRING",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "6c7e70d2-60f8-4b84-976a-951395d76c93",
"status": "ACTIVE",
"name": "Admitted_Ward",
"display_name": "Admitted Ward",
"type": "DROPDOWN",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [],
"options": [
{
"display_order": 1,
"name": "General"
},
{
"display_order": 0,
"name": "ICU"
},
{
"display_order": 2,
"name": "Surgery"
}
],
"encrypt_data": "false"
},
{
"uuid": "c0babf10-4b20-4d1a-8ef8-23fff7b855e0",
"status": "ACTIVE",
"name": "Vitals_Recorded",
"display_name": "Vitals Recorded",
"type": "BOOLEAN",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [],
"options": [],
"encrypt_data": "true"
},
{
"uuid": "a9996920-d677-422e-828a-76e096c2e6f5",
"status": "ACTIVE",
"name": "Patient_ID",
"display_name": "Patient ID",
"type": "STRING",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "6b1010d9-187b-4b02-9ee5-38aa7cbec1a0",
"status": "ACTIVE",
"name": "Admission_Type",
"display_name": "Admission Type",
"type": "STRING",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "0d2a2aa7-90a5-46b9-a01d-09fe7e0027ea",
"status": "ACTIVE",
"name": "Patient_Name",
"display_name": "Patient Name",
"type": "TEXT",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [],
"options": [],
"encrypt_data": "false"
},
{
"uuid": "889b68b8-8156-4975-b80d-29b46b1bfb24",
"status": "ACTIVE",
"name": "Time",
"display_name": "Time",
"type": "DATE_TIME",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "customObject",
"unique": "false",
"enabled": "true"
}
],
"options": [],
"encrypt_data": "true"
},
{
"uuid": "9e5486ce-8a9c-4431-943f-3fb8027a9e0f",
"status": "ACTIVE",
"name": "Blood_Pressure",
"display_name": "Blood Pressure",
"type": "TEXT",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "customObject",
"unique": "false",
"enabled": "true"
}
],
"options": [],
"encrypt_data": "false"
}
],
"pagination": {
"records": 81,
"limit": 20,
"offset": 0,
"previous_page": "",
"next_page": "https://dev-api.exsited.com/api/v2/settings/custom_attributes?limit=20&offset=20"
}
}| Attribute | Type | Description |
|---|---|---|
uuid |
string | Unique identifier of the custom attribute. |
status |
string | Status of the custom attribute (ACTIVE, INACTIVE). |
name |
string | Internal name of the attribute (system reference). |
display_name |
string | User-friendly display name for the attribute. |
type |
string | Data type of the attribute (e.g., STRING, NUMBER, DATE_TIME, BOOLEAN, DROPDOWN, FILE). |
min_value |
string | Minimum value allowed (if applicable). Empty if not defined. |
max_value |
string | Maximum value allowed (if applicable). Empty if not defined. |
max_length |
string | Maximum character length (for string-based attributes). Empty if not defined. |
use_in |
array | List of usage contexts, showing in which resources/entities the attribute can be applied and any restrictions. |
options |
array | List of selectable options (for DROPDOWN type attributes), each containing a display_order and name. |
encrypt_data |
string | Whether data for this attribute is encrypted (true or false). |
Retrieve Specific Custom Attribute Details: /settings/custom_attributes/{CA_UUID}
GET
https://dev-api.exsited.com/api/v3settings/custom_attributes/{{CA_UUID}}
Try It Out
Purpose
This API retrieves detailed information about a specific custom attribute using its unique identifier (UUID).
Use Case
- Display details of a specific custom attribute in the UI.
- Validate or process data related to a particular custom attribute.
- Integrate custom attribute metadata into workflows, reports, or external systems.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
CA_UUID |
string | The unique identifier of the custom attribute to retrieve. |
Query Parameters
No path parameter is required for this endpoint.
Request Body
No request body is required for this endpoint.
Response
The API returns a JSON object containing a single custom_attribute object. This object provides detailed metadata about the specified custom attribute, including its uuid, status, system name, user-friendly display_name, and type (example: QUANTITY, STRING, DROPDOWN). Optional limits such as min_value, max_value, and max_length may be present depending on the type. The use_in array lists resources where the attribute is applicable, along with details like whether it is required, unique, enabled, and associated account/item/user groups. If the attribute is a dropdown, the options array contains its selectable values. The encrypt_data field indicates if the attribute’s data is encrypted.
Response Body
JSON
{
"custom_attribute": {
"uuid": "9eaaed94-45b6-4711-acd7-181f1c5505cd",
"status": "ACTIVE",
"name": "CA_Quantity",
"display_name": "CA Quantity",
"type": "QUANTITY",
"min_value": "",
"max_value": "",
"max_length": "",
"use_in": [
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "account",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "customObject",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "item",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchasePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "purchaseRefund",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleCreditNote",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleInvoice",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleOrder",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "salePayment",
"unique": "false",
"enabled": "true"
},
{
"associated_account_groups": [],
"associated_item_groups": [],
"associated_user_groups": [],
"required": "false",
"resource": "saleRefund",
"unique": "false",
"enabled": "true"
}
],
"options": [],
"encrypt_data": "false"
}
}| Attribute | Type | Description |
|---|---|---|
uuid |
string | Unique identifier of the custom attribute. |
status |
string | Current status of the attribute (e.g., ACTIVE). |
name |
string | System name of the custom attribute. |
display_name |
string | Human-readable name for display purposes. |
type |
string | Type of the custom attribute (e.g., STRING, NUMBER, QUANTITY, DROPDOWN, DATE_TIME, BOOLEAN, FILE, MONEY). |
min_value |
string | Minimum allowed value (if applicable). |
max_value |
string | Maximum allowed value (if applicable). |
max_length |
string | Maximum string length (if applicable). |
use_in |
array | List of resources where this attribute is used, with flags for required, unique, enabled, and associated groups. |
options |
array | Array of selectable values for dropdown attributes; empty if not applicable. |
encrypt_data |
string | Indicates whether the attribute’s data is encrypted (true or false). |