Skip to content

Retrieve User Schema

An application can get a list of the properties associated with the user schema by using the following API:

Method

GET

URL

https://api.backendless.com/application-id/REST-api-key/users/userclassprops

where:

Argument                Description
application-id the ID of your application generated upon its creation. You can obtain the value in the Manage > App Settings section of the Backendless Console.
REST-api-key REST API key of your application. You can obtain the value in the Manage > App Settings section of the Backendless Console.

Request Body

None

Response Body

[  
  {  
    "name":"emailaddress",   
    "required":true|false,   
    "type":"STRING"|"STRING_ID"|"DATETIME"|"RELATION"|"INT"|"DOUBLE",  
    "relatedTable":tableName,  
    "identity":true|false   
  },  
  {  
    "name":"password",   
    "required":true|false,   
    "type":"STRING"|"STRING_ID"|"DATETIME"|"RELATION"|"INT"|"DOUBLE",  
    "relatedTable":tableName,  
    "identity":true|false   
  }  
]

where:

  • "name" - name of the property/column in the Users table.
  • "required" -  indicates whether the property is required for user registration.
  • "type" - property data type.
  • "defaultValue" - default value of the property. The value is used if it is not provided during the registration API call.
  • "identity" - indicates whether the property is marked as user identity
  • "relatedTable" - if type is "RELATION", contains the name of the related table

Example

curl -X GET https://api.backendless.com/application-id/rest-api-key/users/userclassprops