SAP Customer Data Cloud Positions

accounts.getSchema REST

Skip to end of metadata
Go to start of metadata


This method retrieves the schema of the Profile object and the Data object (the site specific custom data object) in Gigya's Accounts Storage. The schema defines a set of properties for static data fields. The properties act as meta-data, guiding Gigya how to handle the data in the specified fields.


Note: This method is part of the Customer Identity and the Profile Management - IDS packages. Both packages are premium platforms that require separate activation. If neither are part of your site package, please contact your Gigya Customer Engagement Executive or contact us by filling in a support form on our site. You can also access the support page by clicking "Support" on the upper menu of Gigya's site.


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.


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).
includestringA comma separated string defining which schema(s) you would like to retrieve in the response; possible values are: "profileSchema, dataSchema, subscriptionsSchema, preferencesSchema".
scopestringWhen calling this method on a member of a site group, this parameter determines the schema that is returned. You may specify one of the following:
  • effective (default) - Returns a merged schema object for the group and site specific schemas, if they differ, including any site-specific overrides in effect.
  • group - Returns the schema that is set for the entire group.
  • site - Returns the schema that is set for the site.
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.
ignoreInterruptions Boolean This may be used in some cases to suppress logic applied by the Web SDK, such as automatic opening of screens (e.g., in a registration completion scenario). This parameter may not be used with REST APIs.
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.
includeDynamicSchemaBoolean Deprecated When it is explicitly set to false it should be interpreted as schemaType=explicit.

Unable to render {include} The included page could not be found.


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

apiVersion integer Defines the API version that returned the response and may not always be returned.
callId string Unique identifier of the transaction, for debugging purposes.
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.
errorDetails string This field will appear in the response only in case of an error and will contain the exception info, if available.
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.
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.
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.


profileSchemaJSON objectA JSON object defining the schema of the Profile object. See the format definition of the schema object
dataSchemaJSON objectA JSON object defining the schema of the Data object (the site specific custom data object). See the format definition of the schema object.
subscriptionsSchemaJSON objectA JSON object defining the schema of the Subscriptions object. See the format definition of the schema object.
JSON objectA JSON object defining the schema of the Preferences object. See the format definition of the schema object.

Response Example

  "profileSchema": {
  "dataSchema": {},
  "preferencesSchema": {
      "fields": {},
      "dynamicSchema": false
  "statusCode": 200,
  "errorCode": 0,
  "apiVersion": 2,
  "statusReason": "OK",
  "callId": "323beb60290b430c8834a2c699d90ca7",
  "time": "2015-03-22T11:42:25.943Z"