Search...
Generate a test token to explore our APIs
Get Site Properties
Developer Preview
Retreives the current snapshot of a site's properties.
Authorization
This endpoint requires an authorization header - pass the access token from the OAuth installation flow.
Permissions
This endpoint requires the Manage Your App permission scope.
GET
https://www.wixapis.com/site-properties/v4/properties
Query Params
NAME
TYPE
DESCRIPTION
fields.paths
Array<string>
The set of field mask paths.
Response Object
The resulting properties for the requested site.
NAME
TYPE
DESCRIPTION
version
string
Current version of the stored property site. For internal use.
properties
object
Properties for the requested site.
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/site-properties/v4/properties'3 -H 'Authorization: <AUTH>'
Response
json
1{2 "version": "207",3 "properties": {4 "categories": {5 "primary": "business",6 "secondary": ["services-maintenance"]7 },8 "locale": {9 "languageCode": "en",10 "country": "US"11 },12 "language": "en",13 "paymentCurrency": "USD",14 "timeZone": "Asia/Jerusalem",15 "email": "useremail@domain.com",16 "phone": "+18008000000",17 "fax": "12345678",18 "address": {19 "street": "",20 "city": "New York",21 "country": "US",22 "state": "NY",23 "zip": "10036",24 "isPhysical": true,25 "googleFormattedAddress": "Times Square, Manhattan, NY, USA",26 "streetNumber": "",27 "apartmentNumber": "",28 "coordinates": {29 "latitude": 40.757977,30 "longitude": -73.9855431 }32 },33 "siteDisplayName": "My Site Display Name",34 "businessName": "My Business Name",35 "businessConfig": "fitness",36 "logo": "663051_3dd76ef233f245419432ffba703a4370~mv2.jpg",37 "description": "This is a site for my business",38 "businessSchedule": {39 "periods": [40 {41 "openDay": "MONDAY",42 "openTime": "10:20",43 "closeDay": "MONDAY",44 "closeTime": "23:00"45 },46 {47 "openDay": "TUESDAY",48 "openTime": "10:20",49 "closeDay": "TUESDAY",50 "closeTime": "23:00"51 },52 {53 "openDay": "WEDNESDAY",54 "openTime": "10:20",55 "closeDay": "WEDNESDAY",56 "closeTime": "23:00"57 },58 {59 "openDay": "THURSDAY",60 "openTime": "10:20",61 "closeDay": "THURSDAY",62 "closeTime": "23:00"63 },64 {65 "openDay": "FRIDAY",66 "openTime": "10:20",67 "closeDay": "FRIDAY",68 "closeTime": "23:00"69 },70 {71 "openDay": "SATURDAY",72 "openTime": "10:20",73 "closeDay": "SATURDAY",74 "closeTime": "23:00"75 }76 ],77 "specialHourPeriod": []78 },79 "multilingual": {80 "supportedLanguages": [ {81 "languageCode": "ko",82 "locale": {83 "languageCode": "ko",84 "country": "KR"85 },86 "isPrimary": true,87 "countryCode": "ISR",88 "resolutionMethod": "SUBDOMAIN"89 }],90 "autoRedirect": false91 },92 "consentPolicy": {93 "essential": false,94 "functional": true,95 "analytics": true,96 "advertising": true,97 "dataToThirdParty": false98 }99 }100}
Example with Fieldmask