Search.../
  1. Home
  2. Getting Started
  3. Overview
Generate a test token to explore our APIs

List Contacts

Returns a list of contacts, given the provided paging (offset, limit) and order (firstName, lastName, email (first email), metadata.updatedAt)

Authorization

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

Permissions

This endpoint requires the Read Contacts permission scope.

GET

https://www.wixapis.com/crm/v1/contacts

Query Params

NAME
TYPE
DESCRIPTION
sort.fieldName

string

Name of the field to sort by

sort.order

string

Supported values: ASC, DESC.

Sort order (ASC/DESC). Defaults to ASC

paging.limit

integer

The number of items to load

paging.offset

integer

number of items to skip in the current sort order

Response Object

NAME
TYPE
DESCRIPTION
contacts

Array<object>

metadata

object

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

Example 1

Request

curl

Copy Code
1curl -X GET \
2 'https://www.wixapis.com/crm/v1/contacts' \
3 -H 'Authorization: <AUTH>'

Response

json

1
2{
3 "contacts": [
4 {
5 "id": "7a585d4b-74f1-4ff5-9d42-489299bf5259",
6 "firstName": "Sample",
7 "lastName": "Contact",
8 "emails": [ {
9 "tag": "WORK",
10 "email": "sample@contact.com"
11 }],
12 "phones": [ {
13 "tag": "UNTAGGED",
14 "phone": "+12225554444"
15 }],
16 "addresses": [ {
17 "tag": "UNTAGGED",
18 "street": "1 road",
19 "city": "Milano",
20 "countryCode": "IT",
21 "postalCode": "72662"
22 }],
23 "metadata": {
24 "createdAt": "2019-10-29T16:35:36.756Z",
25 "updatedAt": "2019-11-20T21:47:35.736Z"
26 }
27 },
28 {
29 "id": "8046df3c-7575-4098-a5ab-c91ad8f33c47",
30 "firstName": "Some",
31 "lastName": "One",
32 "emails": [ {
33 "tag": "MAIN",
34 "email": "email@test.rocks"
35 }],
36 "phones": [
37 {
38 "tag": "HOME",
39 "phone": "2075556300"
40 },
41 {
42 "tag": "MOBILE",
43 "phone": "2075555217"
44 }
45 ],
46 "addresses": [ {
47 "tag": "HOME",
48 "street": "1772 Fantages Way",
49 "city": "Richmond",
50 "region": "ME",
51 "countryCode": "US",
52 "postalCode": "04357"
53 }],
54 "metadata": {
55 "createdAt": "2019-10-30T17:22:10.299Z",
56 "updatedAt": "2019-11-13T20:14:49.458Z"
57 }
58 },
59 {
60 "id": "cb3cac0b-9a96-4ce9-8d6e-df6fc65e5f88",
61 "firstName": "Third",
62 "lastName": "Three",
63 "emails": [ {
64 "tag": "UNTAGGED",
65 "email": "three@four.to"
66 }],
67 "phones": [ {
68 "tag": "UNTAGGED",
69 "phone": "3333333"
70 }],
71 "addresses": [ {
72 "tag": "UNTAGGED",
73 "street": "30 3rd Ave",
74 "city": "Three Rivers",
75 "countryCode": "BR",
76 "postalCode": "28123"
77 }],
78 "metadata": {
79 "createdAt": "2019-11-20T21:49:02.804Z",
80 "updatedAt": "2019-11-20T21:49:02.811Z"
81 }
82 }
83 ],
84 "metadata": {
85 "items": 3,
86 "offset": 0,
87 "hasMore": false
88 }
89}
Example 2