Search.../
  1. REST
Generate a test token to explore our APIs

Query Extended Fields

Developer Preview

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.

Authorization

This endpoint requires an authorization header - pass the access token from the OAuth installation flow.

Permissions

This endpoint requires the Manage Members and Contacts - all permissions or the Manage Contact Extended Fields permission scope.

POST

https://www.wixapis.com/contacts/v4/extended-fields/query

Body Params

NAME
TYPE
DESCRIPTION
query
object

Query options.

Response Object

NAME
TYPE
DESCRIPTION
fields
Array<object>

List of extended fields.

pagingMetadata
object

Details on the paged set of results returned.

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Query All Extended Fields

Request

curl

Copy Code
1curl -X POST \
2 'https://www.wixapis.com/contacts/v4/extended-fields/query' \
3 -H 'Authorization: <AUTH>'

Response

json

1{
2 "fields": [
3 {
4 "namespace": "custom",
5 "key": "custom.number",
6 "displayName": "number",
7 "dataType": "NUMBER",
8 "fieldType": "USER_DEFINED",
9 "createdDate": "2021-01-06T12:57:04Z",
10 "updatedDate": "2021-01-06T12:57:04Z",
11 "legacyId": "5c55ce7e-ca4b-4332-b666-1e00d06e4555"
12 },
13 {
14 "namespace": "custom",
15 "key": "custom.website",
16 "displayName": "Website",
17 "dataType": "URL",
18 "fieldType": "USER_DEFINED",
19 "createdDate": "2020-07-02T10:29:41Z",
20 "updatedDate": "2020-07-02T10:29:41Z",
21 "legacyId": "0a272857-4d0b-4ce2-bac6-1e3ce4483555"
22 },
23 {
24 "namespace": "custom",
25 "key": "custom.date",
26 "displayName": "Date",
27 "dataType": "DATE",
28 "fieldType": "USER_DEFINED",
29 "createdDate": "2020-07-02T10:29:38Z",
30 "updatedDate": "2020-07-02T10:29:38Z",
31 "legacyId": "d104a3ad-f87f-4a79-9b3c-1bca5f41a555"
32 },
33 {
34 "namespace": "custom",
35 "key": "custom.groupcolor",
36 "displayName": "groupColor",
37 "dataType": "TEXT",
38 "fieldType": "USER_DEFINED",
39 "createdDate": "2020-03-26T10:01:38Z",
40 "updatedDate": "2020-03-26T10:01:38Z",
41 "legacyId": "bb133f4f-67f1-44db-89e8-ea24e471d555"
42 },
43 {
44 "namespace": "contacts",
45 "key": "contacts.displayByFirstName",
46 "displayName": "Display Name (start with first)",
47 "dataType": "TEXT",
48 "fieldType": "SYSTEM",
49 "description": "Display name starting with first name (read only)"
50 },
51 {
52 "namespace": "contacts",
53 "key": "contacts.displayByLastName",
54 "displayName": "Display Name (start with last)",
55 "dataType": "TEXT",
56 "fieldType": "SYSTEM",
57 "description": "Display name starting with last name (read only)"
58 },
59 {
60 "namespace": "invoices",
61 "key": "invoices.vatId",
62 "displayName": "VAT ID",
63 "dataType": "TEXT",
64 "fieldType": "SYSTEM",
65 "description": "Vat ID for Wix Invoices"
66 },
67 {
68 "namespace": "members",
69 "key": "members.membershipStatus",
70 "displayName": "Membership Status",
71 "dataType": "TEXT",
72 "fieldType": "SYSTEM",
73 "description": "APPROVED/DENIED/PENDING/INACTIVE (read only)"
74 },
75 {
76 "namespace": "members",
77 "key": "members.mobile",
78 "displayName": "Mobile flag",
79 "dataType": "TEXT",
80 "fieldType": "SYSTEM",
81 "description": "true/false"
82 },
83 {
84 "namespace": "ecom",
85 "key": "ecom.numOfPurchases",
86 "displayName": "# of Purchases",
87 "dataType": "NUMBER",
88 "fieldType": "SYSTEM",
89 "description": "Wix Stores purchase count (read only)"
90 },
91 {
92 "namespace": "ecom",
93 "key": "ecom.totalSpentAmount",
94 "displayName": "Total Spent Amount",
95 "dataType": "NUMBER",
96 "fieldType": "SYSTEM",
97 "description": "Wix Stores aggregated spent amount (read only)"
98 },
99 {
100 "namespace": "ecom",
101 "key": "ecom.totalSpentCurrency",
102 "displayName": "Total Spent Currency",
103 "dataType": "TEXT",
104 "fieldType": "SYSTEM",
105 "description": "Wix Stores currency code (read only)"
106 },
107 {
108 "namespace": "ecom",
109 "key": "ecom.lastPurchaseDate",
110 "displayName": "Last Purchase Date",
111 "dataType": "DATE",
112 "fieldType": "SYSTEM",
113 "description": "Wix Stores last purchase date (read only)"
114 },
115 {
116 "namespace": "emailSubscriptions",
117 "key": "emailSubscriptions.subscriptionStatus",
118 "displayName": "Effective Subscription Status",
119 "dataType": "TEXT",
120 "fieldType": "SYSTEM",
121 "description": "SUBSCRIBED/UNSUBSCRIBED/NOT_SET/PENDING (read only)"
122 },
123 {
124 "namespace": "emailSubscriptions",
125 "key": "emailSubscriptions.deliverabilityStatus",
126 "displayName": "Effective Deliverability Status",
127 "dataType": "TEXT",
128 "fieldType": "SYSTEM",
129 "description": "VALID/BOUNCED/SPAM_COMPLAINT/INACTIVE (read only)"
130 },
131 {
132 "namespace": "emailSubscriptions",
133 "key": "emailSubscriptions.effectiveEmail",
134 "displayName": "Effective Email",
135 "dataType": "TEXT",
136 "fieldType": "SYSTEM",
137 "description": "Effective Email for subscription purposes (read only)"
138 }
139 ],
140 "metadata": {
141 "count": 16,
142 "offset": 0,
143 "total": 16
144 }
145}
Query Extended Fields by Namespace Sorted by CreatedDate Desc
Query Extended Fields by Keys