While the Contact List contains the default fields you would expect to find (such as name, address, phone, and email) additional information about contacts can be stored in extended fields.
Extended fields can be created by site owners and contributors in the Dashboard, or they can be created programmatically by Wix and 3rd-party apps. Extended fields store data as text, URL, number, or date.
When a new extended field is created, it's available for use for all contacts, and it's blank by default.
You can use the Extended Fields API to view and manage extended field definitions. To view and manage data in extended fields for individual contacts, you'll need to use the Contacts API.
Each extended field is represented in the contact object
in info.extendedFields as key-value pairs.
Each key is the extended field key,
and each value is the field's value for the contact.
Empty extended fields are not returned.
The following table shows field support for filters and sorting for the extended field object:
| Field | Supported Filters | Sortable |
|---|---|---|
key | $eq, $ne, $in | |
displayName | $eq, $ne, $in, $startsWith | Sortable |
createdDate | $eq, $ne, $gt, $lt, $gte, $lte | Sortable |
updatedDate | $eq, $ne, $gt, $lt, $gte, $lte | Sortable |
namespace | $eq, $ne | |
fieldType | $eq | |
dataType | $eq, $ne |
Related content: API Query Language, Query Extended Fields
- TEXT: Accepts strings.
- NUMBER: Accepts floats.
- DATE: Accepts dates formatted as YYYY-MM-DD.
- URL: Accepts strings. Prepends https:// if no protocol is included.
- SYSTEM: The field is a system field managed by Wix. System fields cannot be modified by 3rd-party apps or site contributors.
- USER_DEFINED: The field is a custom field and can be modified by 3rd-party apps or site contributors.
Retrieves a list of extended fields.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Retrieves a custom field with a given name, or creates one if it doesn't exist.
Successful calls to this endpoint always return a field, which can be passed to subsequent requests.
To find an existing custom field without potentially creating a new one, use Get Extended Field or List Extended Fields.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Retrieves an extended field.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Deletes an extended field.
When an extended field is deleted, any contact data stored in the field is permanently deleted as well.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Updates an extended field's specified properties.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Retrieves a list of extended fields.
For a detailed list of supported operations, see sorting and filtering for extended fields. To learn more about query language, see API Query Language.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
Triggered when an extended field is created.
Event Body
Triggered when an extended field is updated.
Event Body
Triggered when an extended field is deleted.