List Custom Fields

To list the user defined custom fields.

List custom fields

Below is a sample cURL to list custom fields.

188B

sample_curl - list_custom_fields.txt

POST{{apiUrl}}custom_fields/list_user_custom_fields

Request Body

Name	Type	Description
apikey*	String	Authentication token
module	String	Type of module, Valid module are: sales and customers. if not provided all module fields are listed,

OK Success

{
    "status_code": "1",
    "status_message": "Success",
    "datetime": "2024-09-30 17:04:42",
    "data": [
        {
            "id": "oyESErpn5eM/lQZPgEvxRw==",
            "attribute_key": "prescription_id",
            "module": "sales"
        },
        {
            "id": "J7kwRmvgO/93drQrS09DjA==",
            "attribute_key": "appointment_id",
            "module": "sales"
        },
        {
            "id": "zZBjQtv8YC8gzeDpmzakxg==",
            "attribute_key": "zipcode",
            "module": "sales"
        }
    ]
}

404 Invalid API key

{
    "status_code": "404",
    "status_message": "Invalid API Key",
    "datetime": "2024-09-30 17:11:28",
    "data": null
}