Extended Fields

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.

Was this helpful?
Yes
No

Extended Fields: Supported Filters and Sorting

The following table shows field support for filters and sorting for the extended field object:

FieldSupported FiltersSortable
key$eq, $ne, $in
displayName$eq, $ne, $in, $startsWithSortable
createdDate$eq, $ne, $gt, $lt, $gte, $lteSortable
updatedDate$eq, $ne, $gt, $lt, $gte, $lteSortable
namespace$eq, $ne
fieldType$eq
dataType$eq, $ne

Related content: API Query Language, Query Extended Fields

Was this helpful?
Yes
No

Extended Field Object

Properties
namespacestringRead-onlyminLength 1maxLength 25

Extended field namespace.

Extended fields created by site contributors or 3rd-party apps are automatically assigned to the custom namespace.


keystringRead-onlyminLength 1maxLength 80

Extended field key.

When accessing contact data, extended field data is available at extendedFields[key]. For example, if the key is "custom.notes", the value can be accessed at extendedFields["custom.notes"].

key is generated when the extended field is created and cannot be modified, even if displayName changes.


displayNamestringminLength 1maxLength 150

Display name shown in the Contact List.


dataTypestringRead-only
5 enum supported values:
UNKNOWN_DATA_TYPETEXTNUMBERDATEURL

Type of data the field holds.

  • TEXT: Accepts strings.
  • NUMBER: Accepts floats.
  • DATE: Accepts dates formatted as YYYY-MM-DD.
  • URL: Accepts strings. Prepends https:// if no protocol is included.

fieldTypestringRead-only
3 enum supported values:
UNKNOWNSYSTEMUSER_DEFINED

Indicates whether the extended field is a system field or custom field.

  • 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.

createdDatestringRead-onlyformat date-time

Date and time the field was created.


updatedDatestringRead-onlyformat date-time

Date and time the field was last updated.


descriptionstringRead-onlyminLength 1maxLength 150

Field description, if the field is a system field.

Was this helpful?
Yes
No

GetList Extended Fields

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of extended fields.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Contact Extended Fields
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/contacts/v4/extended-fields

Was this helpful?
Yes
No

PostFind Or Create Extended Field

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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:
Manage Contact Extended Fields
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/contacts/v4/extended-fields

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

GetGet Extended Field

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves an extended field.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Contact Extended Fields
Learn more about permission scopes.
Endpoint
GET
https://www.wixapis.com/contacts/v4/extended-fields/{key}

Was this helpful?
Yes
No

DeleteDelete Extended Field

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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:
Manage Contact Extended Fields
Learn more about permission scopes.
Endpoint
DELETE
https://www.wixapis.com/contacts/v4/extended-fields/{key}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PatchUpdate Extended Field

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates an extended field's specified properties.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Contact Extended Fields
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/contacts/v4/extended-fields/{field.key}

Event TriggersThis method triggers the following events:
Was this helpful?
Yes
No

PostQuery Extended Fields

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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:
Manage Contact Extended Fields
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/contacts/v4/extended-fields/query

Was this helpful?
Yes
No

Extended Field Created

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an extended field is created.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.contacts.v4.extended-field.


slugstring

Event name. Expected created.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


createdEventobject

Event information.


Was this helpful?
Yes
No

Extended Field Updated

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an extended field is updated.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.contacts.v4.extended-field.


slugstring

Event name. Expected updated.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


updatedEventobject

Event information.


Was this helpful?
Yes
No

Extended Field Deleted

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when an extended field is deleted.

Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.


entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.contacts.v4.extended-field.


slugstring

Event name. Expected deleted.


entityIdstring

ID of the entity associated with the event.


eventTimestringformat date-time

Event timestamp.


triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).


originatedFromstring

If present, indicates the action that triggered the event.


deletedEventstruct

Event information.


Was this helpful?
Yes
No