GET

List Site Schemas


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of all translation schemas associated with a site, regardless of which app created them.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Wix Multilingual - Translation Content + Published Content Read
Wix Multilingual - Write Translation Content
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/translation-schema/v1/schemas/site

Query Params
paging.limitintegerminimum 0maximum 100format int32

Maximum number of items to return in the results.


paging.cursorstringmaxLength 16000

Pointer to the next or previous page in the list of results.

Pass the relevant cursor token from the pagingMetadata object in the previous call's response. Not relevant for the first request.


appIdstring

ID of app that created the schema.


entityTypestring

A unique name defined by the app developer to differentiate translation schemas for various entities within their app. For example, if an app developer is creating a translation schema for blog posts, the entityType can be 'blog-posts'.


scopestring

Scope of the translation schema. Supported values:

  • GLOBAL: A global schema for all sites.
  • SITE: A custom schema for a specific site.
Response Object
schemasArray <Schema>

List of translation schemas.


pagingMetadataPagingMetadata

Paging metadata for the next page of results.

List Site Schemas

List all schemas installed on a site, including both SITE and GLOBAL scopes.

Request
cURL
Response
JSON
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?