GET

List Data Extension 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 global and user-defined data extension schemas for a given FQDN.

Permissions
Manage Bookings Services and Settings
Manage Data Extensions Schemas
Manage Portfolio
Read Data Extensions Schemas
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/schema-service/v1/schemas

Query Params
fqdnstringRequired

namespacesArray <string>

Namespaces within the given entity.


fieldsArray <string>

Additional fields that are hidden by default. For example, fields with "x-wix-archived": true.


extensionPointsArray <string>

Extension points within the given entity.

Response Object
dataExtensionSchemasArray <DataExtensionSchema>

Requested schemas.

List Data Extension Schemas Example 1
Request
cURL
curl -X GET \ 'https://www.wixapis.com/schema-service/v1/schemas?fqdn=wix.ecom.%2A.order' \ -H 'Content-type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "dataExtensionSchemas": [ { "id": "01ea0c8d-80b8-46e3-bfda-611b3678545b", "fqdn": "wix.ecom.*.order", "namespace": "_user_fields", "jsonSchema": { "properties": { "myCustomField1": { "type": "string", "maxLength": 50, "x-wix-permissions": { "read": ["users-of-users", "users", "apps"], "write": ["users"] }, "x-wix-created-date": "2024-10-08T12:13:38.592731806Z" } }, "additionalProperties": false }, "updatedDate": "2024-10-08T12:13:38.639Z", "createdDate": "2024-10-08T12:13:38.639Z", "revision": "1", "maxLimitBytes": 10000, "currentSizeBytes": 50, "extensionPoint": "ROOT" } ] }
Errors

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

Did this help?