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 Portfolio
Manage Members and Contacts - all permissions
Manage Contact Extended Fields
Manage Restaurants - 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
curl -X GET 'https://www.wixapis.com/contacts/v4/extended-fields/custom.my-field' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: <AUTH>'
Response
JSON
{
  "namespace": "custom",
  "key": "custom.my-field",
  "displayName": "My Field",
  "dataType": "TEXT",
  "fieldType": "USER_DEFINED",
  "createdDate": "2019-10-10T12:30:56Z",
  "updatedDate": "2020-05-10T07:14:59Z"
}
Errors

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

Did this help?