GET

Get Schema By Key


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 translation schema by key.

Authentication

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

Permissions
Wix Multilingual - Translation Schema Read
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/translation-schema/v1/schemas/app-id/{key.appId}/entity-type/{key.entityType}/scope/{key.scope}

Path Params
key.appIdstringRequired

ID of the app that created the schema.


key.entityTypestringRequired

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'.


key.scopestringRequired

Scope of the translation schema. Supported values:

  • GLOBAL: A global schema for all sites.
  • SITE: A custom schema for a specific site.
Query Params
key.entityTypestringminLength 1maxLength 80

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'.


key.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
schemaSchema

The requested translation schema.

Get Schema By Key
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?