Search.../

items

Returns the items that match the query.

Description

The current page of items retrieved by the query.

List of extended fields.

Note: When no items match the query, the items array is empty.

To paginate your query results, use the ExtendedFieldsQueryResult pagination properties and functions.

Type:

Array<ExtendedField>Read Only
NAME
TYPE
DESCRIPTION
key
string

Extended field ID.

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.

displayName
string

Extended field display name shown in the Contact List.

dataType
string

Type of data the field holds.

One of:

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

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

One of:

  • "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.
_createdDate
Date

Date and time the field was created.

_updatedDate
Date

Date and time the field was last updated.

namespace
string

Extended field namespace.

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

description
string

Field description, if the field is a system field.

Was this helpful?

Perform a query and get the returned items from the result

Copy Code
1import { Permissions, webMethod } from 'wix-web-module';
2import { contacts } from 'wix-crm-backend';
3
4export const getQueryResultItems = webMethod(Permissions.Anyone, () => {
5 return contacts.queryExtendedFields()
6 .limit(10)
7 .find()
8 .then((results) => {
9 if (results.items.length > 0) {
10 return results.items;
11 } else {
12 console.log("No items found");
13 }
14 })
15 .catch((error) => {
16 console.error(error);
17 });
18});
19
20/* items:
21 * [
22 * {
23 * "_createdDate": "2021-03-30T12:41:13.000Z",
24 * "dataType": "TEXT",
25 * "displayName": "Event we met at",
26 * "fieldType": "USER_DEFINED",
27 * "key": "custom.event-we-met-at",
28 * "namespace": "custom",
29 * "_updatedDate": "2021-03-30T12:41:13.000Z"
30 * },
31 * {
32 * "_createdDate": "2021-01-19T23:18:17.000Z",
33 * "dataType": "DATE",
34 * "displayName": "Last Contacted",
35 * "fieldType": "USER_DEFINED",
36 * "key": "custom.last-contacted",
37 * "namespace": "custom",
38 * "_updatedDate": "2021-01-19T23:18:17.000Z"
39 * },
40 * {
41 * "dataType": "TEXT",
42 * "description": "Display name starting with last name (read only)",
43 * "displayName": "Display Name (start with last)",
44 * "fieldType": "SYSTEM",
45 * "key": "contacts.displayByLastName",
46 * "namespace": "contacts"
47 * },
48 * {
49 * "dataType": "TEXT",
50 * "description": "Vat ID for Wix Invoices",
51 * "displayName": "VAT ID",
52 * "fieldType": "SYSTEM",
53 * "key": "invoices.vatId",
54 * "namespace": "invoices"
55 * },
56 * {
57 * "dataType": "TEXT",
58 * "description": "APPROVED/DENIED/PENDING/INACTIVE (read only)",
59 * "displayName": "Membership Status",
60 * "fieldType": "SYSTEM",
61 * "key": "members.membershipStatus",
62 * "namespace": "members"
63 * },
64 * {
65 * "dataType": "NUMBER",
66 * "description": "Wix Stores purchase count (read only)",
67 * "displayName": "# of Purchases",
68 * "fieldType": "SYSTEM",
69 * "key": "ecom.numOfPurchases",
70 * "namespace": "ecom"
71 * },
72 * {
73 * "dataType": "NUMBER",
74 * "description": "Wix Stores aggregated spent amount (read only)",
75 * "displayName": "Total Spent Amount",
76 * "fieldType": "SYSTEM",
77 * "key": "ecom.totalSpentAmount",
78 * "namespace": "ecom"
79 * },
80 * {
81 * "dataType": "TEXT",
82 * "description": "Wix Stores currency code (read only)",
83 * "displayName": "Total Spent Currency",
84 * "fieldType": "SYSTEM",
85 * "key": "ecom.totalSpentCurrency",
86 * "namespace": "ecom"
87 * },
88 * {
89 * "dataType": "DATE",
90 * "description": "Wix Stores last purchase date (read only)",
91 * "displayName": "Last Purchase Date",
92 * "fieldType": "SYSTEM",
93 * "key": "ecom.lastPurchaseDate",
94 * "namespace": "ecom"
95 * },
96 * {
97 * "dataType": "TEXT",
98 * "description": "SUBSCRIBED/UNSUBSCRIBED/NOT_SET/PENDING (read only)",
99 * "displayName": "Effective Subscription Status",
100 * "fieldType": "SYSTEM",
101 * "key": "emailSubscriptions.subscriptionStatus",
102 * "namespace": "emailSubscriptions"
103 * },
104 * {
105 * "dataType": "TEXT",
106 * "description": "VALID/BOUNCED/SPAM_COMPLAINT/INACTIVE (read only)",
107 * "displayName": "Effective Deliverability Status",
108 * "fieldType": "SYSTEM",
109 * "key": "emailSubscriptions.deliverabilityStatus",
110 * "namespace": "emailSubscriptions"
111 * }
112 * ]
113 */