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

Endpoint URL

The xxxx.backendless.app is a subdomain assigned to your application. For more information see the Client-side Setup section of this documentation.

https://xxxx.backendless.app/api/users/userclassprops

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

Important

Make sure to replace xxxx in the domain name in the sample request below to the one assigned to your application.

curl -X GET https://xxxx.backendless.app/api/users/userclassprops