Retrieves an extended field by the specified extended field key.
This function requires elevated permissions and runs only on the backend and on dashboard pages.
function getExtendedField(key: string): Promise<ExtendedField>;
null
import { extendedFields } from "wix-crm.v2";
/* Sample key value: 'custom.nickname' */
export async function myGetExtendedFieldFunction(key) {
try {
const extendedField = await extendedFields.getExtendedField(key);
console.log("Successfully retrieved extended field:", extendedField);
return extendedField;
} catch (error) {
console.log(error);
// Handle the error
}
}
/*
* Promise resolves to:
* {
* "namespace": "custom",
* "key": "custom.nickname",
* "displayName": "Nickname",
* "dataType": "TEXT",
* "fieldType": "USER_DEFINED",
* "legacyId": "63408eaf-e3d0-43f3-afa5-942847d272a1",
* "wixSearchColumn": "info_extendedFields_custom_string_18",
* "_createdDate": "2023-12-25T12:21:42.000Z",
* "_updatedDate": "2023-12-25T12:22:25.000Z"
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.