Gigya Job Openings

ds.getSchema REST

Skip to end of metadata
Go to start of metadata


This method retrieves the schema of a specified data type in Gigya's Data Store (DS). 

Note: For security reasons this method is not available for client-side SDKs, only for server-side SDKs.

Note: If you plan on integrating the DS, we highly recommend reading the Data Store Guide.
The DS is a premium platform that requires separate activation. If the DS is not part of your site package please contact your Gigya Customer Engagement Executive or email


Request URL

Where <Data_Center> is:
  • - For the US data center.
  • - For the European data center.
  • - For the Australian data center.
  • - For the Russian data center.
  • - For the Chinese data center.

If you are not sure of your site's data center, see Finding Your Data Center.



typestring A string indicating the type of the object, equivalent to a schema name. To see all the types currently defined in the schema, use ds.getTypes or the Schema Editor.
filterstringSpecifies what parts of the schema to return, can be one of the following options: 
  • full - (default) return the complete schema including implicit fields and dynamic fields.
  • explicitOnly - return only the parts of the schema that were explicitly set by the partner using a setSchema call.
  • clientOnly - return only the fields in the schema that allow client access. For those fields return only the type and format and required properties (see the format definition of the schema object).
format string Determines the format of the response. The options are:
  • json (default)
  • jsonp - if the format is jsonp then you are required to define a callback method (see parameter below).
callback string This parameter is required only when the format parameter is set to jsonp (see above). In such cases this parameter should define the name of the callback method to be called in the response, along with the jsonp response data.
context string/JSON This parameter may be used to pass data through the current method and return it, unchanged, within the response.
dontHandleScreenSet Boolean This parameter may be used in order to suppress the showing of screen-sets as a result of API calls. Default is false.
httpStatusCodes Boolean The default value of this parameter is false, which means that the HTTP status code in Gigya's response is always 200 (OK), even if an error occurs. The error code and message is given within the response data (see below). If this parameter is set to true, the HTTP status code in Gigya's response would reflect an error, if one occurred.
 includeDynamicSchemaBooleanDeprecatedWhen it is explicitly set to false it should be interpreted as schemaType=explicit.

Authorization Parameters

Each REST API request must contain identification and authorization parameters.

Some REST APIs may function without these authorization parameters, however, when that occurs, these calls are treated as client-side calls and all client-side rate limits will apply. In order to not reach client-side IP rate limits that may impact your implementation when using server-to-server REST calls, it is Recommended Best Practice to always sign the request or use a secret. A non-exhaustive list of REST APIs that this may apply to are as follows:

  • accounts.login
  • socialize.login
  • accounts.notifyLogin
  • socialize.notifyLogin
  • accounts.finalizeRegistration
  • accounts.linkAccounts

Please refer to the Authorization Parameters section for details. 

Sample Requests


Response Data

errorCode integer The result code of the operation. Code '0' indicates success, any other number indicates failure. For a complete list of error codes, see the Error Codes table.
errorMessage string A short textual description of an error, associated with the errorCode, for logging purposes. This field will appear in the response only in case of an error.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
fullEventName string The full name of the event that triggered the response. This is an internally used parameter that is not always returned and should not be relied upon by your implementation.
callId string Unique identifier of the transaction, for debugging purposes.
time string The time of the response represented in ISO 8601 format, i.e., yyyy-mm-dd-Thh:MM:ss.SSSZ or
statusCode integer The HTTP response code of the operation. Code '200' indicates success.
This property is deprecated and only returned for backward compatibility.
statusReason string A brief explanation of the status code.
This property is deprecated and only returned for backward compatibility.


schemaJSON objectA JSON object that details the schema structure. See the format definition of the schema object


Response Example

        "schema": {
            "unique": [["customField1"], ["customField2", "customField3"]],
            "fields": {
                "customField1": {
                    "type": "integer"
                "customField2": {
                    "type": "string"
                "customField3": {
                    "type": "string"
            "dynamicSchema": false
        "statusCode": 200,
        "errorCode": 0,
        "statusReason": "OK",
        "callId": "0d8382a314ac4329a53add3067e863d9",
        "time": "2015-03-22T11:42:25.943Z"