GET

List Extended Fields


Retrieves a list of extended fields.

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

Query Params
fieldTypestring

Filter for fields of the specified type.


namespacestring

Filter for fields in the specified namespace. Fields created by calling the Find Or Create Extended Field method are automatically assigned to the custom namespace.


startsWithstring

Filter for fields where displayName starts with the specified case-sensitive string.


sort.fieldNamestringmaxLength 100

Name of the field to sort by.


sort.orderstring

Sort order.

Default: ASC.


paging.limitintegerminimum 0format int32

Number of items to return.

Defaults to 100.


paging.offsetintegerminimum 0format int32

Number of items to skip in the current sort order.

Defaults to 0.

Response Object
fieldsArray <ExtendedField>

List of extended fields.


metadataMetadata

Metadata for the page of results.

List Extended Fields
Request
cURL
curl -X GET \ 'https://www.wixapis.com/contacts/v4/extended-fields' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "fields": [ { "namespace": "custom", "key": "custom.number", "displayName": "number", "dataType": "NUMBER", "fieldType": "USER_DEFINED", "createdDate": "2021-01-06T12:57:04Z", "updatedDate": "2021-01-06T12:57:04Z", "legacyId": "5c55ce7e-ca4b-4332-b666-1e00d06e4555" }, { "namespace": "custom", "key": "custom.website", "displayName": "Website", "dataType": "URL", "fieldType": "USER_DEFINED", "createdDate": "2020-07-02T10:29:41Z", "updatedDate": "2020-07-02T10:29:41Z", "legacyId": "0a272857-4d0b-4ce2-bac6-1e3ce4483555" }, { "namespace": "custom", "key": "custom.date", "displayName": "Date", "dataType": "DATE", "fieldType": "USER_DEFINED", "createdDate": "2020-07-02T10:29:38Z", "updatedDate": "2020-07-02T10:29:38Z", "legacyId": "d104a3ad-f87f-4a79-9b3c-1bca5f41a555" }, { "namespace": "custom", "key": "custom.groupcolor", "displayName": "groupColor", "dataType": "TEXT", "fieldType": "USER_DEFINED", "createdDate": "2020-03-26T10:01:38Z", "updatedDate": "2020-03-26T10:01:38Z", "legacyId": "bb133f4f-67f1-44db-89e8-ea24e471d555" }, { "namespace": "contacts", "key": "contacts.displayByFirstName", "displayName": "Display Name (start with first)", "dataType": "TEXT", "fieldType": "SYSTEM", "description": "Display name starting with first name (read only)" }, { "namespace": "contacts", "key": "contacts.displayByLastName", "displayName": "Display Name (start with last)", "dataType": "TEXT", "fieldType": "SYSTEM", "description": "Display name starting with last name (read only)" }, { "namespace": "invoices", "key": "invoices.vatId", "displayName": "VAT ID", "dataType": "TEXT", "fieldType": "SYSTEM", "description": "Vat ID for Wix Invoices" }, { "namespace": "members", "key": "members.membershipStatus", "displayName": "Membership Status", "dataType": "TEXT", "fieldType": "SYSTEM", "description": "APPROVED/DENIED/PENDING/INACTIVE (read only)" }, { "namespace": "members", "key": "members.mobile", "displayName": "Mobile flag", "dataType": "TEXT", "fieldType": "SYSTEM", "description": "true/false" }, { "namespace": "ecom", "key": "ecom.numOfPurchases", "displayName": "# of Purchases", "dataType": "NUMBER", "fieldType": "SYSTEM", "description": "Wix Stores purchase count (read only)" }, { "namespace": "ecom", "key": "ecom.totalSpentAmount", "displayName": "Total Spent Amount", "dataType": "NUMBER", "fieldType": "SYSTEM", "description": "Wix Stores aggregated spent amount (read only)" }, { "namespace": "emailSubscriptions", "key": "emailSubscriptions.subscriptionStatus", "displayName": "Effective Subscription Status", "dataType": "TEXT", "fieldType": "SYSTEM", "description": "SUBSCRIBED/UNSUBSCRIBED/NOT_SET/PENDING (read only)" }, { "namespace": "emailSubscriptions", "key": "emailSubscriptions.deliverabilityStatus", "displayName": "Effective Deliverability Status", "dataType": "TEXT", "fieldType": "SYSTEM", "description": "VALID/BOUNCED/SPAM_COMPLAINT/INACTIVE (read only)" }, { "namespace": "emailSubscriptions", "key": "emailSubscriptions.effectiveEmail", "displayName": "Effective Email", "dataType": "TEXT", "fieldType": "SYSTEM", "description": "Effective Email for subscription purposes (read only)" } ], "metadata": { "count": 16, "offset": 0, "total": 16 } }
Errors

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

Did this help?