GET

Get Extended Field


Retrieves an extended field by the specified extended field key.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Events
Manage Portfolio
Access Verticals by Automations
Set Up Automations
Manage Contact Extended Fields
Manage Restaurants - all permissions
Manage Members and Contacts - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/contacts/v4/extended-fields/{key}

Path Params
keystringRequired

Extended field key.

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

key is generated when the extended field is created. It can't be modified, even if displayName is updated.

Response Object
fieldField

The specified field.

Get Extended Field
Request
cURL
Response
JSON
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?