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

Get Form

Developer Preview

Gets a form

Permissions This endpoint requires the Read Bookings - Public Data or Read Bookings - Including Participants permissions scope

Authorization

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

GET

https://www.wixapis.com/bookings/v1/forms/{id}

Path Params

NAME
TYPE
DESCRIPTION
id
Required

string

The Id of the form to get

Response Object

NAME
TYPE
DESCRIPTION
form

object

The requested form

Status/Error Codes

The response will include an HTTP status code.

Was this helpful?

List Forms

List all the forms in the site

Request

curl

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

Response

json

1
2{"form": {
3 "id": "00000000-0000-0000-0000-000000000000",
4 "header": {
5 "description": "Tell us a bit about yourself",
6 "title": "Add Your Info",
7 "isDescriptionHidden": false
8 },
9 "actionLabels": {
10 "offlinePaymentLabel": "Book It",
11 "onlinePaymentLabel": "Pay Now",
12 "bookingRequestApprovalLabel": "Request To Book"
13 },
14 "name": {
15 "fieldId": "00000000-0000-0000-0000-000000000001",
16 "valueType": "SHORT_TEXT",
17 "label": "Name",
18 "userConstraints": {"required": true},
19 "additionalLabels": []
20 },
21 "email": {
22 "fieldId": "00000000-0000-0000-0000-000000000002",
23 "valueType": "SHORT_TEXT",
24 "label": "Email",
25 "userConstraints": {"required": true},
26 "additionalLabels": []
27 },
28 "phone": {
29 "fieldId": "00000000-0000-0000-0000-000000000003",
30 "valueType": "SHORT_TEXT",
31 "label": "Phone Number",
32 "userConstraints": {"required": false},
33 "additionalLabels": []
34 },
35 "numberOfParticipants": {
36 "fieldId": "00000000-0000-0000-0000-000000000007",
37 "valueType": "SHORT_TEXT",
38 "label": "Number of Participants",
39 "userConstraints": {"required": true},
40 "additionalLabels": []
41 },
42 "address": {
43 "street": {
44 "fieldId": "00000000-0000-0000-0000-000000000004",
45 "valueType": "SHORT_TEXT",
46 "label": "Street",
47 "userConstraints": {"required": true},
48 "additionalLabels": []
49 },
50 "city": {
51 "fieldId": "00000000-0000-0000-0000-000000000005",
52 "valueType": "SHORT_TEXT",
53 "label": "City",
54 "userConstraints": {"required": true},
55 "additionalLabels": []
56 },
57 "floorNumber": {
58 "fieldId": "00000000-0000-0000-0000-000000000006",
59 "valueType": "SHORT_TEXT",
60 "label": "Apt. / Floor No.",
61 "userConstraints": {"required": false},
62 "additionalLabels": []
63 },
64 "state": {
65 "fieldId": "00000000-0000-0000-0000-000000000009",
66 "valueType": "SHORT_TEXT",
67 "label": "State",
68 "userConstraints": {"required": false},
69 "additionalLabels": []
70 }
71 },
72 "customFields": [ {
73 "fieldId": "00000000-0000-0000-0000-000000000008",
74 "valueType": "LONG_TEXT",
75 "label": "Add Your Message",
76 "userConstraints": {"required": false},
77 "additionalLabels": []
78 }]
79}}