Retrieves a list of up to 1,000 contacts per request.
You can only call this method when authenticated as a Wix app or Wix user identity.
Field to sort by.
Supported properties:
createdDate, lastActivity.activityDate, primaryInfo.email, info.name.first, info.name.last, info.company,
info.jobTitle, info.birthdate
Sort order.
Use ASC for ascending order or DESC for descending order.
Defaults to ASC.
Number of items to skip in the current sort order.
List of projected fields to return.
If both fields and fieldsets are sent in the request,
the union of both lists is returned.
id and revision are always returned.
Supported properties:
source, createdDate, updatedDate, lastActivity, primaryInfo,
info.name, info.emails, info.phones, info.addresses, info.company,
info.jobTitle, info.picture, info.birthdate, info.locale,
info.labelKeys, info.locations, info.extendedFields
List of contacts.
Details on the paged set of results returned.
curl -X GET \
'https://www.wixapis.com/contacts/v4/contacts?fieldsets=FULL' \
-H 'Authorization: <AUTH>'{
"contacts": [
{
"id": "8046df3c-7575-4098-a5ab-c91ad8f33c47",
"revision": 1,
"source": {
"sourceType": "IMPORT"
},
"createdDate": "2019-10-30T17:22:10.299Z",
"updatedDate": "2019-10-30T17:22:10.299Z",
"lastActivity": {
"activityDate": "2019-10-30T17:22:10.299Z",
"activityType": "CONTACT_CREATED"
},
"primaryInfo": {
"email": "email@example.com",
"phone": "097495550"
},
"picture": {
"id": "WixMedia image ID",
"url": "https://www.wix.com/contacts-server/api/v1/metasite/avatar/8046df3c-7575-4098-a5ab-c91ad8f33c47/2528bd01086244efb191c1302d986566/",
"height": 50,
"width": 50
},
"info": {
"name": {
"first": "Some",
"last": "One"
},
"emails": {
"items": [
{
"id": "d8f0d88c-af92-4237-833f-56aaaa2b5168",
"tag": "MAIN",
"email": "email@example.com",
"primary": true
},
{
"id": "5b430771-e6f1-4bea-9eb5-ad7472270605",
"tag": "MAIN",
"email": "email2@example.com"
}
]
},
"phones": {
"items": [
{
"id": "e5214c79-af80-4eff-87f2-408b0be4e710",
"tag": "HOME",
"countryCode": "IL",
"phone": "097495550",
"e164Phone": "+97297495550",
"primary": true
},
{
"id": "59323148-ecf2-4bbe-a7eb-c1b01f43845e ",
"tag": "MOBILE",
"countryCode": "UA",
"phone": "0443955571",
"e164Phone": "+380443955571"
}
]
},
"addresses": {
"items": [
{
"id": "3f8bba59-150f-4ee7-9c58-632cbdae222c",
"tag": "HOME",
"address": {
"country": "US",
"subdivision": "US-ME",
"city": "Richmond",
"postalCode": "04357",
"addressLine": "1772 Fantages Way",
"addressLine2": "Apt 17"
}
},
{
"id": "be0b1932-e081-46b0-8dfa-a9f2409fa3a8",
"tag": "WORK",
"address": {
"country": "US",
"subdivision": "US-ME",
"city": "Richmond",
"postalCode": "04357",
"streetAddress": {
"number": "5",
"name": "Wingate"
},
"addressLine2": "the code to the building is: *1234"
}
}
]
},
"company": "Wix",
"jobTitle": "Developer",
"birthdate": "1980-12-01",
"locale": "en-us",
"labelKeys": {
"items": ["contacts.contacted-me", "custom.my-label"]
},
"extendedFields": {
"items": {
"custom.color": "Blue",
"custom.number": 12,
"custom.date": "2020-01-01",
"custom.url": "http://domain.com",
"members.membershipStatus": "APPROVED",
"emailSubscriptions.subscriptionStatus": "SUBSCRIBED",
"emailSubscriptions.deliverabilityStatus": "ACTIVE",
"emailSubscriptions.effectiveEmail": "email@test.rocks"
}
},
"locations": {
"items": [
"d009f926-3273-11eb-adc1-0242ac120002",
"cf2ca920-6ac7-451f-a19b-d0382ab3892f",
"c5d3ff84-c18c-40c1-b6ac-9e003d6c5643"
]
}
}
},
{
"id": "e50c4534-d0a5-11ea-87d0-0242ac130003",
"revision": 1,
"source": {
"sourceType": "IMPORT"
},
"createdDate": "2019-10-30T17:48:10.299Z",
"updatedDate": "2019-10-30T17:59:10.299Z",
"lastActivity": {
"activityDate": "2019-10-30T17:59:10.299Z",
"activityType": "CONTACT_CREATED"
},
"primaryInfo": {
"email": "email211@example.com",
"phone": "097499991"
},
"picture": {
"id": "WixMedia image ID",
"url": "https://www.wix.com/contacts-server/api/v1/metasite/avatar/e50c4764-d0a5-11ea-87d0-0242ac130003/2528bd01086244efb191c1302d986566/",
"height": 50,
"width": 50
},
"info": {
"name": {
"first": "Some",
"last": "One"
},
"emails": {
"items": [
{
"id": "e50c487c-d0a5-11ea-87d0-0242ac130003",
"tag": "MAIN",
"email": "email211@example.com",
"primary": true
},
{
"id": "e50c4958-d0a5-11ea-87d0-0242ac130003",
"tag": "MAIN",
"email": "email123213@example.com"
}
]
},
"phones": {
"items": [
{
"id": "e50c4bc4-d0a5-11ea-87d0-0242ac130003",
"tag": "HOME",
"countryCode": "IL",
"phone": "097499991",
"e164Phone": "+97297499991",
"primary": true
},
{
"id": "e50c4ca0-d0a5-11ea-87d0-0242ac130003",
"tag": "MOBILE",
"countryCode": "UA",
"phone": "0443875571",
"e164Phone": "+380443875571"
}
]
},
"addresses": {
"items": [
{
"id": "e50c4d5e-d0a5-11ea-87d0-0242ac130003",
"tag": "HOME",
"address": {
"country": "US",
"subdivision": "US-OH",
"city": "Athens",
"postalCode": "45701",
"addressLine": "19 E Cir Dr"
}
},
{
"id": "e50c4e26-d0a5-11ea-87d0-0242ac130003",
"tag": "WORK",
"address": {
"country": "US",
"subdivision": "US-OH",
"city": "Athens",
"postalCode": "45701",
"streetAddress": {
"number": "305",
"name": "W Union St"
},
"addressLine2": "the code to the building is: *1234"
}
}
]
},
"company": "Wix",
"jobTitle": "QA engineer",
"birthdate": "1980-12-01",
"locale": "en-us",
"labelKeys": {
"items": ["contacts.contacted-me", "custom.my-label"]
},
"extendedFields": {
"items": {
"custom.color": "Green",
"custom.number": 1984,
"custom.date": "2020-01-01",
"custom.url": "http://domain.com",
"members.membershipStatus": "APPROVED",
"subscriptions.subscriptionStatus": "NOT SET",
"subscriptions.effectiveEmail": "email@test.rocks"
}
},
"locations": {
"items": ["d009f926-3273-11eb-adc1-0242ac120002"]
}
}
}
],
"pagingMetadata": {
"count": 2,
"offset": 0,
"total": 2
}
}There are 2 errors with this status code.
This method may also return standard errors. Learn more about standard Wix errors.