GET

Get Contact

Retrieves a contact.

Getting Merged Contacts

When a source contact is merged with a target contact, the source contact is deleted. When calling Get Contact for a merged contact, you can use the source or target contact ID. In both bases, the target contact is returned.

This is supported only when calling Get Contact on merged contacts. Previously deleted source contact IDs can't be used for any other method.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Set Up Automations
Manage Members and Contacts - all permissions
Read Members and Contacts - all read permissions
Manage Contacts
Read Contacts
Manage Events
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/contacts/v4/contacts/{id}
Path Params
idstringRequired

ID of the contact to retrieve.

Query Params
fieldsArray <string>

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

fieldsetsArray <string>

Predefined sets of fields to return. If both fields and fieldsets are sent in the request, the union of both lists is returned.

  • BASIC: Returns id, revision, primaryInfo, info.name.
  • COMMUNICATION_DETAILS: Returns id, revision, primaryInfo, info.name, info.emails, info.phones, info.addresses.
  • EXTENDED: Returns id, revision, primaryInfo, info.name, info.extendedFields.
  • FULL: Returns all fields.

Default: If fields is omitted from the request, FULL.

Response Object
contactContact

The requested contact.

responseTypestring

Contact response type.

Request
cURL
curl -X GET \
  'https://www.wixapis.com/contacts/v4/contacts/8046df3c-7575-4098-a5ab-c91ad8f33c47' \
  -H 'Authorization: <AUTH>'
Response
JSON
{
  "contact": {
    "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"
        ]
      }
    }
  },
  "responseType": "REGULAR"
}
Errors
404Not Found

There is 1 error with this status code.

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

Did this help?