List Resources

DEPRECATED

Developer Preview

Deprecation Notice
This endpoint has been replaced with Query Resource and will be removed on March 31, 2022. If your app uses this endpoint, we recommend updating your code as soon as possible.

Retrieves a list of the resources according to the provided filters and paging.

This query is optional. If no query is provided than all non-deleted resources are returned.

Property	Is supported
filter	supports `resource.id`, `resource.tag`, `resource.status`
paging	supported
fields	supported
fieldsets	not supported
sort	not supported

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

Syntax

function ListResources(query.filter: ref, query.sort: array<_wix_common_Sorting>, query.paging: ref, query.fields: array<string>, query.fieldsets: array<string>): List<_com_wixpress_bookings_resources_core_api_v1_resource_ListResourcesResponse>

List Resources Parameters

NAME

TYPE

DESCRIPTION

query.filter

object

Filter object in the following format:
"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }
Example of operators: $eq, $ne, $lt, $lte, $gt, $gte, $in, $hasSome, $hasAll, $startsWith, $contains

query.sort

Array<object>

Sort object in the following format:
[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]

query.paging

object

Paging options to limit and skip the number of items.

query.fields

Array<string>

Array of projected fields. A list of specific field names to return. If fieldsets are also specified, the union of fieldsets and fields is returned.

query.fieldsets

Array<string>

Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple fieldsets will return the union of fields from all sets. If fields are also specified, the union of fieldsets and fields is returned.

Returns

Return Type:

object

NAME

TYPE

DESCRIPTION

resources

Array<object>

List of resources matching the query object.

metadata

Deprecated

object

pagingMetadata

object

Was this helpful?

List Resources

Lists all resources.

Request

curl

Copy Code

1curl -X GET \
2   'https://www.wixapis.com/bookings/v1/resources' \
3   -H 'Authorization: <AUTH>'

Response

json

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

List Resources by tags