Search.../
  1. Home
  2. Getting Started
  3. Overview
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 Read Business Info 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 with Fieldmask

Request

curl

Copy Code
1curl -X GET \
2 'https://www.wixapis.com/site-properties/v4/properties?fields.paths=locale&fields.paths=businessName'
3 -H 'Authorization: <AUTH>'

Response

json

1
2{
3 "version": "207",
4 "properties": {
5 "locale": {
6 "languageCode": "en",
7 "country": "US"
8 },
9 "businessName": "My Business Name"
10 }
11}
Example 2