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

List Resources

Developer Preview

Queries the business' resources.
The query is optional, if no query is provided than the non-deleted resources will be returned.
Query object support:

  • filter: supports "resource.id", "resource.tag", "resource.status".
  • paging: supported.
  • fields: supported.
  • paging: not supported.
  • fields: not supported.
  • fieldsets: not supported.

Permissions
This endpoint requires the Read Bookings Calendar, Read Bookings - Public Data, Read Bookings - Including Participants or Manage Bookings permission scope.

Authorization

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

GET

https://www.wixapis.com/bookings/v1/resources

Query Params

NAME
TYPE
DESCRIPTION
query.fieldsets

Array<string>

Projection on the result object - list of named projections. E.g. "basic" will return id and name fields. Specifying multiple fieldsets will return the union of fields from all. Specifying fieldsets and fields will also return the union of fields.

query.filter

object

A filter object. See documentation here

query.paging

object

Limit number of results

query.fields

Array<string>

Projection on the result object - list of specific field names to return. If fieldsets are also specified, return the union of fieldsets and fields

query.sort

Array<object>

Response Object

NAME
TYPE
DESCRIPTION
resources

Array<object>

List of resources matching the query object.

metadata

object

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

List Resources by tags

Lists all the resources with the tag "staff"

Request

curl

Copy Code
1curl -X GET \
2 'http://bookings.wix.com/_api/resources-server/v1/resources?query.filter.stringValue={%22resource.tags%22:%20{%22$hasSome%22%20:%20[%22staff%22]}}' \
3 -H 'Authorization: <AUTH>'
4
5{
6 "resources": [
7 {
8 "id": "4fd7fb85-57b0-4432-bff5-9bf34c5d9b67",
9 "name": "Larry D. Perez",
10 "email": "larry@mysite.info",
11 "phone": "620-428-1751",
12 "tags": [
13 "staff"
14 ],
15 "images": [
16 {
17 "id": "",
18 "url": "11062b_9121862a4dee42ebab28a177c75d33ab~mv2.jpg",
19 "height": 4480,
20 "width": 6720
21 }
22 ],
23 "schedules": [
24 {
25 "id": "fccce113-49a2-4fdf-9c81-a1220c75230b",
26 "scheduleOwnerId": "4fd7fb85-57b0-4432-bff5-9bf34c5d9b67",
27 "firstSessionStart": "2020-04-19T06:00:00Z",
28 "timeZone": "Asia/Jerusalem",
29 "intervals": [
30 {
31 "id": "c69d0dd0-b3c5-42b6-9b1b-c380eed5b798",
32 "start": "2020-04-18T21:00:00Z",
33 "interval": {
34 "daysOfWeek": "FRI",
35 "hourOfDay": 10,
36 "minuteOfHour": 0,
37 "duration": 480
38 },
39 "frequency": {
40 "repetition": 1
41 },
42 "affectedSchedules": []
43 },
44 {
45 "id": "03c4a3ca-86da-4079-80f0-830c09fb5fd5",
46 "start": "2020-04-18T21:00:00Z",
47 "interval": {
48 "daysOfWeek": "SAT",
49 "hourOfDay": 9,
50 "minuteOfHour": 0,
51 "duration": 540
52 },
53 "frequency": {
54 "repetition": 1
55 },
56 "affectedSchedules": []
57 },
58 {
59 "id": "b1ad1286-efce-4b2d-8cd2-e8b9f0127116",
60 "start": "2020-04-18T21:00:00Z",
61 "interval": {
62 "daysOfWeek": "SUN",
63 "hourOfDay": 9,
64 "minuteOfHour": 0,
65 "duration": 540
66 },
67 "frequency": {
68 "repetition": 1
69 },
70 "affectedSchedules": []
71 }
72 ],
73 "tags": [],
74 "availability": {
75 "start": "2020-04-18T21:00:00Z",
76 "linkedSchedules": []
77 },
78 "totalNumberOfParticipants": 0,
79 "participants": [],
80 "status": "CREATED",
81 "created": "2020-04-19T18:18:35.890Z",
82 "updated": "2020-04-19T18:18:35.890Z",
83 "version": 0,
84 "inheritedFields": [
85 "timeZone"
86 ]
87 }
88 ],
89 "status": "CREATED"
90 },
91 {
92 "id": "936d2078-79ba-49ca-b82d-8f12b8a050ac",
93 "name": "John Smith",
94 "email": "john.smith@mysite.com",
95 "phone": "202-555-0152",
96 "tags": [
97 "staff",
98 "defaultStaff"
99 ],
100 "images": [],
101 "schedules": [
102 {
103 "id": "7018bb00-a3c2-4677-b859-0c929e010f1e",
104 "scheduleOwnerId": "936d2078-79ba-49ca-b82d-8f12b8a050ac",
105 "timeZone": "Asia/Jerusalem",
106 "intervals": [],
107 "tags": [],
108 "availability": {
109 "start": "2019-11-26T09:35:22.318Z",
110 "linkedSchedules": [
111 {
112 "scheduleId": "0c1f4235-0d3a-43db-bcc2-285db2ca5bed",
113 "transparency": "FREE",
114 "scheduleOwnerId": "e75d7f67-9de6-42a1-9b62-05d74f0209f7"
115 }
116 ]
117 },
118 "totalNumberOfParticipants": 0,
119 "participants": [],
120 "status": "CREATED",
121 "created": "2019-08-15T14:29:17.444Z",
122 "updated": "2020-04-19T18:12:48.874Z",
123 "version": 8,
124 "inheritedFields": [
125 "timeZone"
126 ]
127 }
128 ],
129 "status": "UPDATED"
130 },
131 {
132 "id": "e973d9da-83e3-4af7-bc4c-dcfa29bea622",
133 "name": "Andrea J. Toth",
134 "email": "AndreaJ.Toth@myinfo.site",
135 "phone": "617-381-6831",
136 "tags": [
137 "staff"
138 ],
139 "images": [],
140 "schedules": [
141 {
142 "id": "73941349-10c9-42a6-a51b-fe997514cfae",
143 "scheduleOwnerId": "e973d9da-83e3-4af7-bc4c-dcfa29bea622",
144 "firstSessionStart": "2020-04-20T07:00:00Z",
145 "timeZone": "Asia/Jerusalem",
146 "intervals": [
147 {
148 "id": "d4997576-5e21-4720-b73a-02f86304e3dc",
149 "start": "2020-04-18T21:00:00Z",
150 "interval": {
151 "daysOfWeek": "MON",
152 "hourOfDay": 10,
153 "minuteOfHour": 0,
154 "duration": 420
155 },
156 "frequency": {
157 "repetition": 1
158 },
159 "affectedSchedules": []
160 },
161 {
162 "id": "3e8d93e0-6e0b-456d-980f-21a78489f958",
163 "start": "2020-04-18T21:00:00Z",
164 "interval": {
165 "daysOfWeek": "TUE",
166 "hourOfDay": 10,
167 "minuteOfHour": 0,
168 "duration": 420
169 },
170 "frequency": {
171 "repetition": 1
172 },
173 "affectedSchedules": []
174 },
175 {
176 "id": "33a091bc-bbf6-4d00-9865-e188af5f5a5f",
177 "start": "2020-04-18T21:00:00Z",
178 "interval": {
179 "daysOfWeek": "WED",
180 "hourOfDay": 10,
181 "minuteOfHour": 0,
182 "duration": 420
183 },
184 "frequency": {
185 "repetition": 1
186 },
187 "affectedSchedules": []
188 },
189 {
190 "id": "6b9a31e3-1137-42c0-8355-a0b6d220aa58",
191 "start": "2020-04-18T21:00:00Z",
192 "interval": {
193 "daysOfWeek": "THU",
194 "hourOfDay": 10,
195 "minuteOfHour": 0,
196 "duration": 420
197 },
198 "frequency": {
199 "repetition": 1
200 },
201 "affectedSchedules": []
202 },
203 {
204 "id": "f93423b3-6eba-429f-8eb8-d4f3c4f47a28",
205 "start": "2020-04-18T21:00:00Z",
206 "interval": {
207 "daysOfWeek": "FRI",
208 "hourOfDay": 10,
209 "minuteOfHour": 0,
210 "duration": 420
211 },
212 "frequency": {
213 "repetition": 1
214 },
215 "affectedSchedules": []
216 }
217 ],
218 "tags": [],
219 "availability": {
220 "start": "2020-01-26T22:00:00Z",
221 "linkedSchedules": []
222 },
223 "totalNumberOfParticipants": 0,
224 "participants": [],
225 "status": "CREATED",
226 "created": "2020-01-27T19:44:05.010Z",
227 "updated": "2020-04-19T18:14:38.674Z",
228 "version": 1,
229 "inheritedFields": [
230 "timeZone"
231 ]
232 }
233 ],
234 "status": "UPDATED"
235 }
236 ],
237 "metadata": {
238 "items": 3,
239 "offset": 0,
240 "totalCount": 4
241 }
242}

Response

json

1
2{}
List Resources