POST

Query Extended Fields


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.

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
POST
https://www.wixapis.com/contacts/v4/extended-fields/query

Body Params
queryQuery

Query options.

Response Object
fieldsArray <ExtendedField>

List of extended fields.


pagingMetadataPagingMetadata

Details on the paged set of results returned.

Request
cURL
curl -X POST \ 'https://www.wixapis.com/contacts/v4/extended-fields/query' \ -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
400Invalid Argument

There are 6 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?